GET лога поиска - История изменений

IKuznetsov в 11:32, 29 декабря 2024

2024-12-29T11:32:50Z

← Предыдущая версия		Версия от 11:32, 29 декабря 2024
Строка 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 лога поиска'''''

	Получает записи лога, соответствующие указанным критериям. Совпадающие записи лога сортируются по критериям, указанным в параметре запроса sort , а затем возвращаются первые ''X'' записей (как указано в параметре запроса limit ). Чтобы выполнить запрос без ограничения размера, используйте запрос GET на экспорт логов.		Получает записи лога, соответствующие указанным критериям. Совпадающие записи лога сортируются по критериям, указанным в параметре запроса sort , а затем возвращаются первые ''X'' записей (как указано в параметре запроса limit ). Чтобы выполнить запрос без ограничения размера, используйте запрос GET на экспорт логов.
Строка 187:		Строка 187:
	"sliceSize": 100,		"sliceSize": 100,
	"nextSliceKey": "___-2hI03q0AAAAAAAAAAAAAA-gAAAAAAAAH0P____8AAABkAAAACXRpbWVzdGFtcAD___7aEjTerQ"		"nextSliceKey": "___-2hI03q0AAAAAAAAAAAAAA-gAAAAAAAAH0P____8AAABkAAAACXRpbWVzdGFtcAD___7aEjTerQ"
	}~~</code>~~		}

IKuznetsov в 15:04, 26 декабря 2024

2024-12-26T15:04:29Z

← Предыдущая версия		Версия от 15:04, 26 декабря 2024
Строка 1:		Строка 1:
	'''''[[API ~~Ключ-АСТРОМ~~]] / ~~[[API Ключ-АСТРОМ#.D0.AD.D0.BD.D0.B4.D0.BF.D0.BE.D0.B9.D0.BD.D1.82.D1.8B%20.D1.81.D1.80.D0.B5.D0.B4.D1.8B\|~~Эндпойнты среды]] / ~~[[API Ключ-АСТРОМ#.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\|~~Развёртывание]] / Мониторинг логов / GET лога поиска'''''		'''''[[API АппОптима]] / Эндпойнты среды / Развёртывание / Мониторинг логов / GET лога поиска'''''

	Получает записи лога, соответствующие указанным критериям. Совпадающие записи лога сортируются по критериям, указанным в параметре запроса sort , а затем возвращаются первые ''X'' записей (как указано в параметре запроса limit ). Чтобы выполнить запрос без ограничения размера, используйте запрос GET на экспорт логов.		Получает записи лога, соответствующие указанным критериям. Совпадающие записи лога сортируются по критериям, указанным в параметре запроса sort , а затем возвращаются первые ''X'' записей (как указано в параметре запроса limit ). Чтобы выполнить запрос без ограничения размера, используйте запрос GET на экспорт логов.
Строка 69:		Строка 69:
	\|string		\|string
	\|Поисковый запрос лога.		\|Поисковый запрос лога.
	Запрос должен использовать язык поисковых запросов ~~Ключ-АСТРОМ~~ .		Запрос должен использовать язык поисковых запросов АппОптима .

	Запрос имеет ограничение в 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>) в простых выражениях).
