API обнаружения аномалий приложений — GET конфигурация: различия между версиями

Материал из Документация Ключ-АСТРОМ
(Новая страница: «Получает конфигурацию обнаружения аномалий для приложений. Запрос создает <code>application/json...»)
 
 
(не показана 1 промежуточная версия этого же участника)
Строка 4: Строка 4:
{| class="wikitable"
{| class="wikitable"
| rowspan="2" |GET
| rowspan="2" |GET
|УдалосьКлюч-АСТРОМ для правительства
|Ключ-АСТРОМ Managed для управления
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/config/v1/anomalyDetection/applications</nowiki></code>
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/config/v1/anomalyDetection/applications</nowiki></code>
|-
|-
|Окружающая среда ActiveGate
|Среда АктивногоШлюза
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/anomalyDetection/applications</nowiki></code>
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/anomalyDetection/applications</nowiki></code>
|}
|}
Строка 14: Строка 14:
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия. <code>ReadConfig</code>
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия. <code>ReadConfig</code>


Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Чтобы узнать, как его получить и использовать, см. раздел [[Токены и аутентификация (API)|Токены и аутентификация]] .


== Параметры ==
== Параметры ==

Текущая версия на 17:26, 13 марта 2023

Получает конфигурацию обнаружения аномалий для приложений.

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

GET Ключ-АСТРОМ Managed для управления https://{your-domain}/e/{your-environment-id}/api/config/v1/anomalyDetection/applications
Среда АктивногоШлюза https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/anomalyDetection/applications

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

Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия. ReadConfig

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

Параметры

Запрос не предоставляет никаких настраиваемых параметров.

Ответ

Коды ответов

Код Тип Описание
200 Конфигурация обнаружения аномалий приложений Успех

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

Объект _ ApplicationAnomalyDetectionConfig

Настройка обнаружения аномалий для приложений.

Элемент Тип Описание
метаданные Метаданные конфигурации Метаданные, полезные для отладки
ответВремядеградации Конфигурация обнаружения деградации времени отклика Настройка обнаружения ухудшения времени отклика.
трафикDrop Конфигурация обнаружения падения трафика Настройка обнаружения падения трафика.
всплеск трафика Конфигурация обнаружения всплесков трафика Настройка обнаружения всплесков трафика.
отказRateIncrease Конфигурация обнаружения увеличения частоты отказов Конфигурация обнаружения увеличения частоты отказов.

Объект _ ConfigurationMetadata

Метаданные, полезные для отладки

Элемент Тип Описание
конфигурацияВерсии целое [] Отсортированный список номеров версий конфигурации.
текущие версии конфигурации строка [] Отсортированный список номеров версий конфигурации.
clusterVersion нить Версия Дайнатрейс.

Объект _ ResponseTimeDegradationDetectionConfig

Настройка обнаружения ухудшения времени отклика.

Элемент Тип Описание
режим обнаружения нить Как обнаружить ухудшение времени отклика: автоматически, или на основе фиксированных порогов, или не обнаруживать.

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

  • DETECT_AUTOMATICALLY
  • DETECT_USING_FIXED_THRESHOLDS
  • DONT_DETECT
автоматическое обнаружение Конфигурация автоопределения деградации времени отклика Параметры автоматического определения деградации времени отклика. Требуется, если для параметра discoveryMode установлено значение DETECT_AUTOMATICALLY. В противном случае неприменимо.

Нарушение любого критерия вызывает предупреждение.

пороги Конфигурация порога деградации времени отклика Фиксированные пороги для обнаружения ухудшения времени отклика.

Требуется, если режим обнаружения равен DETECT_USING_FIXED_THRESHOLDS. В противном случае неприменимо.

Объект _ ResponseTimeDegradationAutodetectionConfig

Параметры автоматического определения деградации времени отклика. Требуется, если для параметра discoveryMode установлено значение DETECT_AUTOMATICALLY. В противном случае неприменимо.

Нарушение любого критерия вызывает предупреждение.

