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

Материал из Документация Ключ-АСТРОМ
 
Строка 11: Строка 11:
|GET
|GET
|
|
* SaaS <nowiki>https://{идентификатор_вашей_среды}.live.dynatrace.com/api/v2/logs/aggregate</nowiki>
* SaaS <nowiki>https://{идентификатор_вашей_среды}.live.ruscomtech.ru.com/api/v2/logs/aggregate</nowiki>
* Окружающая среда АктивногоШлюза <nowiki>https://{ваш-активный-домен}/e/{идентификатор-вашей-среды}/api/v2/logs/aggregate</nowiki>
* Окружающая среда АктивногоШлюза <nowiki>https://{ваш-активный-домен}/e/{идентификатор-вашей-среды}/api/v2/logs/aggregate</nowiki>
|}
|}
Строка 130: Строка 130:
=== Объекты тела ответа ===
=== Объекты тела ответа ===


==== Объект _ <code>AggregatedLog</code> ====
==== Объект <code>AggregatedLog</code> ====
Совокупные записи лога.
Совокупные записи лога.
{| class="wikitable"
{| class="wikitable"

Текущая версия на 11:52, 7 октября 2022

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

Возвращает агрегированное количество вхождений значений лога, разделенных на временные интервалы.

Возможно, что временные рамки, охватываемые результатами, превышают указанные временные рамки. В таких случаях запрос возвращает меньше временных интервалов, чем указано в параметре запроса timeBuckets .

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

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

GET
  • SaaS https://{идентификатор_вашей_среды}.live.ruscomtech.ru.com/api/v2/logs/aggregate
  • Окружающая среда АктивногоШлюза https://{ваш-активный-домен}/e/{идентификатор-вашей-среды}/api/v2/logs/aggregate

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

Чтобы выполнить этот запрос, вам необходимо разрешение на чтение логов ( 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: годы

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

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

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

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

запрос по желанию
timeBuckets integer Количество временных интервалов в результате.

Временной интервал запроса делится поровну на указанное количество слотов.

Минимальная длина слота составляет 1 мс.

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

запрос по желанию
maxGroupValues integer Максимальное количество значений в каждой группе.

Вы можете получить до 100 значений на группу.

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

запрос по желанию
groupBy string [] Группы, которые должны быть включены в ответ.

Вы можете указать несколько групп в следующем формате: groupBy=status&groupBy=log.source.

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

Уникальные атрибуты данных журнала (атрибуты высокой мощности), например, span_idили trace_idне могут использоваться для группировки.

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

Ответ

Коды ответов

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

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

Объект AggregatedLog

Совокупные записи лога.

Элемент Тип Описание
aggregationResult object Совокупные записи лога.

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

{
  "aggregationResult": {
    "processId": {
      "1597835271": {
        "cassandra": "6"
      },
      "1597835331": {
        "apache": "12",
        "cassandra": "60"
      }
    },
    "hostId": {
      "1597835271": {
        "localhost": "12"
      },
      "1597835331": {
        "remotehost": "6"
      }
    },
    "logLevel": {
      "1597835271": {
        "ERROR": "1",
        "INFO": "2"
      },
      "1597835331": {
        "INFO": "17"
      }
    },
    "logPath": {
      "1597835271": {
        "/var/log/messages": "15",
        "/var/log/syslog": "3"
      },
      "1597835331": {
        "/var/log/messages": "15",
        "/var/log/syslog": "3"
      }
    }
  }
}