Строка 167:		Строка 167:
	\|}		\|}
	===JSON-модель тела ответа===		===JSON-модель тела ответа===
	<~~code>~~{		<{
	"results": [		"results": [
	{		{

ENetrebin в 15:24, 28 июня 2024

2024-06-28T15:24:29Z

← Предыдущая версия		Версия от 15:24, 28 июня 2024
Строка 1:		Строка 1:
	'''''[[API Ключ-АСТРОМ]] / [[API Ключ-АСТРОМ#.D0.AD.D0.BD.D0.B4.D0.BF.D0.BE.D0.B9.D0.BD.D1.82.D1.8B%20.D1.81.D1.80.D0.B5.D0.B4.D1.8B\|Эндпойнты среды]] / [[API Ключ-АСТРОМ#.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\|Развёртывание]] ~~/ Расширения 2.0~~ / Мониторинг логов / GET лога поиска'''''		'''''[[API Ключ-АСТРОМ]] / [[API Ключ-АСТРОМ#.D0.AD.D0.BD.D0.B4.D0.BF.D0.BE.D0.B9.D0.BD.D1.82.D1.8B%20.D1.81.D1.80.D0.B5.D0.B4.D1.8B\|Эндпойнты среды]] / [[API Ключ-АСТРОМ#.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\|Развёртывание]] / Мониторинг логов / GET лога поиска'''''

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

ENetrebin: Новая страница: «'''''API Ключ-АСТРОМ / API Ключ-АСТРОМ#.D0.AD.D0.BD.D0.B4.D0.BF.D0.BE.D0.B9.D0.BD.D1.82.D1.8B%20.D1.81.D1.80.D0.B5.D0.B4.D1.8B|Эндп...»

2024-06-27T17:09:25Z

Новая страница: «'''''API Ключ-АСТРОМ / API Ключ-АСТРОМ#.D0.AD.D0.BD.D0.B4.D0.BF.D0.BE.D0.B9.D0.BD.D1.82.D1.8B%20.D1.81.D1.80.D0.B5.D0.B4.D1.8B|Эндп...»

Новая страница

'''''[[API Ключ-АСТРОМ]] / [[API Ключ-АСТРОМ#.D0.AD.D0.BD.D0.B4.D0.BF.D0.BE.D0.B9.D0.BD.D1.82.D1.8B%20.D1.81.D1.80.D0.B5.D0.B4.D1.8B|Эндпойнты среды]] / [[API Ключ-АСТРОМ#.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|Развёртывание]] / Расширения 2.0 / Мониторинг логов / GET лога поиска'''''

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

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

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

Запрос создает <code>application/json</code>полезную нагрузку.
{| class="wikitable"
|GET
|
*Среда АктивногоШлюза <nowiki>https://{ваш-активный-домен}/e/{идентификатор-вашей-среды}/api/v2/logs/search</nowiki>
|}
==Аутентификация==
Чтобы выполнить этот запрос, вам необходимо разрешение на '''Чтение логов'''( <code>logs.read</code>), назначенное вашему токену API. Чтобы узнать, как его получить и использовать, см. раздел [[Токены и аутентификация (API)|Токены и аутентификация]] .
==Параметры==
{| class="wikitable"
!Параметр
!Тип
!Описание
!In
!Необходимость
|-
|from
|string
|Начало запрошенного таймфрейма.
Вы можете использовать один из следующих форматов:
*Отметка времени в миллисекундах UTC.
*Человекочитаемый формат <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>m</code>: минуты
**<code>h</code>: часы
**<code>d</code>: дни
**<code>w</code>: недели
**<code>M</code>: месяцы
**<code>y</code>: годы
Если не задано, используется относительный двухнедельный таймфрейм ( <code>now-2w</code>).
|запрос
|по желанию
|-
|to
|string
|Конец запрошенного периода времени.
Вы можете использовать один из следующих форматов:
*Отметка времени в миллисекундах UTC.
*Человекочитаемый формат <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>m</code>: минуты
**<code>h</code>: часы
**<code>d</code>: дни
**<code>w</code>: недели
**<code>M</code>: месяцы
**<code>y</code>: годы
Если не установлено, используется текущая метка времени.
|запрос
|по желанию
|-
|limit
|integer
|Желаемое количество записей лога.
Максимально допустимый лимит составляет 1000.

Если не установлено, используется 1000.
|запрос
|по желанию
|-
|query
|string
|Поисковый запрос лога.
Запрос должен использовать язык поисковых запросов Ключ-АСТРОМ .

Запрос имеет ограничение в 20 отношений (логические операторы между простыми выражениями ( <code>AND</code>, <code>OR</code>) или операторы сравнения ( <code>=</code>, <code>!=</code>, <code><</code>, <code><=</code>, <code>></code>, <code>>=</code>) в простых выражениях).
|запрос
|по желанию
|-
|sort
|string
|Определяет порядок записей лога.
Каждое поле имеет префикс знака (+/-) для порядка сортировки. Если префикс знака не установлен, <code>+</code>будет применена опция.

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

Если разрешения в миллисекундах, предоставляемого отметкой времени, недостаточно, записи лога сортируются в соответствии с порядком, в котором они появляются в источнике журнала (удаленный процесс, записывающий в конечную точку REST API, или удаленный процесс, из которого собираются логи).
|запрос
|по желанию
|-
|nextSliceKey
|string
|Курсор для следующего фрагмента результатов. Вы можете найти его в поле nextSliceKey предыдущего ответа.
Первый срез всегда возвращается, если вы не укажете этот параметр.

Если этот параметр установлен, все остальные параметры запроса игнорируются.
|запрос
|по желанию
|}
==Ответ==
===Коды ответов===
{| class="wikitable"
!Код
|Тип
!Описание
|-
|200
|LogRecordsList
|Успех
|-
|400
|ErrorEnvelope
|Не удалось. Ввод недействителен.
|}
===Объекты тела ответа===
====Объект <code>LogRecordsList</code>====
Список извлеченных записей лога.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|results
|LogRecord[]
|Список извлеченных записей лога.
|-
|nextSliceKey
|string
|Курсор для следующего фрагмента записей лога.
|-
|sliceSize
|integer
|Общее количество записей в срезе.
|}
====Объект <code>LogRecord</code>====
Единая запись лога.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|additionalColumns
|object
|Дополнительные столбцы записи лога.
|-
|eventType
|string
|Тип события
Элемент может содержать следующие значения
*<code>K8S</code>
*<code>LOG</code>
*<code>SFM</code>
|-
|timestamp
|integer
|Временная метка записи лога в миллисекундах UTC.
|-
|status
|string
|Состояние лога (на основе уровня лога).
Элемент может содержать следующие значения
*<code>ERROR</code>
*<code>INFO</code>
*<code>NONE</code>
*<code>WARN</code>
|-
|content
|string
|Содержимое записи лога.
|}
===JSON-модель тела ответа===
<code>{
"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"
}</code>