Размещение события v2 - История изменений

ENetrebin в 15:02, 24 января 2023

2023-01-24T15:02:48Z

← Предыдущая		Версия 15:02, 24 января 2023
Строка 1:		Строка 1:
	Принимает пользовательское событие в ~~Ключ-АСТРОМ~~.		Принимает пользовательское событие в Dynatrace.

	Запрос создает <code>application/json</code>полезную нагрузку.		Запрос создает <code>application/json</code>полезную нагрузку.
Строка 88:		Строка 88:
	\|entitySelector		\|entitySelector
	\|string		\|string
	\|Селектор сущностей , определяющий набор сущностей ~~Ключ-АСТРОМ~~, которые будут связаны с событием.		\|Селектор сущностей , определяющий набор сущностей Dynatrace, которые будут связаны с событием.

	Можно выбрать только объекты, которые были активны в течение последних 24 часов.		Можно выбрать только объекты, которые были активны в течение последних 24 часов.
Строка 100:		Строка 100:
	\|Карта свойств события.		\|Карта свойств события.

	Ключи с префиксом <code>dt.*</code>зарезервированы и могут использоваться для установки свойств события с предопределенной семантикой в продукте ~~Ключ-АСТРОМ~~. Все остальные ключи интерпретируются как определяемые пользователем свойства события.		Ключи с префиксом <code>dt.*</code>зарезервированы и могут использоваться для установки свойств события с предопределенной семантикой в продукте Dynatrace. Все остальные ключи интерпретируются как определяемые пользователем свойства события.

	Значения зарезервированных ~~Ключ-АСТРОМ~~ свойств (обозначаемых ключом с префиксом <code>dt.*</code>) должны соответствовать требованиям соответствующего свойства.		Значения зарезервированных Dynatrace свойств (обозначаемых ключом с префиксом <code>dt.*</code>) должны соответствовать требованиям соответствующего свойства.

	Может быть <code>null</code>.		Может быть <code>null</code>.

ENetrebin в 09:09, 13 апреля 2022

2022-04-13T09:09:57Z

← Предыдущая		Версия 09:09, 13 апреля 2022
Строка 2:		Строка 2:

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

	~~Важный~~

	~~Прием пользовательских событий использует единицы данных Дейвиса (DDU) из пула событий.~~

	~~Первых компаний, внедривших~~

	~~Этот запрос является выпуском Early Adopter и может быть изменен несовместимым образом.~~
	{\| class="wikitable"		{\| class="wikitable"
	\| rowspan="3" \|~~СООБЩЕНИЕ~~		\| rowspan="3" \|POST
	\|~~Удалось~~		\|Managed
	\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/events/ingest</nowiki></code>		\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/events/ingest</nowiki></code>
	\|-		\|-
Строка 23:		Строка 15:

	== Аутентификация ==		== Аутентификация ==
	Чтобы выполнить этот запрос, вам нужен токен доступа с областью событий Ingest ( <code>events.ingest</code>) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .		Чтобы выполнить этот запрос, вам нужен токен доступа с областью событий Ingest ( <code>events.ingest</code>) . Чтобы узнать, как его получить и использовать, см. раздел [[Токены и аутентификация (API)\|Токены и аутентификация]] .

	== Параметры ==		== Параметры ==
Строка 30:		Строка 22:
	!Тип		!Тип
	!Описание		!Описание
	!В		!In
	!~~Необходимый~~		!Необходимость
	\|-		\|-
	\|~~тело~~		\|body
	\|~~Прием событий~~		\|EventIngest
	\|Тело JSON запроса. Содержит свойства нового события.		\|Тело JSON запроса. Содержит свойства нового события.
	\|~~тело~~		\|body
	\|необязательный		\|необязательный
	\|}		\|}
Строка 49:		Строка 41:
	!Описание		!Описание
	\|-		\|-
	\|~~тип события~~		\|eventType
	\|string		\|string
	\|Тип события.		\|Тип события.
Строка 66:		Строка 58:
	* <code>RESOURCE_CONTENTION_EVENT</code>		* <code>RESOURCE_CONTENTION_EVENT</code>
	\|-		\|-
	\|~~заглавие~~		\|title
	\|string		\|string
	\|Название события.		\|Название события.
	\|-		\|-
	\|~~время начала~~		\|startTime
	\|integer		\|integer
	\|Время начала события в миллисекундах UTC.		\|Время начала события в миллисекундах UTC.
