Просмотр кода страницы Размещение события

Эта функция отправляет пользовательские события из сторонних интеграций в один или несколько отслеживаемых объектов.

Этот эндпойнт позволяет сторонним системам, таким как платформы непрерывной интеграции (Jenkins, Bamboo, Electric Cloud и т. д.), предоставлять дополнительные сведения в Ключ-АСТРОМ для автоматического анализа первопричин.

Вы можете использовать этот эндпойнт для:

* Отправки информационных событий из сторонних систем, чтобы предоставить Ключ-АСТРОМ дополнительную информацию для автоматического анализа первопричин. Время закрытия события в этом случае уже известно, идентификаторы событий возвращаются мгновенно. Вы можете перенести эти события на срок до 30 дней в прошлое. Типы информационных событий:
** <code>CUSTOM_ANNOTATION</code>
** <code>CUSTOM_CONFIGURATION</code>
** <code>CUSTOM_DEPLOYMENT</code>
** <code>CUSTOM_INFO</code>
** <code>MARKED_FOR_TERMINATION</code>
* Отправляйте события, открывающие проблему (например, увеличение количества ошибок), чтобы активировать механизм автоматического анализа первопричин Ключ-Астром. Идентификаторы корреляции возвращаются вместо идентификаторов событий. Эти события остаются открытыми, пока не истечет указанный тайм-аут. Чтобы предотвратить истечение срока действия, вы можете обновить эти события, повторно отправив ту же полезную нагрузку. Эти события можно перенести в прошлое на срок до 60 минут . Типы событий, открывающих проблему (отсортированные по серьезности):
** <code>AVAILABILITY_EVENT</code>
** <code>ERROR_EVENT</code>
** <code>PERFORMANCE_EVENT</code>
** <code>RESOURCE_CONTENTION</code>

Запрос потребляет и создает <code>application/json</code>полезную нагрузку.
{| class="wikitable"
| rowspan="2" |СООБЩЕНИЕ
|Managed
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v1/events</nowiki></code>
|-
|Среда АктивногоШлюза
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v1/events</nowiki></code>
|}

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

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

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

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

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

* <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</code>
|-
|Начало
|integer
|Отметка времени начала события в миллисекундах UTC.

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

Вы можете сообщать о событиях только для информации за последние 30 дней .

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

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

Если не задано, текущее время используется только для информационных событий.

Не применимо к событиям открытия проблемы. Такое событие остается открытым до истечения времени ожидания в зависимости от параметра timeoutMinutes .

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

Если не установлено, используется 15 минут. Максимально допустимое значение составляет 120 минут.

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

Может быть <code>null</code>.
|-
|прикрепить правила
|Правила прикрепления push- событий
|Набор правил, определяющих объекты Ключ-Астром, которые будут связаны с событием.

Вы можете указать теги для динамического сопоставления сущностей Ключ-Астром или идентификаторов определенных сущностей.

Требуется хотя бы один идентификатор объекта или тег.
|-
|пользовательские свойства
|объект
|Набор любых свойств, связанных с событием, в формате ''«ключ»: «значение» .''

Может быть <code>null</code>.
|-
|источник
|string
|Имя или идентификатор внешнего источника события.
|-
|тип аннотации
|string
|Тип пользовательской аннотации, например <code>DNS route has been changed</code>.

Может быть <code>null</code>.
|-
|аннотацияОписание
|string
|Подробное описание пользовательской аннотации, например <code>DNS route has been changed to x.mydomain.com</code>.

Может быть <code>null</code>.
|-
|описание
|string
|Текстовое описание изменения конфигурации.

Может быть <code>null</code>.
|-
|имя развертывания
|string
|Идентификатор запущенного развертывания.

Может быть <code>null</code>.
|-
|развертываниеВерсия
|string
|Версия запущенного развертывания.

Может быть <code>null</code>.
|-
|идентификаторы таймсерий
|string []
|Список идентификаторов таймсерий, связанных с событием.

Может быть <code>null</code>.
|-
|развертываниеПроект
|string
|Имя проекта развернутого пакета.

Может быть <code>null</code>.
|-
|ciBackLink
|string
|Ссылка на развернутый артефакт в сторонней системе.

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

Может быть <code>null</code>.
|-
|оригинальный
|string
|Предыдущее значение конфигурации.

