Получение ленты событий: различия между версиями

Материал из Dynatrace
 
(не показаны 4 промежуточные версии 2 участников)
Строка 1: Строка 1:
Функция предоставляет список всех событий вашей среды и их параметров. Поскольку возможное количество событий может быть большим, ответ ограничен 150 событиями. Вы можете сузить вывод, указав параметры фильтрации в своем запросе.
Функция предоставляет список всех событий вашей среды и их параметров. Поскольку возможное количество событий может быть большим, ответ ограничен 150 событиями. Вы можете сузить вывод, указав параметры фильтрации в своем запросе .


Запрос создает <code>application/json</code>полезную нагрузку.
Запрос создает <code>application/json</code>полезную нагрузку.
Строка 198: Строка 198:
|entityId
|entityId
|string
|string
|Фильтрует результирующий набор событий до событий, связанных с указанным объектом Ключ-АСТРОМ.
|Фильтрует результирующий набор событий до событий, связанных с указанным объектом Dynatrace.
|запрос
|запрос
|необязательный
|необязательный
Строка 488: Строка 488:
|-
|-
|tags
|tags
|Информация о теге []
|TagInfo[]
|Теги объекта Dynatrace, вызвавшего событие.
|Теги объекта Dynatrace, вызвавшего событие.


Строка 503: Строка 503:


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


Строка 526: Строка 526:
* <code>KUBERNETES</code>
* <code>KUBERNETES</code>
|-
|-
|ключ
|key
|нить
|string
|Ключ тега.
|Ключ тега.


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


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


==== Завиток ====
==== Curl ====
  <code>curl -X GET \
  <code>curl -X GET \
   '<nowiki>https://mySampleEnv.live.dynatrace.com/api/v1/events?eventType=ERROR_EVENT&relativeTime=day'</nowiki> \
   '<nowiki>https://mySampleEnv.live.dynatrace.com/api/v1/events?eventType=ERROR_EVENT&relativeTime=day'</nowiki> \

Текущая версия на 14:54, 24 января 2023

Функция предоставляет список всех событий вашей среды и их параметров. Поскольку возможное количество событий может быть большим, ответ ограничен 150 событиями. Вы можете сузить вывод, указав параметры фильтрации в своем запросе .

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

GET Managed https://{your-domain}/e/{your-environment-id}/api/v1/events
SaaS https://{your-environment-id}.live.dynatrace.com/api/v1/events
Environment ActiveGate https://{your-activegate-domain}/e/{your-environment-id}/api/v1/events

Аутентификация

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

Параметры

Параметр Тип Описание In Необходимость
from integer Отметка времени начала запроса в миллисекундах UTC.

Используется значение "30 дней назад", если не задано значение relativeTime .

запрос необязательный
to integer Конечная метка времени запроса в миллисекундах UTC.

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

Срок не должен превышать 2 лет.

запрос необязательный
relativeTime string Относительный таймфрейм, назад от текущего времени.

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

  • 10mins
  • 15mins
  • 2hours
  • 30mins
  • 3days
  • 5mins
  • 6hours
  • day
  • hour
  • min
  • month
  • week
