ENetrebin: Новая страница: «Обновляет конфигурацию обнаружения аномалий для приложений. Запрос потребляет `applicat...»`


2023-03-12T15:41:01Z
Новая страница: «Обновляет конфигурацию обнаружения аномалий для приложений.  Запрос потребляет <code>applicat...»
Новая страница
Обновляет конфигурацию обнаружения аномалий для приложений.



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

{| class="wikitable"

| rowspan="2" |ПОМЕЩАТЬ

|Удалось Ключ-АСТРОМ для правительства

|<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>WriteConfig</code>



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



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

{| class="wikitable"

!Параметр

!Тип

!Описание

!В

!Необходимый

|-

|тело

|Конфигурация обнаружения аномалий приложений

|Тело запроса в формате JSON, содержащее параметры конфигурации обнаружения аномалий приложения.

|тело

|необязательный

|}



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



==== Объект _ <code>ApplicationAnomalyDetectionConfig</code> ====

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

{| class="wikitable"

!Элемент

!Тип

!Описание

!Необходимый

|-

|метаданные

|Метаданные конфигурации

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

|необязательный

|-

|ответВремядеградации

|Конфигурация обнаружения деградации времени отклика

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

|необходимый

|-

|трафикDrop

|Конфигурация обнаружения падения трафика

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

|необходимый

|-

|всплеск трафика

|Конфигурация обнаружения всплесков трафика

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

|необходимый

|-

|отказRateIncrease

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

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

|необходимый

|}



==== Объект _ <code>ConfigurationMetadata</code> ====

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

{| class="wikitable"

!Элемент

!Тип

!Описание

!Необходимый

|-

|конфигурацияВерсии

|целое []

|Отсортированный список номеров версий конфигурации.

|необязательный

|-

|текущие версии конфигурации

|строка []

|Отсортированный список номеров версий конфигурации.

|необязательный

|-

|clusterVersion

|нить

|Версия Дайнатрейс.

|необязательный

|}



==== Объект _ <code>ResponseTimeDegradationDetectionConfig</code> ====

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

{| class="wikitable"

!Элемент

!Тип

!Описание

!Необходимый

|-

|режим обнаружения

|нить

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



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



* <code>DETECT_AUTOMATICALLY</code>

* <code>DETECT_USING_FIXED_THRESHOLDS</code>

* <code>DONT_DETECT</code>

|необходимый

|-

|автоматическое обнаружение

|Конфигурация автоопределения деградации времени отклика

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



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

|необязательный

|-

|пороги

|Конфигурация порога деградации времени отклика

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



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

|необязательный

|}



==== Объект _ <code>ResponseTimeDegradationAutodetectionConfig</code> ====

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



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

{| class="wikitable"

!Элемент

!Тип

!Описание

!Необходимый

|-

|responseTimeDegradationMilliseconds

|целое число

|Предупреждать, если время отклика ухудшится за ''X'' миллисекунд.

|необходимый

|-

|ответтимедеградатионперцент

|целое число

|Предупреждать, если время отклика превышает ''X'' %.

|необходимый

|-

|slowestResponseTimeDegradationMilliseconds

|целое число

|Предупреждать, если время отклика самых медленных 10% ухудшится за ''X'' миллисекунд.

|необходимый

|-

|slowestResponseTimeDegradationPercent

|целое число

|Предупреждать, если время отклика самых медленных 10% ухудшится за ''X'' %.

|необходимый

|-

|Порог нагрузки

|нить

|Минимальная нагрузка на сервис для обнаружения ухудшения времени отклика.



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



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



* <code>FIFTEEN_REQUESTS_PER_MINUTE</code>

* <code>FIVE_REQUESTS_PER_MINUTE</code>

* <code>ONE_REQUEST_PER_MINUTE</code>

* <code>TEN_REQUESTS_PER_MINUTE</code>

|необходимый

|}



==== Объект _ <code>ResponseTimeDegradationThresholdConfig</code> ====

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



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

{| class="wikitable"

!Элемент

!Тип

!Описание

!Необходимый

|-

|responseTimeThresholdMilliseconds

|целое число

|Время отклика в течение любого 5-минутного периода для срабатывания оповещения в миллисекундах.

|необходимый

|-

|slowestResponseTimeThresholdMilliseconds

|целое число

|Время отклика 10 % самых медленных в течение любого 5-минутного периода времени для срабатывания оповещения, в миллисекундах.

|необходимый

|-

|Порог нагрузки

|нить

|Минимальная нагрузка на сервис для обнаружения ухудшения времени отклика.



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



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



* <code>FIFTEEN_REQUESTS_PER_MINUTE</code>

* <code>FIVE_REQUESTS_PER_MINUTE</code>

* <code>ONE_REQUEST_PER_MINUTE</code>

* <code>TEN_REQUESTS_PER_MINUTE</code>

|необходимый

|-

|чувствительность

|нить

|Чувствительность порога.



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



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



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



* <code>HIGH</code>

* <code>LOW</code>

* <code>MEDIUM</code>

|необходимый

|}



==== Объект _ <code>TrafficDropDetectionConfig</code> ====

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

{| class="wikitable"

!Элемент

!Тип

!Описание

!Необходимый

|-

|включено

|логический

|Обнаружение включено ( <code>true</code>) или отключено ( <code>false</code>).

|необходимый

|-

|трафикдропперцент

|целое число

|Оповещение, если наблюдаемый трафик меньше ''X'' % от ожидаемого значения.

|необязательный

|}



==== Объект _ <code>TrafficSpikeDetectionConfig</code> ====

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

{| class="wikitable"

!Элемент

!Тип

!Описание

!Необходимый

|-

|включено

|логический

|Обнаружение включено ( <code>true</code>) или отключено ( <code>false</code>).

|необходимый

|-

|trafficSpikePercent

|целое число

|Оповещение, если наблюдаемый трафик превышает ожидаемое значение более чем на ''X %.''

|необязательный

|}



==== Объект _ <code>FailureRateIncreaseDetectionConfig</code> ====

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

{| class="wikitable"

!Элемент

!Тип

!Описание

!Необходимый

|-

|режим обнаружения

|нить

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



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



* <code>DETECT_AUTOMATICALLY</code>

* <code>DETECT_USING_FIXED_THRESHOLDS</code>

* <code>DONT_DETECT</code>

|необходимый

|-

|автоматическое обнаружение

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

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



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



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

|необязательный

|-

|пороги

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

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



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

|необязательный

|}



==== Объект _ <code>FailureRateIncreaseAutodetectionConfig</code> ====

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



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



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

{| class="wikitable"

!Элемент

!Тип

!Описание

!Необходимый

|-

|фейлингсервицекаллперцентажеинкреасеабсолют

|целое число

|Абсолютный прирост числа неудачных вызовов службы для срабатывания оповещения, %.

|необходимый

|-

|сбойServiceCallPercentageIncreaseRelative

|целое число

|Относительное увеличение числа неудачных вызовов службы для срабатывания оповещения, %.

|необходимый

|}



==== Объект _ <code>FailureRateIncreaseThresholdConfig</code> ====

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



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

{| class="wikitable"

!Элемент

!Тип

!Описание

!Необходимый

|-

|порог

|целое число

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

|необходимый

|-

|чувствительность

|нить

|Чувствительность порога.



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



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



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



* <code>HIGH</code>

* <code>LOW</code>

* <code>MEDIUM</code>

|необходимый

|}



=== JSON-модель тела запроса ===

Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.

 <code>{

   "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"

     }

   }

 }</code>



