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

Текущая версия от 11:33, 29 декабря 2024

API АппОптима / Эндпойнты среды / Развёртывание / Мониторинг логов / GET сводного лога

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

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

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

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

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

GET	Среда АктивногоШлюза 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"
      }
    }
  }
}

@@ Строка 1: / Строка 1: @@
-'''''[[API АппОптима]] / Эндпойнты среды / Развёртывание / Мониторинг логов / GET сводного лога'''''
+'''''[[API АппОптима]] / [[API АппОптима|Эндпойнты среды]] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=DELETE%20%D1%82%D0%B5%D0%B3%D0%BE%D0%B2-,%D0%A0%D0%B0%D0%B7%D0%B2%D1%91%D1%80%D1%82%D1%8B%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5,-%D0%BF%D1%80%D0%B0%D0%B2%D0%B8%D1%82%D1%8C Развёртывание] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=GET%20%D1%84%D0%B0%D0%B9%D0%BB%D0%B0-,%D0%9C%D0%BE%D0%BD%D0%B8%D1%82%D0%BE%D1%80%D0%B8%D0%BD%D0%B3%20%D0%BB%D0%BE%D0%B3%D0%BE%D0%B2,-GET%20%D0%BB%D0%BE%D0%B3%D0%B0%20%D0%BF%D0%BE%D0%B8%D1%81%D0%BA%D0%B0 Мониторинг логов] / GET сводного лога'''''
 Получает агрегированные записи лога, соответствующие заданным критериям.
@@ Строка 166: / Строка 166: @@
       }
     }
-  }</code>
+  }