Получение сводного лога: различия между версиями
ENetrebin (обсуждение | вклад)  (Новая страница: «Получает агрегированные записи журнала, соответствующие заданным критериям.  Возвращае...»)  | 
				ENetrebin (обсуждение | вклад)   | 
				||
| (не показаны 3 промежуточные версии этого же участника) | |||
| Строка 1: | Строка 1: | ||
Получает агрегированные записи   | Получает агрегированные записи лога, соответствующие заданным критериям.  | ||
Возвращает агрегированное количество вхождений значений   | Возвращает агрегированное количество вхождений значений лога, разделенных на временные интервалы.  | ||
Возможно, что временные рамки, охватываемые результатами, превышают указанные временные рамки. В таких случаях запрос возвращает меньше временных интервалов, чем указано в параметре запроса timeBuckets .  | Возможно, что временные рамки, охватываемые результатами, превышают указанные временные рамки. В таких случаях запрос возвращает меньше временных интервалов, чем указано в параметре запроса timeBuckets .  | ||
| Строка 9: | Строка 9: | ||
Этот запрос является выпуском Early Adopter и может быть изменен несовместимым образом.  | Этот запрос является выпуском Early Adopter и может быть изменен несовместимым образом.  | ||
{| class="wikitable"  | {| class="wikitable"  | ||
|  | |GET  | ||
|  | |  | ||
*   | * SaaS <nowiki>https://{идентификатор_вашей_среды}.dynatrace.com/api/v2/logs/aggregate</nowiki>  | ||
* Окружающая среда   | * Окружающая среда АктивногоШлюза <nowiki>https://{ваш-активный-домен}/e/{идентификатор-вашей-среды}/api/v2/logs/aggregate</nowiki>  | ||
|}  | |}  | ||
== Аутентификация ==  | == Аутентификация ==  | ||
Чтобы выполнить этот запрос, вам необходимо разрешение на чтение   | Чтобы выполнить этот запрос, вам необходимо разрешение на '''чтение логов''' ( <code>logs.read</code>), назначенное вашему токену API. Чтобы узнать, как его получить и использовать, см. раздел [[Токены и аутентификация (API)|Токены и аутентификация]] .  | ||
== Параметры ==  | == Параметры ==  | ||
| Строка 23: | Строка 23: | ||
!Тип  | !Тип  | ||
!Описание  | !Описание  | ||
!  | !In  | ||
!  | !Необходимость  | ||
|-  | |-  | ||
|  | |from  | ||
|  | |string  | ||
|Начало запрошенного таймфрейма.  | |Начало запрошенного таймфрейма.  | ||
| Строка 35: | Строка 35: | ||
* Человекочитаемый формат <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>: месяцы  | ||
| Строка 46: | Строка 46: | ||
|по желанию  | |по желанию  | ||
|-  | |-  | ||
|  | |to  | ||
|  | |string  | ||
|Конец запрошенного периода времени.  | |Конец запрошенного периода времени.  | ||
| Строка 55: | Строка 55: | ||
* Человекочитаемый формат <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>: месяцы  | ||
| Строка 66: | Строка 66: | ||
|по желанию  | |по желанию  | ||
|-  | |-  | ||
|  | |query  | ||
|  | |string  | ||
|Поисковый запрос   | |Поисковый запрос лога.  | ||
Запрос должен использовать язык поисковых запросов Dynatrace .  | Запрос должен использовать язык поисковых запросов Dynatrace .  | ||
| Строка 76: | Строка 76: | ||
|по желанию  | |по желанию  | ||
|-  | |-  | ||
|  | |timeBuckets  | ||
|  | |integer  | ||
|Количество временных интервалов в результате.  | |Количество временных интервалов в результате.  | ||
| Строка 89: | Строка 89: | ||
|-  | |-  | ||
|maxGroupValues  | |maxGroupValues  | ||
|  | |integer  | ||
|Максимальное количество значений в каждой группе.  | |Максимальное количество значений в каждой группе.  | ||
| Строка 98: | Строка 98: | ||
|по желанию  | |по желанию  | ||
|-  | |-  | ||
|  | |groupBy  | ||
|  | |string []  | ||
|Группы, которые должны быть включены в ответ.  | |Группы, которые должны быть включены в ответ.  | ||
| Строка 120: | Строка 120: | ||
|-  | |-  | ||
|200  | |200  | ||
|  | |AggregatedLog  | ||
|Успех  | |Успех  | ||
|-  | |-  | ||
| Строка 130: | Строка 130: | ||
=== Объекты тела ответа ===  | === Объекты тела ответа ===  | ||
==== Объект   | ==== Объект <code>AggregatedLog</code> ====  | ||
Совокупные записи   | Совокупные записи лога.  | ||
{| class="wikitable"  | {| class="wikitable"  | ||
!Элемент  | !Элемент  | ||
| Строка 137: | Строка 137: | ||
!Описание  | !Описание  | ||
|-  | |-  | ||
|  | |aggregationResult  | ||
|  | |object  | ||
|Совокупные записи   | |Совокупные записи лога.  | ||
|}  | |}  | ||
Текущая версия на 15:13, 27 января 2023
Получает агрегированные записи лога, соответствующие заданным критериям.
Возвращает агрегированное количество вхождений значений лога, разделенных на временные интервалы.
Возможно, что временные рамки, охватываемые результатами, превышают указанные временные рамки. В таких случаях запрос возвращает меньше временных интервалов, чем указано в параметре запроса timeBuckets .
Запрос создает application/jsonполезную нагрузку.
Этот запрос является выпуском Early Adopter и может быть изменен несовместимым образом.
| GET | 
  | 
Аутентификация
Чтобы выполнить этот запрос, вам необходимо разрешение на чтение логов ( logs.read), назначенное вашему токену API. Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Параметры
| Параметр | Тип | Описание | In | Необходимость | 
|---|---|---|---|---|
| from | string | Начало запрошенного таймфрейма.
 Вы можете использовать один из следующих форматов: 
 Если не задано, используется относительный двухнедельный таймфрейм (   | 
запрос | по желанию | 
| to | string | Конец запрошенного периода времени.
 Вы можете использовать один из следующих форматов: 
 Если не установлено, используется текущая метка времени.  | 
запрос | по желанию | 
| query | string | Поисковый запрос лога.
 Запрос должен использовать язык поисковых запросов Dynatrace . Запрос имеет ограничение в 20 отношений (логические операторы между простыми выражениями (   | 
запрос | по желанию | 
| timeBuckets | integer | Количество временных интервалов в результате.
 Временной интервал запроса делится поровну на указанное количество слотов. Минимальная длина слота составляет 1 мс. Если не установлено, используется 1.  | 
запрос | по желанию | 
| maxGroupValues | integer | Максимальное количество значений в каждой группе.
 Вы можете получить до 100 значений на группу. Если не установлено, используется 10.  | 
запрос | по желанию | 
| groupBy | string [] | Группы, которые должны быть включены в ответ.
 Вы можете указать несколько групп в следующем формате:  Если не установлено, возвращаются все возможные группы. Вы можете использовать эту опцию для проверки возможных значений группировки. Уникальные атрибуты данных журнала (атрибуты высокой мощности), например,   | 
запрос | по желанию | 
Ответ
Коды ответов
| Код | Тип | Описание | 
|---|---|---|
| 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"
      }
    }
  }
}