Строка 78:		Строка 70:
	Может быть <code>null</code>.		Может быть <code>null</code>.
	\|-		\|-
	\|~~время окончания~~		\|endTime
	\|integer		\|integer
	\|Время окончания события в миллисекундах UTC.		\|Время окончания события в миллисекундах UTC.
Строка 86:		Строка 78:
	Может быть <code>null</code>.		Может быть <code>null</code>.
	\|-		\|-
	\|~~тайм-аут~~		\|timeout
	\|integer		\|integer
	\|Время ожидания события в минутах.		\|Время ожидания события в минутах.
Строка 94:		Строка 86:
	Может быть <code>null</code>.		Может быть <code>null</code>.
	\|-		\|-
	\|~~селектор объектов~~		\|entitySelector
	\|string		\|string
	\|Селектор сущностей , определяющий набор сущностей Ключ-АСТРОМ, которые будут связаны с событием.		\|Селектор сущностей , определяющий набор сущностей Ключ-АСТРОМ, которые будут связаны с событием.
Строка 104:		Строка 96:
	Может быть <code>null</code>.		Может быть <code>null</code>.
	\|-		\|-
	\|~~характеристики~~		\|properties
	\|~~объект~~		\|object
	\|Карта свойств события.		\|Карта свойств события.

Строка 136:		Строка 128:
	\|-		\|-
	\|201		\|201
	\|~~Результаты приема событий~~		\|EventIngestResults
	\|Запрос приема события был получен сервером. Тело ответа указывает для каждого события, было ли его создание успешным.		\|Запрос приема события был получен сервером. Тело ответа указывает для каждого события, было ли его создание успешным.
	\|}		\|}
Строка 149:		Строка 141:
	!Описание		!Описание
	\|-		\|-
	\|~~отчетПодсчет~~		\|reportCount
	\|integer		\|integer
	\|Количество созданных отчетов о событиях.		\|Количество созданных отчетов о событиях.
Строка 155:		Строка 147:
	Может быть <code>null</code>.		Может быть <code>null</code>.
	\|-		\|-
	\|~~eventIngestРезультаты~~		\|eventIngestResults
	\|~~Результат загрузки события~~ []		\|EventIngestResult[]
	\|Результат каждого созданного отчета о событиях.		\|Результат каждого созданного отчета о событиях.

Строка 169:		Строка 161:
	!Описание		!Описание
	\|-		\|-
	\|~~статус~~		\|status
	\|string		\|string
	\|Статус приема.		\|Статус приема.
Строка 182:		Строка 174:
	Может быть <code>null</code>.		Может быть <code>null</code>.
	\|-		\|-
	\|~~идентификатор корреляции~~		\|correlationId
	\|string		\|string
	\|Идентификатор корреляции созданного события.		\|Идентификатор корреляции созданного события.

ENetrebin в 08:44, 13 апреля 2022

2022-04-13T08:44:15Z

← Предыдущая		Версия 08:44, 13 апреля 2022
Строка 71:		Строка 71:
	\|-		\|-
	\|время начала		\|время начала
	\|~~целое число~~		\|integer
	\|Время начала события в миллисекундах UTC.		\|Время начала события в миллисекундах UTC.

Строка 79:		Строка 79:
	\|-		\|-
	\|время окончания		\|время окончания
	\|~~целое число~~		\|integer
	\|Время окончания события в миллисекундах UTC.		\|Время окончания события в миллисекундах UTC.

Строка 87:		Строка 87:
	\|-		\|-
	\|тайм-аут		\|тайм-аут
	\|~~целое число~~		\|integer
	\|Время ожидания события в минутах.		\|Время ожидания события в минутах.

Строка 150:		Строка 150:
	\|-		\|-
	\|отчетПодсчет		\|отчетПодсчет
	\|~~целое число~~		\|integer
	\|Количество созданных отчетов о событиях.		\|Количество созданных отчетов о событиях.

ENetrebin в 08:43, 13 апреля 2022

2022-04-13T08:43:01Z

← Предыдущая		Версия 08:43, 13 апреля 2022
Строка 50:		Строка 50:
	\|-		\|-
	\|тип события		\|тип события
	\|~~нить~~		\|string
	\|Тип события.		\|Тип события.

