Получение лога поиска: различия между версиями

Материал из Документация Ключ-АСТРОМ
(Новая страница: «Получает записи журнала, соответствующие указанным критериям. Совпадающие записи журна...»)
 
Строка 1: Строка 1:
Получает записи журнала, соответствующие указанным критериям. Совпадающие записи журнала сортируются по критериям, указанным в параметре запроса sort , а затем возвращаются первые ''X'' записей (как указано в параметре запроса limit ). Чтобы выполнить запрос без ограничения размера, используйте запрос GET на экспорт журналов .
Получает записи лога, соответствующие указанным критериям. Совпадающие записи лога сортируются по критериям, указанным в параметре запроса sort , а затем возвращаются первые ''X'' записей (как указано в параметре запроса limit ). Чтобы выполнить запрос без ограничения размера, используйте запрос GET на экспорт журналов .


Если полученный журнал слишком велик, он делится на слайсы. В таких случаях первый ответ содержит nextSliceKey для второго слайса. Используйте его в параметре запроса nextSliceKey для получения второго слайса, который, в свою очередь, содержит nextSliceKey для третьего слайса и так далее.
Если полученный журнал слишком велик, он делится на слайсы. В таких случаях первый ответ содержит nextSliceKey для второго слайса. Используйте его в параметре запроса nextSliceKey для получения второго слайса, который, в свою очередь, содержит nextSliceKey для третьего слайса и так далее.
Строка 6: Строка 6:


Запрос создает <code>application/json</code>полезную нагрузку.
Запрос создает <code>application/json</code>полезную нагрузку.
Этот запрос является выпуском Early Adopter и может быть изменен несовместимым образом.
{| class="wikitable"
{| class="wikitable"
|ПОЛУЧИТЬ
|GET
|
|
* SaaShttps://{идентификатор_вашей_среды}.live.dynatrace.com/api/v2/logs/search
* SaaShttps://{идентификатор_вашей_среды}.live.dynatrace.com/api/v2/logs/search
Строка 16: Строка 14:


== Аутентификация ==
== Аутентификация ==
Чтобы выполнить этот запрос, вам необходимо разрешение на чтение журналов ( <code>logs.read</code>), назначенное вашему токену API. Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Чтобы выполнить этот запрос, вам необходимо разрешение на '''Чтение логов'''( <code>logs.read</code>), назначенное вашему токену API. Чтобы узнать, как его получить и использовать, см. раздел [[Токены и аутентификация (API)|Токены и аутентификация]] .


== Параметры ==
== Параметры ==
Строка 23: Строка 21:
!Тип
!Тип
!Описание
!Описание
!В
!In
!Необходимый
!Необходимость
|-
|-
|из
|from
|нить
|string
|Начало запрошенного таймфрейма.
|Начало запрошенного таймфрейма.


Строка 46: Строка 44:
|по желанию
|по желанию
|-
|-
|к
|to
|нить
|string
|Конец запрошенного периода времени.
|Конец запрошенного периода времени.


Строка 66: Строка 64:
|по желанию
|по желанию
|-
|-
|ограничение
|limit
|целое число
|integer
|Желаемое количество записей журнала.
|Желаемое количество записей журнала.


Строка 76: Строка 74:
|по желанию
|по желанию
|-
|-
|запрос
|query
|нить
|string
|Поисковый запрос журнала.
|Поисковый запрос журнала.


Запрос должен использовать язык поисковых запросов 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>) в простых выражениях).
Строка 86: Строка 84:
|по желанию
|по желанию
|-
|-
|Сортировать
|sort
|нить
|string
|Определяет порядок записей журнала.
|Определяет порядок записей журнала.


Строка 98: Строка 96:
|по желанию
|по желанию
|-
|-
|следующийSliceKey
|nextSliceKey
|нить
|string
|Курсор для следующего фрагмента результатов. Вы можете найти его в поле nextSliceKey предыдущего ответа.
|Курсор для следующего фрагмента результатов. Вы можете найти его в поле nextSliceKey предыдущего ответа.


Строка 135: Строка 133:
!Описание
!Описание
|-
|-
|полученные результаты
|results
|Запись журнала []
|LogRecord[]
|Список извлеченных записей журнала.
|Список извлеченных записей журнала.
|-
|-
|следующийSliceKey
|nextSliceKey
|нить
|string
|Курсор для следующего фрагмента записей журнала.
|Курсор для следующего фрагмента записей журнала.
|-
|-
|размер слайса
|sliceSize
|целое число
|integer
|Общее количество записей в срезе.
|Общее количество записей в срезе.
|}
|}
Строка 155: Строка 153:
!Описание
!Описание
|-
|-
|дополнительные столбцы
|additionalColumns
|объект
|object
|Дополнительные столбцы записи журнала.
|Дополнительные столбцы записи журнала.
|-
|-
|содержание
|content
|нить
|string
|Содержимое записи журнала.
|Содержимое записи журнала.
|-
|-
|отметка времени
|timestamp
|целое число
|integer
|Временная метка записи журнала в миллисекундах UTC.
|Временная метка записи журнала в миллисекундах UTC.
|-
|-
|тип события
|eventType
|нить
|string
|Тип события
|Тип события


Элемент может содержать эти значения
Элемент может содержать эти значения
|-
|-
|статус
|status
|нить
|string
|Состояние журнала (на основе уровня журнала).
|Состояние журнала (на основе уровня журнала).



Версия 07:12, 5 октября 2022

Получает записи лога, соответствующие указанным критериям. Совпадающие записи лога сортируются по критериям, указанным в параметре запроса sort , а затем возвращаются первые X записей (как указано в параметре запроса limit ). Чтобы выполнить запрос без ограничения размера, используйте запрос GET на экспорт журналов .