запрос необязательный
eventType string Фильтрует результирующий набор событий по типу события.

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

  • APPLICATION_JS_FRAMEWORK_DETECTED
  • APPLICATION_OVERLOAD_PREVENTION
  • AVAILABILITY_EVENT
  • CONNECTION_LOST
  • CPU_SATURATED
  • CUSTOM_ALERT
  • CUSTOM_ANNOTATION
  • CUSTOM_APPLICATION_OVERLOAD_PREVENTION
  • CUSTOM_APP_CRASH_RATE_INCREASED
  • CUSTOM_CONFIGURATION
  • CUSTOM_DEPLOYMENT
  • CUSTOM_INFO
  • DATABASE_CONNECTION_FAILURE
  • DEPLOYMENT_CHANGED_CHANGE
  • DEPLOYMENT_CHANGED_NEW
  • DEPLOYMENT_CHANGED_REMOVED
  • DYNATRACE_INTERNAL
  • EBS_VOLUME_HIGH_LATENCY
  • ELASTIC_LOAD_BALANCER_HIGH_BACKEND_FAILURE_RATE
  • ELASTIC_LOAD_BALANCER_HIGH_FAILURE_RATE
  • ELASTIC_LOAD_BALANCER_HIGH_UNHEALTHY_HOST_RATE
  • ERROR_EVENT
  • ESXI_HOST_VM_MOTION_ARRIVED
  • ESXI_HOST_VM_MOTION_LEFT
  • ESXI_HOST_VM_STARTED
  • ESXI_START
  • ESXI_VM_DISCONNECTED
  • ESXI_VM_MOTION
  • ESXI_VM_POWER_OFF
  • ESXI_VM_START
  • FAILURE_RATE_INCREASED
  • HIGH_CONNECTIVITY_FAILURES
  • HIGH_DROPPED_PACKETS_RATE
  • HIGH_GC_ACTIVITY
  • HIGH_LATENCY
  • HIGH_NETWORK_ERROR_RATE
  • HIGH_NETWORK_LOSS_RATE
  • HIGH_NETWORK_UTILIZATION
  • HOST_CONNECTION_FAILED
  • HOST_CONNECTION_LOST
  • HOST_DATASTORE_LOW_DISK_SPACE
  • HOST_DISK_LOW_INODES
  • HOST_GRACEFULLY_SHUTDOWN
  • HOST_LOG_AVAILABILITY
  • HOST_LOG_ERROR
  • HOST_LOG_MATCHED
  • HOST_LOG_PERFORMANCE
  • HOST_MAINTENANCE
  • HOST_NO_CONNECTION
  • HOST_OF_SERVICE_UNAVAILABLE
  • HOST_SHUTDOWN
  • HOST_TIMEOUT
  • HTTP_CHECK_GLOBAL_OUTAGE
  • HTTP_CHECK_LOCAL_OUTAGE
  • HTTP_CHECK_TEST_LOCATION_SLOWDOWN
  • INSUFFICIENT_DISK_QUEUE_DEPTH
  • JAVASCRIPT_ERROR_RATE_INCREASED
  • LAMBDA_FUNCTION_HIGH_ERROR_RATE
  • LOG_AVAILABILITY
  • LOG_ERROR
  • LOG_MATCHED
  • LOG_PERFORMANCE
  • LOW_DISK_SPACE
  • LOW_STORAGE_SPACE
  • MARKED_FOR_TERMINATION
  • MEMORY_RESOURCES_EXHAUSTED
  • MEMORY_SATURATED
  • MOBILE_APPLICATION_OVERLOAD_PREVENTION
  • MOBILE_APP_CRASH_RATE_INCREASED
  • MONITORING_UNAVAILABLE
  • OPENSTACK_HOST_VM_SHUTDOWN
  • OPENSTACK_HOST_VM_STARTED
  • OPENSTACK_KEYSTONE_SLOW
  • OPENSTACK_KEYSTONE_UNHEALTHY
  • OPENSTACK_VM_LAUNCH_FAILED
  • OPENSTACK_VM_MOTION
  • OSI_DOCKER_DEVICEMAPPER_LOW_DATA_SPACE
  • OSI_DOCKER_DEVICEMAPPER_LOW_METADATA_SPACE
  • OVERLOADED_STORAGE
  • PERFORMANCE_EVENT
  • PGI_CRASHED_INFO
  • PGI_HAPROXY_QUEUED_REQUESTS_HIGH
  • PGI_HAPROXY_SESSION_USAGE_HIGH
  • PGI_LOG_MATCHED
  • PGI_MEMDUMP
  • PGI_MYSQL_SLOW_QUERIES_RATE_HIGH
  • PGI_OF_SERVICE_UNAVAILABLE
  • PGI_RMQ_HIGH_FILE_DESC_USAGE
  • PGI_RMQ_HIGH_MEM_USAGE
  • PGI_RMQ_HIGH_PROCESS_USAGE
  • PGI_RMQ_HIGH_SOCKETS_USAGE
  • PGI_RMQ_LOW_DISK_SPACE
  • PROCESS_CRASHED
  • PROCESS_CUSTOM_AVAILABILITY
  • PROCESS_CUSTOM_ERROR
  • PROCESS_CUSTOM_PERFORMANCE
  • PROCESS_GROUP_LOW_INSTANCE_COUNT
  • PROCESS_LOG_AVAILABILITY
  • PROCESS_LOG_ERROR
  • PROCESS_LOG_PERFORMANCE
  • PROCESS_RESTART
  • PROCESS_UNAVAILABLE
  • RDS_AZ_FAILOVER_COMPLETED
  • RDS_AZ_FAILOVER_STARTED
  • RDS_BACKUP_COMPLETED
  • RDS_BACKUP_STARTED
  • RDS_OF_SERVICE_UNAVAILABLE
  • RDS_RESTART
  • RDS_RESTART_SEQUENCE
  • RESOURCE_CONTENTION
  • SERVICE_RESPONSE_TIME_DEGRADED
  • SLOW_DISK
  • SYNTHETIC_AVAILABILITY
  • SYNTHETIC_NODE_OUTAGE
  • SYNTHETIC_PRIVATE_LOCATION_OUTAGE
  • SYNTHETIC_SLOWDOWN
  • THREADS_RESOURCES_EXHAUSTED
  • UNEXPECTED_HIGH_LOAD
  • UNEXPECTED_LOW_LOAD
  • USER_ACTION_DURATION_DEGRADATION
  • VIRTUAL_MACHINE_SHUTDOWN
  • WEB_CHECK_GLOBAL_OUTAGE
  • WEB_CHECK_LOCAL_OUTAGE
