Получение лога экспорта: различия между версиями
ENetrebin (обсуждение | вклад) |
ENetrebin (обсуждение | вклад) |
||
(не показаны 2 промежуточные версии этого же участника) | |||
Строка 7: | Строка 7: | ||
|GET | |GET | ||
| | | | ||
* | * SaaS <nowiki>https://{идентификатор_вашей_среды}.live.dynatrace.com/api/v2/logs/export</nowiki> | ||
* Окружающая среда | * Окружающая среда АктивногоШлюза <nowiki>https://{ваш-активный-домен}/e/{идентификатор-вашей-среды}/api/v2/logs/export</nowiki> | ||
|} | |} | ||
Строка 82: | Строка 82: | ||
|Поисковый запрос лога. | |Поисковый запрос лога. | ||
Запрос должен использовать язык поисковых запросов | Запрос должен использовать язык поисковых запросов Dynatrace . | ||
Запрос имеет ограничение в 20 отношений (логические операторы между простыми выражениями ( <code>AND</code>, <code>OR</code>) или операторы сравнения ( <code>=</code>, <code>!=</code>, <code><</code>, <code><=</code>, <code>></code>, <code>>=</code>) в простых выражениях). | Запрос имеет ограничение в 20 отношений (логические операторы между простыми выражениями ( <code>AND</code>, <code>OR</code>) или операторы сравнения ( <code>=</code>, <code>!=</code>, <code><</code>, <code><=</code>, <code>></code>, <code>>=</code>) в простых выражениях). | ||
Строка 124: | Строка 124: | ||
=== Объекты тела ответа === | === Объекты тела ответа === | ||
==== Объект | ==== Объект <code>ExportedLogRecordList</code> ==== | ||
Список экспортированных записей журнала. | Список экспортированных записей журнала. | ||
{| class="wikitable" | {| class="wikitable" | ||
Строка 131: | Строка 131: | ||
!Описание | !Описание | ||
|- | |- | ||
| | |results | ||
|LogRecord[] | |LogRecord[] | ||
|Список извлеченных записей лога. | |Список извлеченных записей лога. | ||
Строка 150: | Строка 150: | ||
|} | |} | ||
==== Объект | ==== Объект <code>LogRecord</code> ==== | ||
Единая запись лога. | Единая запись лога. | ||
{| class="wikitable" | {| class="wikitable" | ||
Строка 158: | Строка 158: | ||
|- | |- | ||
|additionalColumns | |additionalColumns | ||
| | |object | ||
|Дополнительные столбцы записи лога. | |Дополнительные столбцы записи лога. | ||
|- | |- | ||
|eventType | |eventType | ||
Строка 173: | Строка 165: | ||
|Тип события | |Тип события | ||
Элемент может содержать | Элемент может содержать следующие значения | ||
* <code>K8S</code> | * <code>K8S</code> | ||
* <code>LOG</code> | * <code>LOG</code> | ||
* <code>SFM</code> | * <code>SFM</code> | ||
|- | |||
|timestamp | |||
|integer | |||
|Временная метка записи журнала в миллисекундах UTC. | |||
|- | |- | ||
|status | |status | ||
Строка 183: | Строка 179: | ||
|Состояние лога (на основе уровня лога). | |Состояние лога (на основе уровня лога). | ||
Элемент может содержать | Элемент может содержать следующие значения | ||
* <code>ERROR</code> | * <code>ERROR</code> | ||
Строка 189: | Строка 185: | ||
* <code>NONE</code> | * <code>NONE</code> | ||
* <code>WARN</code> | * <code>WARN</code> | ||
|- | |||
|content | |||
|string | |||
|Содержимое записи лога. | |||
|} | |} | ||
Текущая версия на 15:16, 27 января 2023
Получает записи лога, соответствующие указанным критериям. Совпадающие записи лога сортируются по критериям, указанным в параметре запроса сортировки .
В отличие от запроса логов поиска GET , этот запрос не накладывает ограничения на общее количество результирующих записей лога. Однако, если результирующий лог слишком велик, применяется разбиение на страницы. Вы можете установить размер страницы в параметре запроса pageSize . В таких случаях первый ответ содержит nextPageKey для второй страницы. Используйте его в параметре запроса nextPageKey , чтобы получить вторую страницу, которая, в свою очередь, содержит nextPageKey для третьей страницы и так далее.
Запрос создает application/json
полезную нагрузку.
GET |
|
Аутентификация
Чтобы выполнить этот запрос, вам необходимо разрешение на чтение логов ( logs.read
), назначенное вашему токену API. Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Параметры
Параметр | Тип | Описание | In | Необходимость |
---|---|---|---|---|
from | string | Начало запрошенного таймфрейма.
Вы можете использовать один из следующих форматов:
Если не задано, используется относительный двухнедельный таймфрейм ( |
запрос | по желанию |
to | string | Конец запрошенного периода времени.
Вы можете использовать один из следующих форматов:
Если не установлено, используется текущая метка времени. |
запрос | по желанию |
nextPageKey | string | Курсор для следующей страницы результатов. Вы можете найти его в поле nextPageKey предыдущего ответа.
Первая страница всегда возвращается, если вы не укажете параметр запроса nextPageKey . Когда nextPageKey настроен на получение последующих страниц, вы должны опустить все остальные параметры запроса. |
запрос | по желанию |
pageSize | integer | Количество результатов на странице результатов. | запрос | по желанию |
query | string | Поисковый запрос лога.
Запрос должен использовать язык поисковых запросов Dynatrace . Запрос имеет ограничение в 20 отношений (логические операторы между простыми выражениями ( |
запрос | по желанию |
sort | string | Определяет порядок записей лога.
Каждое поле имеет префикс знака (+/-) для порядка сортировки. Если префикс знака не установлен, В настоящее время упорядочивание доступно только для временной метки (+timestamp для самых старых записей первыми или -timestamp для самых новых записей). Если разрешения в миллисекундах, предоставляемого отметкой времени, недостаточно, записи журнала сортируются в соответствии с порядком, в котором они появляются в источнике журнала (удаленный процесс, записывающий в конечную точку REST API, или удаленный процесс, из которого собираются логи). |
запрос | по желанию |
Ответ
Коды ответов
Код | Тип | Описание |
---|---|---|
200 | ExportedLogRecordList | Успех |
400 | ErrorEnvelope | Не удалось. Ввод недействителен. |
501 | ErrorEnvelope | Не удалось. Сервер либо не распознает метод запроса, либо не может выполнить запрос. Может произойти, если включено хранилище журналов Grail. |
Объекты тела ответа
Объект ExportedLogRecordList
Список экспортированных записей журнала.
Элемент | Тип | Описание |
---|---|---|
results | LogRecord[] | Список извлеченных записей лога. |
pageSize | integer | Количество записей на странице. |
totalCount | integer | Общее количество записей в результате. |
nextPageKey | string | Курсор для следующей страницы результатов. Имеет значение null на последней странице.
Используйте его в параметре запроса nextPageKey для получения последующих страниц результата. |
Объект LogRecord
Единая запись лога.
Элемент | Тип | Описание |
---|---|---|
additionalColumns | object | Дополнительные столбцы записи лога. |
eventType | string | Тип события
Элемент может содержать следующие значения
|
timestamp | integer | Временная метка записи журнала в миллисекундах UTC. |
status | string | Состояние лога (на основе уровня лога).
Элемент может содержать следующие значения
|
content | string | Содержимое записи лога. |
JSON-модель тела ответа
{
"results": [
{
"timestamp": "1631193089000",
"status": "ERROR",
"content": "example log content",
"event.type": "LOG",
"additionalColumns": {
"custom.attribute": [
"value1",
"value2"
],
"loglevel": [
"SEVERE"
]
}
}
],
"pageSize": 100,
"nextPageKey": "___-2lZ43q0AAAAdeJxjYAAC1sLS1KJKBhjggtIijFCGHEwCAFiHAoP___7aVnjerQ",
"totalCount": 150
}