Если полученный журнал слишком велик, он делится на слайсы. В таких случаях первый ответ содержит nextSliceKey для второго слайса. Используйте его в параметре запроса nextSliceKey для получения второго слайса, который, в свою очередь, содержит nextSliceKey для третьего слайса и так далее.

Результаты могут быть неравномерно распределены между срезами, а некоторые срезы могут быть пустыми.

Запрос создает application/jsonполезную нагрузку.

GET
  • SaaShttps://{идентификатор_вашей_среды}.live.dynatrace.com/api/v2/logs/search
  • Окружающая среда ActiveGatehttps://{ваш-активный-домен}/e/{идентификатор-вашей-среды}/api/v2/logs/search

Аутентификация

Чтобы выполнить этот запрос, вам необходимо разрешение на Чтение логов( logs.read), назначенное вашему токену API. Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .

Параметры

Параметр Тип Описание In Необходимость
from string Начало запрошенного таймфрейма.

Вы можете использовать один из следующих форматов:

  • Отметка времени в миллисекундах UTC.
  • Человекочитаемый формат 2021-01-25T05:57:01.123+01:00. Если часовой пояс не указан, используется UTC. Вы можете использовать пробел вместо T. Секунды и доли секунды не являются обязательными.
  • Относительный таймфрейм, назад. Формат: now-NU/A, где Nколичество времени, Uединица времени и Aвыравнивание. Выравнивание округляет все меньшие значения до ближайшего нуля в прошлом. Например, now-1y/wэто один год назад, выровненный на неделю. Вы также можете указать относительный таймфрейм без выравнивания: now-NU. Поддерживаемые единицы времени для относительного таймфрейма:
    • m: минут
    • h: часы
    • d: дней
    • w: недели
    • M: месяцы
    • y: годы

Если не задано, используется относительный двухнедельный таймфрейм ( now-2w).

запрос по желанию
to string Конец запрошенного периода времени.

Вы можете использовать один из следующих форматов:

  • Отметка времени в миллисекундах UTC.
  • Человекочитаемый формат 2021-01-25T05:57:01.123+01:00. Если часовой пояс не указан, используется UTC. Вы можете использовать пробел вместо T. Секунды и доли секунды не являются обязательными.
  • Относительный таймфрейм, назад. Формат: now-NU/A, где Nколичество времени, Uединица времени и Aвыравнивание. Выравнивание округляет все меньшие значения до ближайшего нуля в прошлом. Например, now-1y/wэто один год назад, выровненный на неделю. Вы также можете указать относительный таймфрейм без выравнивания: now-NU. Поддерживаемые единицы времени для относительного таймфрейма:
    • m: минут
    • h: часы
    • d: дней
    • w: недели
    • M: месяцы
    • y: годы

Если не установлено, используется текущая метка времени.

запрос по желанию
limit integer Желаемое количество записей журнала.

Максимально допустимый лимит составляет 1000.

Если не установлено, используется 1000.

запрос по желанию
query string Поисковый запрос журнала.

Запрос должен использовать язык поисковых запросов Ключ-АСТРОМ .

Запрос имеет ограничение в 20 отношений (логические операторы между простыми выражениями ( AND, OR) или операторы сравнения ( =, !=, <, <=, >, >=) в простых выражениях).

запрос по желанию
sort string Определяет порядок записей журнала.

Каждое поле имеет префикс знака (+/-) для порядка сортировки. Если префикс знака не установлен, +будет применена опция.

В настоящее время упорядочивание доступно только для временной метки (+timestamp для самых старых записей первыми или -timestamp для самых новых записей).

Если разрешения в миллисекундах, предоставляемого отметкой времени, недостаточно, записи журнала сортируются в соответствии с порядком, в котором они появляются в источнике журнала (удаленный процесс, записывающий в конечную точку REST API, или удаленный процесс, из которого собираются журналы).

запрос по желанию
nextSliceKey string Курсор для следующего фрагмента результатов. Вы можете найти его в поле nextSliceKey предыдущего ответа.

Первый срез всегда возвращается, если вы не укажете этот параметр.

Если этот параметр установлен, все остальные параметры запроса игнорируются.

запрос по желанию

Ответ

Коды ответов

Код Тип Описание
200 Список записей журнала Успех
400 ErrorEnvelope Не удалось. Ввод недействителен.

Объекты тела ответа

Объект _ LogRecordsList

Список извлеченных записей журнала.

Элемент Тип Описание
results LogRecord[] Список извлеченных записей журнала.
nextSliceKey string Курсор для следующего фрагмента записей журнала.
sliceSize integer Общее количество записей в срезе.

Объект _ LogRecord

Единая запись журнала.

Элемент Тип Описание
additionalColumns object Дополнительные столбцы записи журнала.
content string Содержимое записи журнала.
timestamp integer Временная метка записи журнала в миллисекундах UTC.
eventType string Тип события

Элемент может содержать эти значения

status string Состояние журнала (на основе уровня журнала).

Элемент может содержать эти значения

  • ERROR
  • INFO
  • NONE
  • WARN

JSON-модель тела ответа

{
  "results": [
    {
      "timestamp": "1631193089000",
      "status": "ERROR",
      "content": "example log content",
      "event.type": "LOG",
      "additionalColumns": {
        "custom.attribute": [
          "value1",
          "value2"
        ],
        "loglevel": [
          "SEVERE"
        ]
      }
    }
  ],
  "sliceSize": 100,
  "nextSliceKey": "___-2hI03q0AAAAAAAAAAAAAA-gAAAAAAAAH0P____8AAABkAAAACXRpbWVzdGFtcAD___7aEjTerQ"
}