запрос необязательный
entityId string Фильтрует результирующий набор событий до событий, связанных с указанным объектом Dynatrace. запрос необязательный
cursor string Ответ ограничен 150 событиями, поэтому, если вы хотите получить больше, вы можете использовать курсор, чтобы получить следующие 150. Этот параметр должен быть пустым при первом запросе.

Клавиша курсора затем может быть найдена в поле nextCursor предыдущего ответа.

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

запрос необязательный

Ответ

Каждое событие содержит как минимум следующие элементы метаинформации и свойства, относящиеся к событию.

Коды ответов

Код Тип Описание
200 Результат запроса события Успех

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

Объект _ EventQueryResult

События окружающей среды.

Элемент Тип Описание
nextCursor string Курсор для следующих 150 событий, соответствующих указанным критериям.

Установите это значение для параметра запроса курсора . Без него вы снова получите первые 150 событий.

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

Может быть null.

from integer Начало периода запроса.

Может быть null.

to integer Конец периода запроса.

Может быть null.

totalEventCount integer Общее количество событий, соответствующих заданным критериям.

Может быть null.

events EventRestEntry[] Список событий.

Может быть null.

Объект _ EventRestEntry

Набор параметров события.

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

Элемент Тип Описание
startTime integer Отметка времени обнаружения события в миллисекундах UTC.

Может быть null.

startTime integer Отметка времени закрытия события в миллисекундах UTC.

Может быть null.

entityId string Идентификатор затронутого объекта Dynatrace.

Может быть null.

entityName string Имя затронутого объекта Dynatrace.

Может быть null.

severityLevel string Тяжесть события.

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

  • AVAILABILITY
  • CUSTOM_ALERT
  • ERROR
  • MONITORING_UNAVAILABLE
  • PERFORMANCE
  • RESOURCE_CONTENTION

Может быть null.

