Обнаружение аномалий событий метрик API - JSON модель

Материал из Документация Ключ-АСТРОМ

Некоторые модели JSON API обнаружения аномалий событий метрики различаются в зависимости от filterType некоторых объектов. Здесь вы можете найти модели JSON для каждого варианта.

Вариации MetricEventAlertingScopeобъекта

Объект MetricEventAlertingScopeявляется основой для оповещения областей событий метрики. Фактический набор полей зависит от filterType области.

CUSTOM_DEVICE_GROUP_NAME

CustomDeviceGroupNameAlertingScope

Параметры:

Объект CustomDeviceGroupNameAlertingScope

Единый фильтр для области оповещения.

Фактический набор полей зависит от типа фильтра. Найдите список актуальных объектов в описании поля filterType или см. Обнаружение аномалий событий метрик API — JSON модель.

Элемент Тип Описание
nameFilter MetricEventTextFilterMetricEventTextFilterOperatorDto Фильтр строкового значения на основе заданного оператора.

Объект MetricEventTextFilterMetricEventTextFilterOperatorDto

Фильтр строкового значения на основе заданного оператора.

Элемент Тип Описание
value string Значение для сопоставления.
operator string Оператор для сопоставления.

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

  • CONTAINS_CASE_INSENSITIVE
  • CONTAINS_CASE_SENSITIVE
  • EQUALS

JSON модель 

{
  "filterType": "CUSTOM_DEVICE_GROUP_NAME",
  "nameFilter": {
    "value": "entity name",
    "operator": "CONTAINS_CASE_INSENSITIVE"
  }
}

ENTITY_ID

EntityIdAlertingScope

Параметры

Объект EntityIdAlertingScope

Фактический набор полей зависит от типа фильтра. Найдите список актуальных объектов в описании поля filterType или см. Обнаружение аномалий событий метрик API — JSON модель.

Элемент Тип Описание
entityId string Идентификатор отслеживаемых объектов для сопоставления.

JSON модель 

{
  "filterType": "ENTITY_ID",
  "entityId": "HOST-B7A6F9EE9F366CB5"
}

HOST_NAME

HostNameAlertingScope

Параметры

Объект HostNameAlertingScope

Единый фильтр для области оповещения.

Фактический набор полей зависит от типа фильтра. Найдите список актуальных объектов в описании поля filterType или см. Обнаружение аномалий событий метрик API — JSON модель .

Элемент Тип Описание
nameFilter MetricEventTextFilterMetricEventTextFilterOperatorDto Фильтр строкового значения на основе заданного оператора.

JSON модель 

{
  "filterType": "HOST_NAME",
  "nameFilter": {
    "value": "entity name",
    "operator": "CONTAINS_CASE_INSENSITIVE"
  }
}

HOST_GROUP_NAME

HostGroupNameAlertingScope

Параметры

Объект HostGroupNameAlertingScope

Единый фильтр для области оповещения.

Фактический набор полей зависит от типа фильтра. Найдите список актуальных объектов в описании поля filterType или см. Обнаружение аномалий событий метрик API — JSON модель .

Элемент Тип Описание
nameFilter MetricEventTextFilterMetricEventTextFilterOperatorDto Фильтр строкового значения на основе заданного оператора.

Объект MetricEventTextFilterMetricEventTextFilterOperatorDto

Фильтр строкового значения на основе заданного оператора.

Элемент Тип Описание
value string Значение для сопоставления.
operator string Оператор для сопоставления.

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

  • CONTAINS_CASE_INSENSITIVE
  • CONTAINS_CASE_SENSITIVE
  • EQUALS

JSON модель 

{
  "filterType": "HOST_GROUP_NAME",
  "nameFilter": {
    "value": "entity name",
    "operator": "CONTAINS_CASE_INSENSITIVE"
  }
}

MANAGEMENT_ZONE

ManagementZoneAlertingScope

Параметры

Объект ManagementZoneAlertingScope

Единый фильтр для области оповещения.

Фактический набор полей зависит от типа фильтра. Найдите список актуальных объектов в описании поля filterType или см. Обнаружение аномалий событий метрик API — JSON модель .

Элемент Тип Описание
mzId string Идентификатор зоны управления для сопоставления.

JSON модель 

{
  "filterType": "MANAGEMENT_ZONE",
  "mzId": "6958644387494623526"
}

NAME

NameAlertingScope

Параметры

Объект NameAlertingScope

Единый фильтр для области оповещения.

Фактический набор полей зависит от типа фильтра. Найдите список актуальных объектов в описании поля filterType или см. Обнаружение аномалий событий метрик API — JSON модель .

Элемент Тип Описание
nameFilter MetricEventTextFilterMetricEventTextFilterOperatorDto Фильтр строкового значения на основе заданного оператора.

Объект MetricEventTextFilterMetricEventTextFilterOperatorDto