Может быть <code>null</code>.
|-
|измененный
|string
|Новое значение конфигурации, установленное событием.

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

Может быть <code>null</code>.
|-
|заглавие
|string
|Название конфигурации, заданной событием.

Может быть <code>null</code>.
|-
|разрешитьDavisMerge
|логический
|Разрешить ИИ объединить это событие с существующими проблемами (верно) или принудительно создать новую проблему (ложь).

Это относится только к типам событий, открывающих проблемы.

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

==== Объект _ <code>PushEventAttachRules</code> ====
Набор правил, определяющих объекты Ключ-Астром, которые будут связаны с событием.

Вы можете указать теги для динамического сопоставления сущностей Ключ-Астром или идентификаторов определенных сущностей.

Требуется хотя бы один идентификатор объекта или тег.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|идентификаторы объектов
|строка []
|Список идентификаторов сущностей, к которым должно быть прикреплено событие.

Может быть <code>null</code>.
|-
|tagRule
|Правило соответствия тегов []
|Набор правил сопоставления для динамического выбора сущностей на основе тегов.

В правилах сопоставления на основе тегов учитываются только объекты, просмотренные в течение последних 24 часов .

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

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

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

* <code>APM_SECURITY_GATEWAY</code>
* <code>APPLICATION</code>
* <code>APPLICATION_METHOD</code>
* <code>APPLICATION_METHOD_GROUP</code>
* <code>APPMON_SERVER</code>
* <code>APPMON_SYSTEM_PROFILE</code>
* <code>AUTO_SCALING_GROUP</code>
* <code>AUXILIARY_SYNTHETIC_TEST</code>
* <code>AWS_APPLICATION_LOAD_BALANCER</code>
* <code>AWS_AVAILABILITY_ZONE</code>
* <code>AWS_CREDENTIALS</code>
* <code>AWS_LAMBDA_FUNCTION</code>
* <code>AWS_NETWORK_LOAD_BALANCER</code>
* <code>AZURE_API_MANAGEMENT_SERVICE</code>
* <code>AZURE_APPLICATION_GATEWAY</code>
* <code>AZURE_COSMOS_DB</code>
* <code>AZURE_CREDENTIALS</code>
* <code>AZURE_EVENT_HUB</code>
* <code>AZURE_EVENT_HUB_NAMESPACE</code>
* <code>AZURE_FUNCTION_APP</code>
* <code>AZURE_IOT_HUB</code>
* <code>AZURE_LOAD_BALANCER</code>
* <code>AZURE_MGMT_GROUP</code>
* <code>AZURE_REDIS_CACHE</code>
* <code>AZURE_REGION</code>
* <code>AZURE_SERVICE_BUS_NAMESPACE</code>
* <code>AZURE_SERVICE_BUS_QUEUE</code>
* <code>AZURE_SERVICE_BUS_TOPIC</code>
* <code>AZURE_SQL_DATABASE</code>
* <code>AZURE_SQL_ELASTIC_POOL</code>
* <code>AZURE_SQL_SERVER</code>
* <code>AZURE_STORAGE_ACCOUNT</code>
* <code>AZURE_SUBSCRIPTION</code>
* <code>AZURE_TENANT</code>
* <code>AZURE_VM</code>
* <code>AZURE_VM_SCALE_SET</code>
* <code>AZURE_WEB_APP</code>
* <code>CF_APPLICATION</code>
* <code>CF_FOUNDATION</code>
* <code>CINDER_VOLUME</code>
* <code>CLOUD_APPLICATION</code>
* <code>CLOUD_APPLICATION_INSTANCE</code>
* <code>CLOUD_APPLICATION_NAMESPACE</code>
* <code>CLOUD_NETWORK_INGRESS</code>
* <code>CLOUD_NETWORK_POLICY</code>
* <code>CONTAINER_GROUP</code>
* <code>CONTAINER_GROUP_INSTANCE</code>
* <code>CUSTOM_APPLICATION</code>
* <code>CUSTOM_DEVICE</code>
* <code>CUSTOM_DEVICE_GROUP</code>
* <code>DCRUM_APPLICATION</code>
* <code>DCRUM_SERVICE</code>
* <code>DCRUM_SERVICE_INSTANCE</code>
* <code>DEVICE_APPLICATION_METHOD</code>
* <code>DISK</code>
* <code>DOCKER_CONTAINER_GROUP</code>
* <code>DOCKER_CONTAINER_GROUP_INSTANCE</code>
* <code>DYNAMO_DB_TABLE</code>
* <code>EBS_VOLUME</code>
* <code>EC2_INSTANCE</code>
* <code>ELASTIC_LOAD_BALANCER</code>
* <code>ENVIRONMENT</code>
* <code>EXTERNAL_SYNTHETIC_TEST_STEP</code>
* <code>GCP_ZONE</code>
* <code>GEOLOCATION</code>
* <code>GEOLOC_SITE</code>
* <code>GOOGLE_COMPUTE_ENGINE</code>
* <code>HOST</code>
* <code>HOST_GROUP</code>
* <code>HTTP_CHECK</code>
* <code>HTTP_CHECK_STEP</code>
* <code>HYPERVISOR</code>
* <code>KUBERNETES_CLUSTER</code>
* <code>KUBERNETES_NODE</code>
* <code>KUBERNETES_SERVICE</code>
* <code>MOBILE_APPLICATION</code>
* <code>NETWORK_INTERFACE</code>
* <code>NEUTRON_SUBNET</code>
* <code>OPENSTACK_PROJECT</code>
* <code>OPENSTACK_REGION</code>
* <code>OPENSTACK_VM</code>
* <code>OS</code>
* <code>PROCESS_GROUP</code>
* <code>PROCESS_GROUP_INSTANCE</code>
* <code>QUEUE</code>
* <code>RELATIONAL_DATABASE_SERVICE</code>
* <code>SERVICE</code>
* <code>SERVICE_INSTANCE</code>
* <code>SERVICE_METHOD</code>
* <code>SERVICE_METHOD_GROUP</code>
* <code>SWIFT_CONTAINER</code>
* <code>SYNTHETIC_LOCATION</code>
* <code>SYNTHETIC_TEST</code>
* <code>SYNTHETIC_TEST_STEP</code>
* <code>VIRTUALMACHINE</code>
* <code>VMWARE_DATACENTER</code>
|-
|теги
|Информация о теге []
|Список тегов, которые вы хотите использовать для сопоставления. Требуется хотя бы один тег.