impactLevel string Уровень воздействия события. Он показывает, на что влияет проблема: на инфраструктуру, службу или приложение.

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

  • APPLICATION
  • ENVIRONMENT
  • INFRASTRUCTURE
  • SERVICE

Может быть null.

eventType string Тип события.

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

  • APPLICATION_JS_FRAMEWORK_DETECTED
  • APPLICATION_OVERLOAD_PREVENTION
  • AVAILABILITY_EVENT
  • CONNECTION_LOST
  • CPU_SATURATED
  • CUSTOM_ALERT
  • CUSTOM_ANNOTATION
  • CUSTOM_APPLICATION_OVERLOAD_PREVENTION
  • CUSTOM_APP_CRASH_RATE_INCREASED
  • CUSTOM_CONFIGURATION
  • CUSTOM_DEPLOYMENT
  • CUSTOM_INFO
  • DATABASE_CONNECTION_FAILURE
  • DEPLOYMENT_CHANGED_CHANGE
  • DEPLOYMENT_CHANGED_NEW
  • DEPLOYMENT_CHANGED_REMOVED
  • DYNATRACE_INTERNAL
  • EBS_VOLUME_HIGH_LATENCY
  • ELASTIC_LOAD_BALANCER_HIGH_BACKEND_FAILURE_RATE
  • ELASTIC_LOAD_BALANCER_HIGH_FAILURE_RATE
  • ELASTIC_LOAD_BALANCER_HIGH_UNHEALTHY_HOST_RATE
  • ERROR_EVENT
  • ESXI_HOST_VM_MOTION_ARRIVED
  • ESXI_HOST_VM_MOTION_LEFT
  • ESXI_HOST_VM_STARTED
  • ESXI_START
  • ESXI_VM_DISCONNECTED
  • ESXI_VM_MOTION
  • ESXI_VM_POWER_OFF
  • ESXI_VM_START
  • FAILURE_RATE_INCREASED
  • HIGH_CONNECTIVITY_FAILURES
  • HIGH_DROPPED_PACKETS_RATE
  • HIGH_GC_ACTIVITY
  • HIGH_LATENCY
  • HIGH_NETWORK_ERROR_RATE
  • HIGH_NETWORK_LOSS_RATE
  • HIGH_NETWORK_UTILIZATION
  • HOST_CONNECTION_FAILED
  • HOST_CONNECTION_LOST
  • HOST_DATASTORE_LOW_DISK_SPACE
  • HOST_DISK_LOW_INODES
  • HOST_GRACEFULLY_SHUTDOWN
  • HOST_LOG_AVAILABILITY
  • HOST_LOG_ERROR
  • HOST_LOG_MATCHED
  • HOST_LOG_PERFORMANCE
  • HOST_MAINTENANCE
  • HOST_NO_CONNECTION
  • HOST_OF_SERVICE_UNAVAILABLE
  • HOST_SHUTDOWN
  • HOST_TIMEOUT
  • HTTP_CHECK_GLOBAL_OUTAGE
  • HTTP_CHECK_LOCAL_OUTAGE
  • HTTP_CHECK_TEST_LOCATION_SLOWDOWN
  • INSUFFICIENT_DISK_QUEUE_DEPTH
  • JAVASCRIPT_ERROR_RATE_INCREASED
  • LAMBDA_FUNCTION_HIGH_ERROR_RATE
  • LOG_AVAILABILITY
  • LOG_ERROR
  • LOG_MATCHED
  • LOG_PERFORMANCE
  • LOW_DISK_SPACE
  • LOW_STORAGE_SPACE
  • MARKED_FOR_TERMINATION
  • MEMORY_RESOURCES_EXHAUSTED
  • MEMORY_SATURATED
  • MOBILE_APPLICATION_OVERLOAD_PREVENTION
  • MOBILE_APP_CRASH_RATE_INCREASED
  • MONITORING_UNAVAILABLE
  • OPENSTACK_HOST_VM_SHUTDOWN
  • OPENSTACK_HOST_VM_STARTED
  • OPENSTACK_KEYSTONE_SLOW
  • OPENSTACK_KEYSTONE_UNHEALTHY
  • OPENSTACK_VM_LAUNCH_FAILED
  • OPENSTACK_VM_MOTION
  • OSI_DOCKER_DEVICEMAPPER_LOW_DATA_SPACE
  • OSI_DOCKER_DEVICEMAPPER_LOW_METADATA_SPACE
  • OVERLOADED_STORAGE
  • PERFORMANCE_EVENT
  • PGI_CRASHED_INFO
  • PGI_HAPROXY_QUEUED_REQUESTS_HIGH
  • PGI_HAPROXY_SESSION_USAGE_HIGH
  • PGI_LOG_MATCHED
  • PGI_MEMDUMP
  • PGI_MYSQL_SLOW_QUERIES_RATE_HIGH
  • PGI_OF_SERVICE_UNAVAILABLE
  • PGI_RMQ_HIGH_FILE_DESC_USAGE
  • PGI_RMQ_HIGH_MEM_USAGE
  • PGI_RMQ_HIGH_PROCESS_USAGE
  • PGI_RMQ_HIGH_SOCKETS_USAGE
  • PGI_RMQ_LOW_DISK_SPACE
  • PROCESS_CRASHED
  • PROCESS_CUSTOM_AVAILABILITY
  • PROCESS_CUSTOM_ERROR
  • PROCESS_CUSTOM_PERFORMANCE
  • PROCESS_GROUP_LOW_INSTANCE_COUNT
  • PROCESS_LOG_AVAILABILITY
  • PROCESS_LOG_ERROR
  • PROCESS_LOG_PERFORMANCE
  • PROCESS_RESTART
  • PROCESS_UNAVAILABLE
  • RDS_AZ_FAILOVER_COMPLETED
  • RDS_AZ_FAILOVER_STARTED
  • RDS_BACKUP_COMPLETED
  • RDS_BACKUP_STARTED
  • RDS_OF_SERVICE_UNAVAILABLE
  • RDS_RESTART
  • RDS_RESTART_SEQUENCE
  • RESOURCE_CONTENTION
  • SERVICE_RESPONSE_TIME_DEGRADED
  • SLOW_DISK
  • SYNTHETIC_AVAILABILITY
  • SYNTHETIC_NODE_OUTAGE
  • SYNTHETIC_PRIVATE_LOCATION_OUTAGE
  • SYNTHETIC_SLOWDOWN
  • THREADS_RESOURCES_EXHAUSTED
  • UNEXPECTED_HIGH_LOAD
  • UNEXPECTED_LOW_LOAD
  • USER_ACTION_DURATION_DEGRADATION
  • VIRTUAL_MACHINE_SHUTDOWN
  • WEB_CHECK_GLOBAL_OUTAGE
  • WEB_CHECK_LOCAL_OUTAGE