Фильтр строкового значения на основе заданного оператора.

Элемент Тип Описание
value string Значение для сопоставления.
operator string Оператор для сопоставления.

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

  • CONTAINS_CASE_INSENSITIVE
  • CONTAINS_CASE_SENSITIVE
  • EQUALS

JSON модель 

{
  "filterType": "NAME",
  "nameFilter": {
    "value": "entity name",
    "operator": "CONTAINS_CASE_INSENSITIVE"
  }
}

PROCESS_GROUP_ID

ProcessGroupIdAlertingScope

Параметры

Объект ProcessGroupIdAlertingScope

Единый фильтр для области оповещения.

Фактический набор полей зависит от типа фильтра. Найдите список актуальных объектов в описании поля filterType или см. Обнаружение аномалий событий метрик API — JSON модель .

Элемент Тип Описание
processGroupId string Идентификатор группы процессов для сопоставления.

JSON модель 

{
  "filterType": "PROCESS_GROUP_ID",
  "processGroupId": "PROCESS_GROUP-B34081EFF9E5F516"
}

PROCESS_GROUP_NAME

ProcessGroupNameAlertingScope

Параметры

Объект ProcessGroupNameAlertingScope

Единый фильтр для области оповещения.

Фактический набор полей зависит от типа фильтра. Найдите список актуальных объектов в описании поля filterType или см. Обнаружение аномалий событий метрик API — JSON модель .

Элемент Тип Описание
nameFilter MetricEventTextFilterMetricEventTextFilterOperatorDto Фильтр строкового значения на основе заданного оператора.

Объект MetricEventTextFilterMetricEventTextFilterOperatorDto

Фильтр строкового значения на основе заданного оператора.

Элемент Тип Описание
value string Значение для сопоставления.
operetor string Оператор для сопоставления.

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

  • CONTAINS_CASE_INSENSITIVE
  • CONTAINS_CASE_SENSITIVE
  • EQUALS

JSON модель 

{
  "filterType": "PROCESS_GROUP_NAME",
  "nameFilter": {
    "value": "entity name",
    "operator": "CONTAINS_CASE_INSENSITIVE"
  }
}

TAG

TagFilterAlertingScope

Параметры

Объект TagFilterAlertingScope

Единый фильтр для области оповещения.

Фактический набор полей зависит от типа фильтра. Найдите список актуальных объектов в описании поля filterType или см. Обнаружение аномалий событий метрик API — JSON модель .

Элемент Тип Описание
tagFilter TagFilter Фильтр контролируемых объектов на основе тегов.

Объект TagFilter

Фильтр контролируемых объектов на основе тегов.

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

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

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

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

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

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

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

JSON модель 

{
  "filterType": "TAG",
  "tagFilter": {
    "context": "CONTEXTLESS",
    "key": "Infrastructure",
    "value": "Linux"
  }
}

Вариации MetricEventDimensionsобъекта

Объект MetricEventDimensionsявляется базой для метрических измерений. Фактический набор полей зависит от filterType измерения.

ENTITY

MetricEventEntityDimensions

Параметры

Объект MetricEventEntityDimensions

Единый фильтр для измерений показателей.

Фактический набор полей зависит от типа фильтра. Найдите список актуальных объектов в описании поля filterType или см. Обнаружение аномалий событий метрик API — JSON модель .

Элемент Тип Описание
nameFilter MetricEventTextFilterMetricEventDimensionsFilterOperatorDto Фильтр строкового значения на основе заданного оператора.

Объект MetricEventTextFilterMetricEventDimensionsFilterOperatorDto

Фильтр строкового значения на основе заданного оператора.

Элемент Тип Описание
value string Значение для сопоставления.
operator string Оператор для сопоставления.

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

  • EQUALS

JSON модель 

{
  "filterType": "ENTITY",
  "name": "dimension",
  "index": 1,
  "nameFilter": {
    "value": "entity name",
    "operator": "EQUALS"
  }
}

STRING

MetricEventStringDimensions

Параметры

Объект MetricEventStringDimensions

Единый фильтр для измерений показателей.

Фактический набор полей зависит от типа фильтра. Найдите список актуальных объектов в описании поля filterType или см. Обнаружение аномалий событий метрик API — JSON модель .

Элемент Тип Описание
textFilter MetricEventTextFilterMetricEventDimensionsFilterOperatorDto Фильтр строкового значения на основе заданного оператора.

Объект MetricEventTextFilterMetricEventDimensionsFilterOperatorDto

Фильтр строкового значения на основе заданного оператора.

Элемент Тип Описание
value string Значение для сопоставления.
operator string Оператор для сопоставления.

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

  • EQUALS

JSON модель 

{
  "filterType": "STRING",
  "name": "dimension",
  "index": 1,
  "nameFilter": {
    "value": "entity name",
    "operator": "EQUALS"
  }
}

Вариации MetricEventMonitoringStrategyобъекта