Вы можете использовать пользовательские теги из пользовательского интерфейса, импортированные теги и теги на основе переменных среды.
|}

==== Объект _ <code>TagInfo</code> ====
Тег сущности Ключ-Астром.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|контекст
|нить
|Происхождение тега, например AWS или Cloud Foundry.

Пользовательские теги используют это <code>CONTEXTLESS</code>значение.

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

* <code>AWS</code>
* <code>AWS_GENERIC</code>
* <code>AZURE</code>
* <code>CLOUD_FOUNDRY</code>
* <code>CONTEXTLESS</code>
* <code>ENVIRONMENT</code>
* <code>GOOGLE_CLOUD</code>
* <code>KUBERNETES</code>
|-
|ключ
|нить
|Ключ тега.

Пользовательские теги имеют значение тега здесь.
|-
|стоимость
|нить
|Значение тега.

Не применимо к пользовательским тегам.

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

=== JSON-модель тела запроса ===
Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
 <code>{
   "eventType": "CUSTOM_ANNOTATION",
   "start": 1521042929000,
   "end": 1521542929000,
   "attachRules": {
     "entityIds": [
       "CUSTOM_DEVICE-0000000000000007"
     ],
     "tagRule": [
       {
         "meTypes": [
           "HOST"
         ],
         "tags": [
           {
             "context": "CONTEXTLESS",
             "key": "customTag"
           }
         ]
       }
     ]
   },
   "source": "OpsControl",
   "annotationType": "defect",
   "annotationDescription": "The coffee machine is broken"
 }</code>