Может быть null.

resourceId string Идентификатор ресурса, на котором произошло событие.

Может быть null.

resourceName string Имя ресурса, на котором произошло событие.

Может быть null.

eventStatus string Состояние мероприятия: открытое или закрытое.

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

  • CLOSED
  • OPEN

Может быть null.

tags TagInfo[] Теги объекта Dynatrace, вызвавшего событие.

Может быть null.

id string Закодированный идентификатор события. Формат — eventID_startTime .

Вы должны использовать значение из этого поля, когда вам нужен идентификатор события.

Может быть null.

Объект _ TagInfo

Тег сущности Dynatrace.

Элемент Тип Описание
context string Происхождение тега, например AWS или Cloud Foundry.

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

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

  • AWS
  • AWS_GENERIC
  • AZURE
  • CLOUD_FOUNDRY
  • CONTEXTLESS
  • ENVIRONMENT
  • GOOGLE_CLOUD
  • KUBERNETES
key string Ключ тега.

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

value string Значение тега.

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

Может быть null.

JSON-модель тела ответа

{
  "nextCursor": "AgEBAAFn5IIFrgEAAAFofwDTrgAAAQAcMTY4N2RhYzViZTAtZmUxODEwOWQ5YTA1MTIyNQ%3D%3D",
  "from": 1521042929000,
  "to": 1521542929000,
  "totalEventCount": 2,
  "events": [
    {
      "startTime": 1521042929000,
      "endTime": 1521542929000,
      "entityId": "HOST-0000000000000007",
      "entityName": "Example Host",
      "severityLevel": "PERFORMANCE",
      "impactLevel": "INFRASTRUCTURE",
      "eventType": "SLOW_DISK",
      "eventStatus": "OPEN",
      "tags": [
        {
          "context": "CONTEXTLESS",
          "key": "exampleTag"
        }
      ],
      "id": "5915682011263205071_1521042929000",
      "source": "builtin"
    },
    {
      "startTime": 1521042929000,
      "endTime": 1521542929000,
      "entityId": "HOST-0000000000000007",
      "entityName": "Example Host",
      "severityLevel": "PERFORMANCE",
      "impactLevel": "INFRASTRUCTURE",
      "eventType": "SLOW_DISK",
      "eventStatus": "OPEN",
      "tags": [
        {
          "context": "CONTEXTLESS",
          "key": "exampleTag"
        }
      ],
      "id": "5915682011263205071_1521042929000",
      "source": "builtin"
    }
  ]
}