Элемент Тип Описание
responseTimeDegradationMilliseconds целое число Предупреждать, если время отклика ухудшится за X миллисекунд.
ответтимедеградатионперцент целое число Предупреждать, если время отклика превышает X %.
slowestResponseTimeDegradationMilliseconds целое число Предупреждать, если время отклика самых медленных 10% ухудшится за X миллисекунд.
slowestResponseTimeDegradationPercent целое число Предупреждать, если время отклика самых медленных 10% ухудшится за X %.
Порог нагрузки нить Минимальная нагрузка на сервис для обнаружения ухудшения времени отклика.

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

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

  • FIFTEEN_REQUESTS_PER_MINUTE
  • FIVE_REQUESTS_PER_MINUTE
  • ONE_REQUEST_PER_MINUTE
  • TEN_REQUESTS_PER_MINUTE

Объект _ ResponseTimeDegradationThresholdConfig

Фиксированные пороги для обнаружения ухудшения времени отклика.

Требуется, если режим обнаружения равен DETECT_USING_FIXED_THRESHOLDS. В противном случае неприменимо.

Элемент Тип Описание
responseTimeThresholdMilliseconds целое число Время отклика в течение любого 5-минутного периода для срабатывания оповещения в миллисекундах.
slowestResponseTimeThresholdMilliseconds целое число Время отклика 10 % самых медленных в течение любого 5-минутного периода времени для срабатывания оповещения, в миллисекундах.
Порог нагрузки нить Минимальная нагрузка на сервис для обнаружения ухудшения времени отклика.

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

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

  • FIFTEEN_REQUESTS_PER_MINUTE
  • FIVE_REQUESTS_PER_MINUTE
  • ONE_REQUEST_PER_MINUTE
  • TEN_REQUESTS_PER_MINUTE
чувствительность нить Чувствительность порога.

При lowчувствительности используется высокая статистическая достоверность. Кратковременные нарушения (например, из-за резкого скачка нагрузки) не вызывают оповещения.

В случае highчувствительности статистическая достоверность не используется. Каждое нарушение вызывает оповещение.

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

  • HIGH
  • LOW
  • MEDIUM

Объект _ TrafficDropDetectionConfig

Настройка обнаружения падения трафика.

Элемент Тип Описание
включено логический Обнаружение включено ( true) или отключено ( false).
трафикдропперцент целое число Оповещение, если наблюдаемый трафик меньше X % от ожидаемого значения.

Объект _ TrafficSpikeDetectionConfig

Настройка обнаружения всплесков трафика.

Элемент Тип Описание
включено логический Обнаружение включено ( true) или отключено ( false).
trafficSpikePercent целое число Оповещение, если наблюдаемый трафик превышает ожидаемое значение более чем на X %.

Объект _ FailureRateIncreaseDetectionConfig

Конфигурация обнаружения увеличения частоты отказов.

Элемент Тип Описание
режим обнаружения нить Как обнаружить увеличение частоты отказов: автоматически, или на основе фиксированных порогов, или не обнаруживать.

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

  • DETECT_AUTOMATICALLY
  • DETECT_USING_FIXED_THRESHOLDS
  • DONT_DETECT
автоматическое обнаружение Конфигурация автообнаружения увеличения частоты отказов Параметры автообнаружения увеличивают частоту отказов. Требуется, если режим обнаружения равен DETECT_AUTOMATICALLY. В противном случае неприменимо.

Абсолютный и относительный пороги должны быть превышены, чтобы сработало оповещение.

Пример: если ожидаемая частота ошибок составляет 1,5 %, и вы установили абсолютное увеличение на 1 % и относительное увеличение на 50 %, пороговые значения будут следующими: Абсолютный: 1,5 % + 1 % = 2,5 % Относительный: 1,5 % + 1,5 % * 50% = 2,25%

пороги Конфигурация порога увеличения частоты отказов Фиксированные пороги для обнаружения увеличения частоты отказов.

Требуется, если режим обнаружения равен DETECT_USING_FIXED_THRESHOLDS. В противном случае неприменимо.

Объект _ FailureRateIncreaseAutodetectionConfig