Строка 67:		Строка 67:
	\|-		\|-
	\|заглавие		\|заглавие
	\|~~нить~~		\|string
	\|Название события.		\|Название события.
	\|-		\|-
Строка 95:		Строка 95:
	\|-		\|-
	\|селектор объектов		\|селектор объектов
	\|~~нить~~		\|string
	\|Селектор сущностей , определяющий набор сущностей Ключ-АСТРОМ, которые будут связаны с событием.		\|Селектор сущностей , определяющий набор сущностей Ключ-АСТРОМ, которые будут связаны с событием.

Строка 170:		Строка 170:
	\|-		\|-
	\|статус		\|статус
	\|~~нить~~		\|string
	\|Статус приема.		\|Статус приема.

Строка 183:		Строка 183:
	\|-		\|-
	\|идентификатор корреляции		\|идентификатор корреляции
	\|~~нить~~		\|string
	\|Идентификатор корреляции созданного события.		\|Идентификатор корреляции созданного события.

ENetrebin в 08:41, 13 апреля 2022

2022-04-13T08:41:45Z

← Предыдущая		Версия 08:41, 13 апреля 2022
Строка 18:		Строка 18:
	\|<code><nowiki>https://{your-environment-id}.live.dynatrace.com/api/v2/events/ingest</nowiki></code>		\|<code><nowiki>https://{your-environment-id}.live.dynatrace.com/api/v2/events/ingest</nowiki></code>
	\|-		\|-
	\|Окружающая среда ~~ActiveGate~~		\|Окружающая среда АктивногоШлюза
	\|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/events/ingest</nowiki></code>		\|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/events/ingest</nowiki></code>
	\|}		\|}

ENetrebin в 08:32, 13 апреля 2022

2022-04-13T08:32:50Z

← Предыдущая		Версия 08:32, 13 апреля 2022
Строка 1:		Строка 1:
	Принимает пользовательское событие в ~~Dynatrace~~.		Принимает пользовательское событие в Ключ-АСТРОМ.

	Запрос создает <code>application/json</code>полезную нагрузку.		Запрос создает <code>application/json</code>полезную нагрузку.
Строка 96:		Строка 96:
	\|селектор объектов		\|селектор объектов
	\|нить		\|нить
	\|Селектор сущностей , определяющий набор сущностей ~~Dynatrace~~, которые будут связаны с событием.		\|Селектор сущностей , определяющий набор сущностей Ключ-АСТРОМ, которые будут связаны с событием.

	Можно выбрать только объекты, которые были активны в течение последних 24 часов.		Можно выбрать только объекты, которые были активны в течение последних 24 часов.
Строка 108:		Строка 108:
	\|Карта свойств события.		\|Карта свойств события.

	Ключи с префиксом <code>dt.*</code>зарезервированы и могут использоваться для установки свойств события с предопределенной семантикой в продукте ~~Dynatrace~~. Все остальные ключи интерпретируются как определяемые пользователем свойства события.		Ключи с префиксом <code>dt.*</code>зарезервированы и могут использоваться для установки свойств события с предопределенной семантикой в продукте Ключ-АСТРОМ. Все остальные ключи интерпретируются как определяемые пользователем свойства события.

	Значения зарезервированных ~~Dynatrace~~ свойств (обозначаемых ключом с префиксом <code>dt.*</code>) должны соответствовать требованиям соответствующего свойства.		Значения зарезервированных Ключ-АСТРОМ свойств (обозначаемых ключом с префиксом <code>dt.*</code>) должны соответствовать требованиям соответствующего свойства.

	Может быть <code>null</code>.		Может быть <code>null</code>.

ENetrebin: Новая страница: «Принимает пользовательское событие в Dynatrace. Запрос создает `application/json`полезную наг...»

2022-04-13T08:31:26Z

Новая страница: «Принимает пользовательское событие в Dynatrace. Запрос создает <code>application/json</code>полезную наг...»

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

Принимает пользовательское событие в Dynatrace.

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

Важный

Прием пользовательских событий использует единицы данных Дейвиса (DDU) из пула событий.

Первых компаний, внедривших

Этот запрос является выпуском Early Adopter и может быть изменен несовместимым образом.
{| class="wikitable"
| rowspan="3" |СООБЩЕНИЕ
|Удалось
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/events/ingest</nowiki></code>
|-
|SaaS
|<code><nowiki>https://{your-environment-id}.live.dynatrace.com/api/v2/events/ingest</nowiki></code>
|-
|Окружающая среда ActiveGate
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/events/ingest</nowiki></code>
|}