=== Отображение параметров ===
{| class="wikitable"
!
!Событие доступности
!Пользовательская аннотация
!Пользовательская конфигурация
!Пользовательское развертывание
!Пользовательская информация
!Событие ошибки
!Перформанс
!Конфликт ресурсов
!Помечено для прекращения
|-
|описание
|запрос
|выбрать
|запрос
|н/д
|запрос
|запрос
|запрос
|запрос
|запрос
|-
|заглавие
|запрос
|н/д
|н/д
|н/д
|выбрать
|запрос
|запрос
|запрос
|выбрать
|-
|источник
|запрос
|запрос
|запрос
|запрос
|запрос
|запрос
|запрос
|запрос
|запрос
|-
|тип аннотации
|н/д
|запрос
|н/д
|н/д
|н/д
|н/д
|н/д
|н/д
|н/д
|-
|аннотацияОписание
|н/д
|запрос
|н/д
|н/д
|н/д
|н/д
|н/д
|н/д
|н/д
|-
|имя развертывания
|н/д
|н/д
|н/д
|запрос
|н/д
|н/д
|н/д
|н/д
|н/д
|-
|развертываниеВерсия
|н/д
|н/д
|н/д
|запрос
|н/д
|н/д
|н/д
|н/д
|н/д
|-
|развертываниеПроект
|н/д
|н/д
|н/д
|выбрать
|н/д
|н/д
|н/д
|н/д
|н/д
|-
|ciBackLink
|н/д
|н/д
|н/д
|выбрать
|н/д
|н/д
|н/д
|н/д
|выбрать
|-
|исправлениеДействие
|н/д
|н/д
|н/д
|выбрать
|н/д
|н/д
|н/д
|н/д
|н/д
|-
|оригинальный
|н/д
|н/д
|выбрать
|н/д
|н/д
|н/д
|н/д
|н/д
|н/д
|-
|конфигурация
|н/д
|н/д
|запрос
|н/д
|н/д
|н/д
|н/д
|н/д
|н/д
|-
|пользовательские свойства
|выбрать
|выбрать
|выбрать
|выбрать
|выбрать
|выбрать
|выбрать
|выбрать
|выбрать
|}

== Ответ ==

=== Коды ответов ===
{| class="wikitable"
!Код
|Тип
!Описание
|-
|200
|Результат хранилища событий
|Успех
|}

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

==== Объект _ <code>EventStoreResult</code> ====
Содержит идентификаторы всех настраиваемых событий, созданных с помощью push-вызова события.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|сохраненные идентификаторы событий
|целое []
|Список идентификаторов событий для информационных событий.

Это поле предусмотрено для совместимости. Вместо этого следует использовать значения из поля storeIds .

Может быть <code>null</code>.
|-
|сохраненные идентификаторы
|строка []
|Список закодированных идентификаторов событий для информационных событий.

Может быть <code>null</code>.
|-
|сохраненные корреляционные идентификаторы
|строка []
|Список идентификаторов корреляции для событий открытия проблемы.

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

=== JSON-модель тела ответа ===
 <code>{
   "storedEventIds": [
     1
   ],
   "storedIds": [
     "string"
   ],
   "storedCorrelationIds": [
     "string"
   ]
 }</code>

== Пример ==
В этом примере запрос отправляет событие CUSTOM_ANNOTATION , которое применяется ко всем пользовательским устройствам с тегом Coffee-2nd-floor . Эта аннотация является уведомлением о том, что эти кофемашины сломаны.

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

==== Curl ====
 <code>curl -X POST \
   https://mySampleEnv.live.astromkey<nowiki/>.com/api/v1/events \
   -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
   -H 'Content-Type: application/json' \
   -d '{
   "eventType": "CUSTOM_ANNOTATION",
   "timeoutMinutes": 0,
   "attachRules": {
 
     "tagRule": [
       {
         "meTypes": [
           "CUSTOM_DEVICE"
         ],
         "tags": [
           {
             "context": "CONTEXTLESS",
             "key": "IG-test"
           }
         ]
       }
     ]
   },
   "source": "OpsControl",
   "annotationType": "defect",
   "annotationDescription": "coffee machine is defective"
 }'</code>

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

==== Тело запроса ====
 <code>{
   "eventType": "CUSTOM_ANNOTATION",
   "timeoutMinutes": 0,
   "attachRules": {
     "tagRule": [
       {
         "meTypes": [
           "CUSTOM_DEVICE"
         ],
         "tags": [
           {
             "context": "CONTEXTLESS",
             "key": "IG-test"
           }
         ]
       }
     ]
   },
   "source": "OpsControl",
   "annotationType": "defect",
   "annotationDescription": "coffee machine is defective"
 }</code>

==== Тело ответа ====
 <code>{
   "storedEventIds": [
     -6153476110846051426
   ],
   "storedIds": [
     "-6153476110846051426_1533300519291"
   ],
   "storedCorrelationIds": []
 }</code>

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