Получение лога экспорта

Материал из Документация Ключ-АСТРОМ
Версия от 19:26, 4 октября 2022; ENetrebin (обсуждение | вклад) (Новая страница: «Получает записи журнала, соответствующие указанным критериям. Совпадающие записи журна...»)
(разн.) ← Предыдущая | Текущая версия (разн.) | Следующая → (разн.)

Получает записи журнала, соответствующие указанным критериям. Совпадающие записи журнала сортируются по критериям, указанным в параметре запроса сортировки .

В отличие от запроса журналов поиска GET , этот запрос не накладывает ограничения на общее количество результирующих записей журнала. Однако, если результирующий журнал слишком велик, применяется разбиение на страницы. Вы можете установить размер страницы в параметре запроса pageSize . В таких случаях первый ответ содержит nextPageKey для второй страницы. Используйте его в параметре запроса nextPageKey , чтобы получить вторую страницу, которая, в свою очередь, содержит nextPageKey для третьей страницы и так далее.

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

Этот запрос является выпуском Early Adopter и может быть изменен несовместимым образом.

ПОЛУЧИТЬ
  • SaaShttps://{идентификатор_вашей_среды}.live.dynatrace.com/api/v2/logs/export
  • Окружающая среда ActiveGatehttps://{ваш-активный-домен}/e/{идентификатор-вашей-среды}/api/v2/logs/export

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

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

Параметры

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

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

  • Отметка времени в миллисекундах 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).

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

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

  • Отметка времени в миллисекундах 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: годы

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

запрос по желанию
ключ следующей страницы нить Курсор для следующей страницы результатов. Вы можете найти его в поле nextPageKey предыдущего ответа.

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

Когда nextPageKey настроен на получение последующих страниц, вы должны опустить все остальные параметры запроса.

запрос по желанию
размер страницы целое число Количество результатов на странице результатов. запрос по желанию
запрос нить Поисковый запрос журнала.

Запрос должен использовать язык поисковых запросов Dynatrace .

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

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

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

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

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

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

Ответ

Коды ответов

Код Тип Описание
200 Экспортированный список записей журнала Успех
400 ErrorEnvelope Не удалось. Ввод недействителен.
501 ErrorEnvelope Не удалось. Сервер либо не распознает метод запроса, либо не может выполнить запрос. Может произойти, если включено хранилище журналов Grail.

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

Объект _ ExportedLogRecordList

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

Элемент Тип Описание
полученные результаты Запись журнала [] Список извлеченных записей журнала.
размер страницы целое число Количество записей на странице.
общее количество целое число Общее количество записей в результате.
ключ следующей страницы нить Курсор для следующей страницы результатов. Имеет значение nullна последней странице.

Используйте его в параметре запроса nextPageKey для получения последующих страниц результата.

Объект _ LogRecord

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

Элемент Тип Описание
дополнительные столбцы объект Дополнительные столбцы записи журнала.
содержание нить Содержимое записи журнала.
отметка времени целое число Временная метка записи журнала в миллисекундах UTC.
тип события нить Тип события

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

  • K8S
  • LOG
  • SFM
статус нить Состояние журнала (на основе уровня журнала).

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

  • ERROR
  • INFO
  • NONE
  • WARN

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
}