== Аутентификация ==
Чтобы выполнить этот запрос, вам нужен токен доступа с областью событий Ingest ( <code>events.ingest</code>) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .

== Параметры ==
{| class="wikitable"
!Параметр
!Тип
!Описание
!В
!Необходимый
|-
|тело
|Прием событий
|Тело JSON запроса. Содержит свойства нового события.
|тело
|необязательный
|}

=== Объекты тела запроса ===

==== Объект _ <code>EventIngest</code> ====
Конфигурация события для загрузки.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|тип события
|нить
|Тип события.

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

* <code>AVAILABILITY_EVENT</code>
* <code>CUSTOM_ALERT</code>
* <code>CUSTOM_ANNOTATION</code>
* <code>CUSTOM_CONFIGURATION</code>
* <code>CUSTOM_DEPLOYMENT</code>
* <code>CUSTOM_INFO</code>
* <code>ERROR_EVENT</code>
* <code>MARKED_FOR_TERMINATION</code>
* <code>PERFORMANCE_EVENT</code>
* <code>RESOURCE_CONTENTION_EVENT</code>
|-
|заглавие
|нить
|Название события.
|-
|время начала
|целое число
|Время начала события в миллисекундах UTC.

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

Может быть <code>null</code>.
|-
|время окончания
|целое число
|Время окончания события в миллисекундах UTC.

Если не задано, используется время начала плюс время ожидания.

Может быть <code>null</code>.
|-
|тайм-аут
|целое число
|Время ожидания события в минутах.

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

Может быть <code>null</code>.
|-
|селектор объектов
|нить
|Селектор сущностей , определяющий набор сущностей Dynatrace, которые будут связаны с событием.

Можно выбрать только объекты, которые были активны в течение последних 24 часов.

Если не установлено, событие связано с <code>dt.entity.environment</code>сущностью среды ( ).

Может быть <code>null</code>.
|-
|характеристики
|объект
|Карта свойств события.

Ключи с префиксом <code>dt.*</code>зарезервированы и могут использоваться для установки свойств события с предопределенной семантикой в продукте Dynatrace. Все остальные ключи интерпретируются как определяемые пользователем свойства события.

Значения зарезервированных Dynatrace свойств (обозначаемых ключом с префиксом <code>dt.*</code>) должны соответствовать требованиям соответствующего свойства.

Может быть <code>null</code>.
|}

=== JSON-модель тела запроса ===
Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
<code>{
"eventType": "AVAILABILITY_EVENT",
"title": "string",
"startTime": 1,
"endTime": 1,
"timeout": 1,
"entitySelector": "string",
"properties": {}
}</code>

== Ответ ==

=== Коды ответов ===
{| class="wikitable"
!Код
|Тип
!Описание
|-
|201
|Результаты приема событий
|Запрос приема события был получен сервером. Тело ответа указывает для каждого события, было ли его создание успешным.
|}

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

==== Объект _ <code>EventIngestResults</code> ====
Результаты приема событий.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|отчетПодсчет
|целое число
|Количество созданных отчетов о событиях.

Может быть <code>null</code>.
|-
|eventIngestРезультаты
|Результат загрузки события []
|Результат каждого созданного отчета о событиях.

Может быть <code>null</code>.
|}

==== Объект _ <code>EventIngestResult</code> ====
Результат созданного отчета о событиях.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|статус
|нить
|Статус приема.

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

* <code>INVALID_ENTITY_TYPE</code>
* <code>INVALID_METADATA</code>
* <code>INVALID_TIMESTAMPS</code>
* <code>OK</code>

Может быть <code>null</code>.
|-
|идентификатор корреляции
|нить
|Идентификатор корреляции созданного события.

Может быть <code>null</code>.
|}

=== JSON-модель тела ответа ===
<code>{
"reportCount": 1,
"eventIngestResults": [
{
"status": "INVALID_ENTITY_TYPE",
"correlationId": "string"
}
]
}</code>

== Примеры ==

=== Пример 1 ===
Вариант использования

В этом примере запрос отправляет событие « Помечено для завершения » на узлы, которые планируется удалить. Такие хосты идентифицируются группой хостов cloud-burst-hosts . Событие автоматически применяется ко всем хостам, входящим в группу. В качестве дополнительной информации указываются цель прекращения и номер задания автоматизации.