== Ответ ==



=== Коды ответов ===

{| class="wikitable"

!Код

|Тип

!Описание

|-

|204

|

|Успех. Конфигурация обновлена. Ответ не имеет тела.

|-

|400

|ErrorEnvelope

|Неуспешный. Ввод недействителен

|}



== Проверить полезную нагрузку ==

Мы рекомендуем вам проверить полезную нагрузку перед ее отправкой с фактическим запросом. Код ответа 204 указывает на действительную полезную нагрузку.



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

{| class="wikitable"

| rowspan="2" |POST

|Удалось Ключ-АСТРОМ для правительства

|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/config/v1/anomalyDetection/applications/validator</nowiki></code>

|-

|Окружающая среда ActiveGate

|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/anomalyDetection/applications/validator</nowiki></code>

|}



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

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



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



=== Ответ ===



==== Коды ответов ====

{| class="wikitable"

!Код

|Тип

!Описание

|-

|204

|

|Подтверждено. Представленная конфигурация действительна. Ответ не имеет тела.

|-

|400

|ErrorEnvelope

|Неуспешный. Ввод недействителен

|}



== Пример ==

В этом примере запрос обновляет конфигурацию обнаружения аномалий для приложений из примера запроса GET . Он активирует обнаружение всплесков трафика и устанавливает порог 200 %.



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



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



==== Завиток ====

 <code>curl -X PUT \

   <nowiki>https://mySampleEnv.live.ruscomtech.ru/api/config/v1/anomalyDetection/applications</nowiki> \

   -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \

   -H 'Content-Type: application/json' \

   -d '{

   "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": true,

       "trafficSpikePercent": 200

     },

     "failureRateIncrease": {

       "detectionMode": "DETECT_AUTOMATICALLY",

       "automaticDetection": {

         "failingServiceCallPercentageIncreaseAbsolute": 5,

         "failingServiceCallPercentageIncreaseRelative": 50

       }

     }

 }

 '</code>



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

 <code><nowiki>https://mySampleEnv.live.ruscomtech.ru/api/config/v1/anomalyDetection/applications</nowiki></code>



==== Тело запроса ====

 <code>{

   "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": true,

     "trafficSpikePercent": 200

   },

   "failureRateIncrease": {

     "detectionMode": "DETECT_AUTOMATICALLY",

     "automaticDetection": {

       "failingServiceCallPercentageIncreaseAbsolute": 5,

       "failingServiceCallPercentageIncreaseRelative": 50

     }

   }

 }</code>



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

204



==== Результат ====

Обновленная конфигурация имеет следующие параметры:
API обнаружения аномалий приложений — PUT конфигурация - История изменений

ENetrebin: /* Объект _ ConfigurationMetadata */

ENetrebin: Новая страница: «Обновляет конфигурацию обнаружения аномалий для приложений. Запрос потребляет `applicat...»`

← Предыдущая		Версия 15:41, 12 марта 2023
Строка 87:		Строка 87:
	\|clusterVersion		\|clusterVersion
	\|нить		\|нить
	\|Версия ~~Дайнатрейс~~.		\|Версия Ключ-АСТРОМ.
	\|необязательный		\|необязательный
	\|}		\|}
API обнаружения аномалий приложений — PUT конфигурация - История изменений

ENetrebin: /* Объект _ ConfigurationMetadata */

ENetrebin: Новая страница: «Обновляет конфигурацию обнаружения аномалий для приложений. Запрос потребляет applicat...»

ENetrebin: Новая страница: «Обновляет конфигурацию обнаружения аномалий для приложений. Запрос потребляет `applicat...»`
