Получение лога экспорта - История изменений

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

2024-12-26T15:54:40Z

← Предыдущая версия		Версия от 15:54, 26 декабря 2024
Строка 82:		Строка 82:
	\|Поисковый запрос лога.		\|Поисковый запрос лога.

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

	Запрос имеет ограничение в 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>) в простых выражениях).
Строка 192:		Строка 192:

	=== JSON-модель тела ответа ===		=== JSON-модель тела ответа ===
	<~~code>~~{		<{
	"results": [		"results": [
	{		{

ENetrebin в 11:47, 7 октября 2022

2022-10-07T11:47:31Z

← Предыдущая версия		Версия от 11:47, 7 октября 2022
Строка 7:		Строка 7:
	\|GET		\|GET
	\|		\|
	* ~~SaaShttps~~://{идентификатор_вашей_среды}.live.~~dynatrace~~.~~com~~/api/v2/logs/export		* SaaS <nowiki>https://{идентификатор_вашей_среды}.live.ruscomtech.ru/api/v2/logs/export</nowiki>
	* Окружающая среда ~~ActiveGatehttps~~://{ваш-активный-домен}/e/{идентификатор-вашей-среды}/api/v2/logs/export		* Окружающая среда АктивногоШлюза <nowiki>https://{ваш-активный-домен}/e/{идентификатор-вашей-среды}/api/v2/logs/export</nowiki>
	\|}		\|}

Строка 124:		Строка 124:
	=== Объекты тела ответа ===		=== Объекты тела ответа ===

	==== Объект _ <code>ExportedLogRecordList</code> ====		==== Объект <code>ExportedLogRecordList</code> ====
	Список экспортированных записей журнала.		Список экспортированных записей журнала.
	{\| class="wikitable"		{\| class="wikitable"
Строка 150:		Строка 150:
	\|}		\|}

	==== Объект _ <code>LogRecord</code> ====		==== Объект <code>LogRecord</code> ====
	Единая запись лога.		Единая запись лога.
	{\| class="wikitable"		{\| class="wikitable"
Строка 158:		Строка 158:
	\|-		\|-
	\|additionalColumns		\|additionalColumns
	\|~~объект~~		\|object
	\|Дополнительные столбцы записи лога.		\|Дополнительные столбцы записи лога.
	\|-
	~~\|content~~
	~~\|string~~
	~~\|Содержимое записи лога.~~
	\|-
	~~\|timestamp~~
	~~\|целое число~~
	~~\|Временная метка записи лога в миллисекундах UTC.~~
	\|-		\|-
	\|eventType		\|eventType
Строка 173:		Строка 165:
	\|Тип события		\|Тип события

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

	* <code>K8S</code>		* <code>K8S</code>
	* <code>LOG</code>		* <code>LOG</code>
	* <code>SFM</code>		* <code>SFM</code>
			\|-
			\|timestamp
			\|integer
			\|Временная метка записи журнала в миллисекундах UTC.
	\|-		\|-
	\|status		\|status
Строка 183:		Строка 179:
	\|Состояние лога (на основе уровня лога).		\|Состояние лога (на основе уровня лога).

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

	* <code>ERROR</code>		* <code>ERROR</code>
Строка 189:		Строка 185:
	* <code>NONE</code>		* <code>NONE</code>
	* <code>WARN</code>		* <code>WARN</code>
			\|-
			\|content
			\|string
			\|Содержимое записи лога.
	\|}		\|}

ENetrebin в 14:22, 5 октября 2022

2022-10-05T14:22:20Z

Внесённые изменения

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

2022-10-04T19:26:59Z

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

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

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

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

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

Этот запрос является выпуском Early Adopter и может быть изменен несовместимым образом.
{| class="wikitable"
|ПОЛУЧИТЬ
|
* SaaShttps://{идентификатор_вашей_среды}.live.dynatrace.com/api/v2/logs/export
* Окружающая среда ActiveGatehttps://{ваш-активный-домен}/e/{идентификатор-вашей-среды}/api/v2/logs/export
|}

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

== Параметры ==
{| class="wikitable"
!Параметр
!Тип
!Описание
!В
!Необходимый
|-
|из
|нить
|Начало запрошенного таймфрейма.

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

* Отметка времени в миллисекундах 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>).
|запрос
|по желанию
|-
|к
|нить
|Конец запрошенного периода времени.

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

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

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

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

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

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

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

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

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

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

== Ответ ==

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

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

==== Объект _ <code>ExportedLogRecordList</code> ====
Список экспортированных записей журнала.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|полученные результаты
|Запись журнала []
|Список извлеченных записей журнала.
|-
|размер страницы
|целое число
|Количество записей на странице.
|-
|общее количество
|целое число
|Общее количество записей в результате.
|-
|ключ следующей страницы
|нить
|Курсор для следующей страницы результатов. Имеет значение <code>null</code>на последней странице.

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

==== Объект _ <code>LogRecord</code> ====
Единая запись журнала.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|дополнительные столбцы
|объект
|Дополнительные столбцы записи журнала.
|-
|содержание
|нить
|Содержимое записи журнала.
|-
|отметка времени
|целое число
|Временная метка записи журнала в миллисекундах UTC.
|-
|тип события
|нить
|Тип события

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

* <code>K8S</code>
* <code>LOG</code>
* <code>SFM</code>
|-
|статус
|нить
|Состояние журнала (на основе уровня журнала).

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

* <code>ERROR</code>
* <code>INFO</code>
* <code>NONE</code>
* <code>WARN</code>
|}

=== JSON-модель тела ответа ===
<code>{
"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
}</code>