Маркер API передается в заголовке авторизации .

==== Curl ====
<code>curl --request POST \
--url <nowiki>https://mySampleEnv.live.dynatrace.com/api/v2/events/ingest</nowiki> \
--header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
--data '{
"eventType": "MARKED_FOR_TERMINATION",
"title": "Planned host downscale",
"entitySelector": "type(HOST),fromRelationship.isInstanceOf(type(HOST_GROUP),entityName(cloud-burst-hosts))",
"properties": {
"job.number": "21234346"
}
}'</code>

==== URL-адрес запроса ====
<code><nowiki>https://mySampleEnv.live.dynatrace.com/api/v2/events/ingest</nowiki></code>

==== Тело запроса ====
<code>{
"eventType": "MARKED_FOR_TERMINATION",
"title": "Planned host downscale",
"entitySelector": "type(HOST),fromRelationship.isInstanceOf(type(HOST_GROUP),entityName(cloud-burst-hosts))",
"properties": {
"job.number": "21234346"
}
}</code>

==== Тело ответа ====
<code>{
"reportCount": 2,
"eventIngestResults": [
{
"correlationId": "41f5d263011a6c9a",
"status": "OK"
},
{
"correlationId": "80eae4d163cc5760",
"status": "OK"
}
]
}</code>

==== Код ответа ====
201

=== Пример 2 ===
В этом примере запрос отправляет событие Custom info в службу BookingService , помечая ее как цель нагрузочного теста.

Маркер API передается в заголовке авторизации .

==== Curl ====
<code>curl --request POST \
--url <nowiki>https://mySampleEnv.live.dynatrace.com/api/v2/events/ingest</nowiki> \
--header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
--data '{
"eventType": "CUSTOM_INFO",
"title": "Loadtest start",
"timeout": 30,
"entitySelector": "type(SERVICE),entityName.equals(BookingService)",
"properties": {
"Tool": "MyLoadTool",
"Load per minute": "100",
"Load pattern": "production"
}
}'</code>

==== URL-адрес запроса ====
<code><nowiki>https://mySampleEnv.live.dynatrace.com/api/v2/events/ingest</nowiki></code>

==== Тело запроса ====
<code>{
"eventType": "CUSTOM_INFO",
"title": "Loadtest start",
"timeout": 30,
"entitySelector": "type(SERVICE),entityName.equals(BookingService)",
"properties": {
"Tool": "MyLoadTool",
"Load per minute": "100",
"Load pattern": "production"
}
}</code>

==== Тело ответа ====
<code>{
"reportCount": 1,
"eventIngestResults": [
{
"correlationId": "eba82f647696e485",
"status": "OK"
}
]
}</code>

==== Код ответа ====
201

=== Пример 3 ===
В этом примере запрос отправляет в службу BookingService событие Error , указывающее на неудачное обновление. Для свойства allowDavisMerge установлено значение , что запрещает Дэвису объединять это событие с любым другим событием.<code>false</code>

Маркер API передается в заголовке авторизации .

==== Curl ====
<code>curl --request POST \
--url <nowiki>https://mySampleEnv.live.dynatrace.com/api/v2/events/ingest</nowiki> \
--header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
--data '{
"eventType": "ERROR_EVENT",
"title": "Product catalog update failed",
"timeout": 30,
"entitySelector": "type(SERVICE),entityName.equals(BookingService)",
"properties": {
"allowDavisMerge": "false",
"Catalog": "APAC travels",
"Batch processor": "travel-catalog"
}
}'</code>

==== URL-адрес запроса ====
<code><nowiki>https://mySampleEnv.live.dynatrace.com/api/v2/events/ingest</nowiki></code>

==== Тело запроса ====
<code>{
"eventType": "ERROR_EVENT",
"title": "Product catalog update failed",
"timeout": 30,
"entitySelector": "type(SERVICE),entityName.equals(BookingService)",
"properties": {
"allowDavisMerge": "false",
"Catalog": "APAC travels",
"Batch processor": "travel-catalog"
}
}</code>

==== Тело ответа ====
<code>{
"reportCount": 1,
"eventIngestResults": [
{
"correlationId": "cefb7ae03ac720b6",
"status": "OK"
}
]
}</code>

==== Код ответа ====
201