Пример

В этом примере запрос запрашивает все события ERROR_EVENT , произошедшие за последние 24 часа . Результат усекается до двух событий.

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

Curl

curl -X GET \
  'https://mySampleEnv.live.dynatrace.com/api/v1/events?eventType=ERROR_EVENT&relativeTime=day' \
  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

URL-адрес запроса

https://mySampleEnv.live.dynatrace.com/api/v1/events?eventType=ERROR_EVENT&relativeTime=day

Содержание ответа

{
  "nextEventStartTms": null,
  "nextEventId": null,
  "nextCursor": null,
  "from": 1530703635653,
  "to": 1533295635653,
  "totalEventCount": 25,
  "events": [
    {
      "eventId": -8338439733889003014,
      "startTime": 1532328338475,
      "endTime": 1532328638475,
      "entityId": "HOST-E4D1E5F46E239F21",
      "entityName": "l-8.dyna.trace",
      "severityLevel": "ERROR",
      "impactLevel": "INFRASTRUCTURE",
      "eventType": "ERROR_EVENT",
      "eventStatus": "CLOSED",
      "tags": [
        {
          "context": "CONTEXTLESS",
          "key": "deploy"
        },
        {
          "context": "CONTEXTLESS",
          "key": "room23"
        }
      ],
      "id": "-8338439733889003014_1532328338475",
      "annotationDescription": "testTrigger",
      "correlationId": "67da0a4293956e55",
      "source": "restTest"
    },
    {
      "eventId": 3092227520312561338,
      "startTime": 1531832640600,
      "endTime": 1531836240600,
      "entityId": "HOST-CE6A2253598EA88D",
      "entityName": "q2.docker.l5",
      "severityLevel": "ERROR",
      "impactLevel": "INFRASTRUCTURE",
      "eventType": "ERROR_EVENT",
      "eventStatus": "CLOSED",
      "tags": [
        {
          "context": "CONTEXTLESS",
          "key": "ServiceNow"
        }
      ],
      "id": "3092227520312561338_1531832640600",
      "customProperties": {
        "Property 2": "value 2",
        "Property 1": "value 1",
        "Property 3": "value 3"
      },
      "annotationDescription": "package is damaged",
      "correlationId": "1b79973c6902b486",
      "source": "myAPI"
    }
  ]
}

Код ответа

200