Объект MetricEventMonitoringStrategyявляется базой для стратегии мониторинга события метрики. Фактический набор полей зависит от типа стратегии.

AUTO_ADAPTIVE_BASELINE

MetricEventAutoAdaptiveBaselineMonitoringStrategy

Параметры

Объект MetricEventAutoAdaptiveBaselineMonitoringStrategy

Стратегия мониторинга для конфигурации события метрики.

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

Элемент Тип Описание
samples integer Количество одноминутных выборок, формирующих скользящее окно оценки.
violatingSamples integer Количество одноминутных выборок в окне оценки, которые должны нарушить пороговое значение, чтобы инициировать событие.
dealertingSamples integer Количество одноминутных выборок в окне оценки, которое должно вернуться к нормальному состоянию, чтобы закрыть событие.
alertCondition string Условие проверки порогового значения: выше или ниже.

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

  • ABOVE
  • BELOW
alertingOnMissingData boolean Если true, также одноминутные выборки без данных считаются нарушающими выборками.
numberOfSignalFluctuations number Определяет коэффициент допустимого количества колебаний сигнала. Значения выше базового уровня плюс флуктуация сигнала, умноженная на число допустимых флуктуаций сигнала, вызывают предупреждение.

JSON модель 

{
  "type": "AUTO_ADAPTIVE_BASELINE",
  "samples": 5,
  "violatingSamples": 3,
  "dealertingSamples": 5,
  "alertCondition": "ABOVE",
  "alertingOnMissingData": false,
  "numberOfSignalFluctuations": 1.0
}

STATIC_THRESHOLD

MetricEventStaticThresholdMonitoringStrategy

Параметры

Объект MetricEventStaticThresholdMonitoringStrategy

Стратегия мониторинга для конфигурации события метрики.

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

Элемент Тип Описание
samples integer Количество одноминутных выборок, формирующих скользящее окно оценки.
violatingSamples integer Количество одноминутных выборок в окне оценки, которые должны нарушить пороговое значение, чтобы инициировать событие.
dealertingSamples integer Количество одноминутных выборок в окне оценки, которое должно вернуться к нормальному состоянию, чтобы закрыть событие.
alertCondition string Условие проверки порогового значения: выше или ниже.

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

  • ABOVE
  • BELOW
alertingOnMissingData boolean Если true, также одноминутные выборки без данных считаются нарушающими выборками.
threshold number Значение статического порога на основе указанной единицы.
unit string Единица порога, соответствующая определению метрики.

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

  • BILLION
  • BIT
  • BIT_PER_HOUR
  • BIT_PER_MINUTE
  • BIT_PER_SECOND
  • BYTE
  • BYTE_PER_HOUR
  • BYTE_PER_MINUTE
  • BYTE_PER_SECOND
  • CORES
  • COUNT
  • DAY
  • DECIBEL_MILLI_WATT
  • GIBI_BYTE
  • GIGA
  • GIGA_BYTE
  • HOUR
  • KIBI_BYTE
  • KIBI_BYTE_PER_HOUR
  • KIBI_BYTE_PER_MINUTE
  • KIBI_BYTE_PER_SECOND
  • KILO
  • KILO_BYTE
  • KILO_BYTE_PER_HOUR
  • KILO_BYTE_PER_MINUTE
  • KILO_BYTE_PER_SECOND
  • KILO_METRE_PER_HOUR
  • MEBI_BYTE
  • MEBI_BYTE_PER_HOUR
  • MEBI_BYTE_PER_MINUTE
  • MEBI_BYTE_PER_SECOND
  • MEGA
  • MEGA_BYTE
  • MEGA_BYTE_PER_HOUR
  • MEGA_BYTE_PER_MINUTE
  • MEGA_BYTE_PER_SECOND
  • METRE_PER_HOUR
  • METRE_PER_SECOND
  • MICRO_SECOND
  • MILLION
  • MILLI_CORES
  • MILLI_SECOND
  • MILLI_SECOND_PER_MINUTE
  • MINUTE
  • MONTH
  • MSU
  • NANO_SECOND
  • NANO_SECOND_PER_MINUTE
  • NOT_APPLICABLE
  • PERCENT
  • PER_HOUR
  • PER_MINUTE
  • PER_SECOND
  • PIXEL
  • PROMILLE
  • RATIO
  • SECOND
  • STATE
  • UNSPECIFIED
  • WEEK
  • YEAR

JSON модель 

{
  "type": "STATIC_THRESHOLD",
  "samples": 3,
  "violatingSamples": 1,
  "dealertingSamples": 3,
  "alertCondition": "BELOW",
  "alertingOnMissingData": false,
  "threshold": 99,
  "unit": "COUNT"
    }
Источник — https://doc.ruscomtech.ru/index.php?title=Обнаружение_аномалий_событий_метрик_API_-_JSON_модель&oldid=2008