Получение лога экспорта: различия между версиями
ENetrebin (обсуждение | вклад) (Новая страница: «Получает записи журнала, соответствующие указанным критериям. Совпадающие записи журна...») |
ENetrebin (обсуждение | вклад) |
||
Строка 1: | Строка 1: | ||
Получает записи | Получает записи лога, соответствующие указанным критериям. Совпадающие записи лога сортируются по критериям, указанным в параметре запроса сортировки . | ||
В отличие от запроса | В отличие от запроса логов поиска GET , этот запрос не накладывает ограничения на общее количество результирующих записей лога. Однако, если результирующий лог слишком велик, применяется разбиение на страницы. Вы можете установить размер страницы в параметре запроса pageSize . В таких случаях первый ответ содержит nextPageKey для второй страницы. Используйте его в параметре запроса nextPageKey , чтобы получить вторую страницу, которая, в свою очередь, содержит nextPageKey для третьей страницы и так далее. | ||
Запрос создает <code>application/json</code>полезную нагрузку. | Запрос создает <code>application/json</code>полезную нагрузку. | ||
{| class="wikitable" | {| class="wikitable" | ||
| | |GET | ||
| | | | ||
* SaaShttps://{идентификатор_вашей_среды}.live.dynatrace.com/api/v2/logs/export | * SaaShttps://{идентификатор_вашей_среды}.live.dynatrace.com/api/v2/logs/export | ||
Строка 14: | Строка 12: | ||
== Аутентификация == | == Аутентификация == | ||
Чтобы выполнить этот запрос, вам необходимо разрешение на чтение | Чтобы выполнить этот запрос, вам необходимо разрешение на '''чтение логов''' ( <code>logs.read</code>), назначенное вашему токену API. Чтобы узнать, как его получить и использовать, см. раздел [[Токены и аутентификация (API)|Токены и аутентификация]] . | ||
== Параметры == | == Параметры == | ||
Строка 21: | Строка 19: | ||
!Тип | !Тип | ||
!Описание | !Описание | ||
! | !In | ||
! | !Необходимость | ||
|- | |- | ||
| | |from | ||
| | |string | ||
|Начало запрошенного таймфрейма. | |Начало запрошенного таймфрейма. | ||
Строка 33: | Строка 31: | ||
* Человекочитаемый формат <code>2021-01-25T05:57:01.123+01:00</code>. Если часовой пояс не указан, используется UTC. Вы можете использовать пробел вместо <code>T</code>. Секунды и доли секунды не являются обязательными. | * Человекочитаемый формат <code>2021-01-25T05:57:01.123+01:00</code>. Если часовой пояс не указан, используется UTC. Вы можете использовать пробел вместо <code>T</code>. Секунды и доли секунды не являются обязательными. | ||
* Относительный таймфрейм, назад. Формат: <code>now-NU/A</code>, где <code>N</code>количество времени, <code>U</code>единица времени и <code>A</code>выравнивание. Выравнивание округляет все меньшие значения до ближайшего нуля в прошлом. Например, <code>now-1y/w</code>это один год назад, выровненный на неделю. Вы также можете указать относительный таймфрейм без выравнивания: <code>now-NU</code>. Поддерживаемые единицы времени для относительного таймфрейма: | * Относительный таймфрейм, назад. Формат: <code>now-NU/A</code>, где <code>N</code>количество времени, <code>U</code>единица времени и <code>A</code>выравнивание. Выравнивание округляет все меньшие значения до ближайшего нуля в прошлом. Например, <code>now-1y/w</code>это один год назад, выровненный на неделю. Вы также можете указать относительный таймфрейм без выравнивания: <code>now-NU</code>. Поддерживаемые единицы времени для относительного таймфрейма: | ||
** <code>m</code>: | ** <code>m</code>: минуты | ||
** <code>h</code>: часы | ** <code>h</code>: часы | ||
** <code>d</code>: | ** <code>d</code>: дни | ||
** <code>w</code>: недели | ** <code>w</code>: недели | ||
** <code>M</code>: месяцы | ** <code>M</code>: месяцы | ||
Строка 44: | Строка 42: | ||
|по желанию | |по желанию | ||
|- | |- | ||
| | |to | ||
| | |string | ||
|Конец запрошенного периода времени. | |Конец запрошенного периода времени. | ||
Строка 64: | Строка 62: | ||
|по желанию | |по желанию | ||
|- | |- | ||
| | |nextPageKey | ||
| | |string | ||
|Курсор для следующей страницы результатов. Вы можете найти его в поле nextPageKey предыдущего ответа. | |Курсор для следующей страницы результатов. Вы можете найти его в поле nextPageKey предыдущего ответа. | ||
Строка 74: | Строка 72: | ||
|по желанию | |по желанию | ||
|- | |- | ||
| | |pageSize | ||
| | |integer | ||
|Количество результатов на странице результатов. | |Количество результатов на странице результатов. | ||
|запрос | |запрос | ||
|по желанию | |по желанию | ||
|- | |- | ||
| | |query | ||
| | |string | ||
|Поисковый запрос | |Поисковый запрос лога. | ||
Запрос должен использовать язык поисковых запросов | Запрос должен использовать язык поисковых запросов Ключ-АСТРОМ . | ||
Запрос имеет ограничение в 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>) в простых выражениях). | ||
Строка 90: | Строка 88: | ||
|по желанию | |по желанию | ||
|- | |- | ||
| | |sort | ||
| | |string | ||
|Определяет порядок записей | |Определяет порядок записей лога. | ||
Каждое поле имеет префикс знака (+/-) для порядка сортировки. Если префикс знака не установлен, <code>+</code>будет применена опция. | Каждое поле имеет префикс знака (+/-) для порядка сортировки. Если префикс знака не установлен, <code>+</code>будет применена опция. | ||
Строка 98: | Строка 96: | ||
В настоящее время упорядочивание доступно только для временной метки (+timestamp для самых старых записей первыми или -timestamp для самых новых записей). | В настоящее время упорядочивание доступно только для временной метки (+timestamp для самых старых записей первыми или -timestamp для самых новых записей). | ||
Если разрешения в миллисекундах, предоставляемого отметкой времени, недостаточно, записи журнала сортируются в соответствии с порядком, в котором они появляются в источнике журнала (удаленный процесс, записывающий в конечную точку REST API, или удаленный процесс, из которого собираются | Если разрешения в миллисекундах, предоставляемого отметкой времени, недостаточно, записи журнала сортируются в соответствии с порядком, в котором они появляются в источнике журнала (удаленный процесс, записывающий в конечную точку REST API, или удаленный процесс, из которого собираются логи). | ||
|запрос | |запрос | ||
|по желанию | |по желанию | ||
Строка 112: | Строка 110: | ||
|- | |- | ||
|200 | |200 | ||
| | |ExportedLogRecordList | ||
|Успех | |Успех | ||
|- | |- | ||
Строка 133: | Строка 131: | ||
!Описание | !Описание | ||
|- | |- | ||
| | |пresults | ||
| | |LogRecord[] | ||
|Список извлеченных записей | |Список извлеченных записей лога. | ||
|- | |- | ||
| | |pageSize | ||
| | |integer | ||
|Количество записей на странице. | |Количество записей на странице. | ||
|- | |- | ||
| | |totalCount | ||
| | |integer | ||
|Общее количество записей в результате. | |Общее количество записей в результате. | ||
|- | |- | ||
| | |nextPageKey | ||
| | |string | ||
|Курсор для следующей страницы результатов. Имеет значение <code>null</code>на последней странице. | |Курсор для следующей страницы результатов. Имеет значение <code>null</code>на последней странице. | ||
Строка 153: | Строка 151: | ||
==== Объект _ <code>LogRecord</code> ==== | ==== Объект _ <code>LogRecord</code> ==== | ||
Единая запись | Единая запись лога. | ||
{| class="wikitable" | {| class="wikitable" | ||
!Элемент | !Элемент | ||
Строка 159: | Строка 157: | ||
!Описание | !Описание | ||
|- | |- | ||
| | |additionalColumns | ||
|объект | |объект | ||
|Дополнительные столбцы записи | |Дополнительные столбцы записи лога. | ||
|- | |- | ||
| | |content | ||
| | |string | ||
|Содержимое записи | |Содержимое записи лога. | ||
|- | |- | ||
| | |timestamp | ||
|целое число | |целое число | ||
|Временная метка записи | |Временная метка записи лога в миллисекундах UTC. | ||
|- | |- | ||
| | |eventType | ||
| | |string | ||
|Тип события | |Тип события | ||
Строка 181: | Строка 179: | ||
* <code>SFM</code> | * <code>SFM</code> | ||
|- | |- | ||
| | |status | ||
| | |string | ||
|Состояние | |Состояние лога (на основе уровня лога). | ||
Элемент может содержать эти значения | Элемент может содержать эти значения |
Версия 14:22, 5 октября 2022
Получает записи лога, соответствующие указанным критериям. Совпадающие записи лога сортируются по критериям, указанным в параметре запроса сортировки .
В отличие от запроса логов поиска 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 | Поисковый запрос лога.
Запрос должен использовать язык поисковых запросов Ключ-АСТРОМ . Запрос имеет ограничение в 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 | объект | Дополнительные столбцы записи лога. |
content | string | Содержимое записи лога. |
timestamp | целое число | Временная метка записи лога в миллисекундах UTC. |
eventType | string | Тип события
Элемент может содержать эти значения
|
status | 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
}