Параметры автообнаружения увеличивают частоту отказов. Требуется, если режим обнаружения равен DETECT_AUTOMATICALLY. В противном случае неприменимо.

Абсолютный и относительный пороги должны быть превышены, чтобы сработало оповещение.

Пример: если ожидаемая частота ошибок составляет 1,5 %, и вы установили абсолютное увеличение на 1 % и относительное увеличение на 50 %, пороговые значения будут следующими: Абсолютный: 1,5 % + 1 % = 2,5 % Относительный: 1,5 % + 1,5 % * 50% = 2,25%

Элемент Тип Описание
фейлингсервицекаллперцентажеинкреасеабсолют целое число Абсолютный прирост числа неудачных вызовов службы для срабатывания оповещения, %.
сбойServiceCallPercentageIncreaseRelative целое число Относительное увеличение числа неудачных вызовов службы для срабатывания оповещения, %.

Объект _ FailureRateIncreaseThresholdConfig

Фиксированные пороги для обнаружения увеличения частоты отказов.

Требуется, если режим обнаружения равен DETECT_USING_FIXED_THRESHOLDS. В противном случае неприменимо.

Элемент Тип Описание
порог целое число Частота отказов в течение любого 5-минутного периода для срабатывания оповещения, %.
чувствительность нить Чувствительность порога.

При lowчувствительности используется высокая статистическая достоверность. Кратковременные нарушения (например, из-за резкого скачка нагрузки) не вызывают оповещения.

В случае highчувствительности статистическая достоверность не используется. Каждое нарушение вызывает оповещение.

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

  • HIGH
  • LOW
  • MEDIUM

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

{
  "responseTimeDegradation": {
    "detectionMode": "DETECT_AUTOMATICALLY",
    "automaticDetection": {
      "responseTimeDegradationMilliseconds": 250,
      "responseTimeDegradationPercent": 90,
      "slowestResponseTimeDegradationMilliseconds": 500,
      "slowestResponseTimeDegradationPercent": 200,
      "loadThreshold": "ONE_REQUEST_PER_MINUTE"
    }
  },
  "trafficDrop": {
    "enabled": true,
    "trafficDropPercent": 95
  },
  "trafficSpike": {
    "enabled": false
  },
  "failureRateIncrease": {
    "detectionMode": "DETECT_USING_FIXED_THRESHOLDS",
    "thresholds": {
      "threshold": 10,
      "sensitivity": "LOW"
    }
  }
}

Пример

В этом примере запрос перечисляет текущую конфигурацию обнаружения аномалий для приложений.

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

Конфигурация имеет следующие настройки:

Завиток

curl -X GET \
  https://mySampleEnv.live.ruscomtech.ru/api/config/v1/anomalyDetection/applications \
  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

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

https://mySampleEnv.live.ruscomtech.ru/api/config/v1/anomalyDetection/applications

Тело ответа

{
  "metadata": {
    "clusterVersion": "1.163.0.20190130-210004",
    "configurationVersions": [
      2
    ]
  },
  "responseTimeDegradation": {
    "detectionMode": "DETECT_AUTOMATICALLY",
    "automaticDetection": {
      "responseTimeDegradationMilliseconds": 100,
      "responseTimeDegradationPercent": 50,
      "slowestResponseTimeDegradationMilliseconds": 1000,
      "slowestResponseTimeDegradationPercent": 10,
      "loadThreshold": "TEN_REQUESTS_PER_MINUTE"
    }
  },
  "trafficDrop": {
    "enabled": true,
    "trafficDropPercent": 50
  },
  "trafficSpike": {
    "enabled": false
  },
  "failureRateIncrease": {
    "detectionMode": "DETECT_AUTOMATICALLY",
    "automaticDetection": {
      "failingServiceCallPercentageIncreaseAbsolute": 5,
      "failingServiceCallPercentageIncreaseRelative": 50
    }
  }
}

Код ответа

200

Источник — https://doc.ruscomtech.ru/index.php?title=API_обнаружения_аномалий_приложений_—_GET_конфигурация&oldid=2589