Обнаружение аномалий приложения API - PUT конфигурация - История изменений

IKuznetsov в 17:34, 2 января 2025

2025-01-02T17:34:51Z

← Предыдущая версия		Версия от 17:34, 2 января 2025
Строка 1:		Строка 1:
			'''''[[API АппОптима]] / [[API АппОптима\|Эндпойнты конфигурации]] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=%D0%9E%D0%B1%D0%BD%D0%B0%D1%80%D1%83%D0%B6%D0%B5%D0%BD%D0%B8%D0%B5%20%D0%B0%D0%BD%D0%BE%D0%BC%D0%B0%D0%BB%D0%B8%D0%B9 Обнаружение аномалий] / [[Обнаружение аномалий API - Приложения\|Приложение]] / PUT конфигурация'''''

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

IKuznetsov в 16:00, 26 декабря 2024

2024-12-26T16:00:42Z

← Предыдущая версия		Версия от 16:00, 26 декабря 2024
Строка 85:		Строка 85:
	\|clusterVersion		\|clusterVersion
	\|string		\|string
	\|Версия ~~Ключ-АСТРОМ~~.		\|Версия АппОптима.
	\|по желанию		\|по желанию
	\|}		\|}
Строка 373:		Строка 373:
	}		}
	}		}
	}~~</code>~~		}

	== Ответ ==		== Ответ ==
Строка 464:		Строка 464:
	}		}
	}		}
	'~~</code>~~		'

	==== URL-адрес запроса ====		==== URL-адрес запроса ====
Строка 496:		Строка 496:
	}		}
	}		}
	}~~</code>~~		}

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

IKuznetsov в 09:14, 26 декабря 2024

2024-12-26T09:14:40Z

← Предыдущая версия		Версия от 09:14, 26 декабря 2024
Строка 4:		Строка 4:
	{\| class="wikitable"		{\| class="wikitable"
	\| rowspan="2" \|PUT		\| rowspan="2" \|PUT
	\|~~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>
	\|-		\|-
Строка 348:		Строка 348:
	=== JSON-модель тела запроса ===		=== JSON-модель тела запроса ===
	Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.		Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
	<~~code>~~{		<{
	"responseTimeDegradation": {		"responseTimeDegradation": {
	"detectionMode": "DETECT_AUTOMATICALLY",		"detectionMode": "DETECT_AUTOMATICALLY",
Строка 398:		Строка 398:
	{\| class="wikitable"		{\| class="wikitable"
	\| rowspan="2" \|POST		\| rowspan="2" \|POST
	\|~~Managed~~		\|АппОптима
	\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/config/v1/anomalyDetection/applications/validator</nowiki></code>		\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/config/v1/anomalyDetection/applications/validator</nowiki></code>
	\|-		\|-
Строка 433:		Строка 433:

	==== Curl ====		==== Curl ====
	<~~code>~~curl -X PUT \		<curl -X PUT \
	<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/config/v1/anomalyDetection/applications</nowiki> \		<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/config/v1/anomalyDetection/applications</nowiki> \
	-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \		-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
Строка 470:		Строка 470:

	==== Тело запроса ====		==== Тело запроса ====
	<~~code>~~{		<{
	"responseTimeDegradation": {		"responseTimeDegradation": {
	"detectionMode": "DETECT_AUTOMATICALLY",		"detectionMode": "DETECT_AUTOMATICALLY",

ENetrebin в 16:21, 22 июля 2024

2024-07-22T16:21:28Z

← Предыдущая версия		Версия от 16:21, 22 июля 2024
Строка 7:		Строка 7:
	\|<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>
	\|}		\|}

ENetrebin: /* Проверка полезную нагрузку */

2022-10-27T12:40:46Z

Проверка полезную нагрузку

← Предыдущая версия		Версия от 12:40, 27 октября 2022
Строка 401:		Строка 401:
	\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/config/v1/anomalyDetection/applications/validator</nowiki></code>		\|<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><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/anomalyDetection/applications/validator</nowiki></code>
	\|}		\|}

ENetrebin: /* Результат */

2022-10-27T12:40:10Z

Результат

← Предыдущая версия		Версия от 12:40, 27 октября 2022
Строка 500:		Строка 500:
	==== Код ответа ====		==== Код ответа ====
	204		204

	~~==== Результат ====~~
	~~Обновленная конфигурация имеет следующие параметры:~~

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

2022-10-27T12:38:04Z

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

Новая страница

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

Запрос использует в качестве полезной нагрузки <code>application/json</code> формат.
{| class="wikitable"
| rowspan="2" |PUT
|Managed
|<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>) . Чтобы узнать, как его получить и использовать, см. раздел [[Токены и аутентификация (API)|Токены и аутентификация]] .

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

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

==== Объект <code>ApplicationAnomalyDetectionConfig</code> ====
Настройка обнаружения аномалий для приложений.
{| class="wikitable"
!Элемент
!Тип
!Описание
!Необходимость
|-
|metadata
|ConfigurationMetadata
|Метаданные, полезные для отладки
|по желанию
|-
|responseTimeDegradation
|ResponseTimeDegradationDetectionConfig
|Настройка обнаружения ухудшения времени отклика.
|требуется
|-
|trafficDrop
|TrafficDropDetectionConfig
|Настройка обнаружения падения трафика.
|требуется
|-
|trafficSpike
|TrafficSpikeDetectionConfig
|Настройка обнаружения всплесков трафика.
|требуется
|-
|failureRateIncrease
|FailureRateIncreaseDetectionConfig
|Конфигурация обнаружения увеличения частоты отказов.
|требуется
|}

==== Объект <code>ConfigurationMetadata</code> ====
Метаданные, полезные для отладки
{| class="wikitable"
!Элемент
!Тип
!Описание
!Необходимость
|-
|configurationVersions
|integer[]
|Отсортированный список номеров версий конфигурации.
|по желанию
|-
|currentConfigurationVersions
|string[]
|Отсортированный список номеров версий конфигурации.
|по желанию
|-
|clusterVersion
|string
|Версия Ключ-АСТРОМ.
|по желанию
|}

==== Объект <code>ResponseTimeDegradationDetectionConfig</code> ====
Настройка обнаружения ухудшения времени отклика.
{| class="wikitable"
!Элемент
!Тип
!Описание
!Необходимость
|-
|detectionMode
|string
|Как обнаружить ухудшение времени отклика: автоматически, или на основе фиксированных порогов, или не обнаруживать.

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

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

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

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

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

Нарушение любого критерия вызывает предупреждение.
{| class="wikitable"
!Элемент
!Тип
!Описание
!Необходимость
|-
|responseTimeDegradationMilliseconds
|integer
|Предупреждает, если время отклика ухудшится за ''X'' миллисекунд.
|требуется
|-
|responseTimeDegradationPercent
|integer
|Предупреждает, если время отклика превышает ''X'' %.
|требуется
|-
|slowestResponseTimeDegradationMilliseconds
|integer
|Предупреждает, если время отклика самых медленных 10% ухудшится за ''X'' миллисекунд.
|требуется
|-
|slowestResponseTimeDegradationPercent
|integer
|Предупреждает, если время отклика самых медленных 10% ухудшится за ''X'' %.
|требуется
|-
|loadThreshold
|string
|Минимальная нагрузка на сервис для обнаружения ухудшения времени отклика.

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

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

* <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
|integer
|Время отклика в течение любого 5-минутного периода для срабатывания оповещения в миллисекундах.
|требуется
|-
|slowestResponseTimeThresholdMilliseconds
|integer
|Время отклика 10 % самых медленных в течение любого 5-минутного периода времени для срабатывания оповещения, в миллисекундах.
|требуется
|-
|loadThreshold
|string
|Минимальная нагрузка на сервис для обнаружения ухудшения времени отклика.

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

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

* <code>FIFTEEN_REQUESTS_PER_MINUTE</code>
* <code>FIVE_REQUESTS_PER_MINUTE</code>
* <code>ONE_REQUEST_PER_MINUTE</code>
* <code>TEN_REQUESTS_PER_MINUTE</code>
|требуется
|-
|sensitivity
|string
|Чувствительность порога.

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

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

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

* <code>HIGH</code>
* <code>LOW</code>
* <code>MEDIUM</code>
|требуется
|}

==== Объект <code>TrafficDropDetectionConfig</code> ====
Настройка обнаружения падения трафика.
{| class="wikitable"
!Элемент
!Тип
!Описание
!Необходимость
|-
|enabled
|boolean
|Обнаружение включено ( <code>true</code>) или отключено ( <code>false</code>).
|требуется
|-
|trafficDropPercent
|integer
|Оповещение, если наблюдаемый трафик меньше ''X'' % от ожидаемого значения.
|по желанию
|}

==== Объект <code>TrafficSpikeDetectionConfig</code> ====
Настройка обнаружения всплесков трафика.
{| class="wikitable"
!Элемент
!Тип
!Описание
!Необходимость
|-
|enabled
|boolean
|Обнаружение включено ( <code>true</code>) или отключено ( <code>false</code>).
|требуется
|-
|trafficSpikePercent
|integer
|Оповещение, если наблюдаемый трафик превышает ожидаемое значение более чем на ''X %.''
|по желанию
|}

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

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

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

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

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

Требуется, если режим обнаружения равен <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"
!Элемент
!Тип
!Описание
!Необходимость
|-
|failingServiceCallPercentageIncreaseAbsolute
|integer
|Абсолютный прирост числа неудачных вызовов службы для срабатывания оповещения, %.
|требуется
|-
|failingServiceCallPercentageIncreaseRelative
|integer
|Относительное увеличение числа неудачных вызовов службы для срабатывания оповещения, %.
|требуется
|}

==== Объект <code>FailureRateIncreaseThresholdConfig</code> ====
Фиксированные пороги для обнаружения увеличения частоты отказов.

Требуется, если режим обнаружения равен <code>DETECT_USING_FIXED_THRESHOLDS</code>. В противном случае неприменимо.
{| class="wikitable"
!Элемент
!Тип
!Описание
!Необходимость
|-
|threshold
|integer
|Частота отказов в течение любого 5-минутного периода для срабатывания оповещения, %.
|требуется
|-
|sensitivity
|string
|Чувствительность порога.

При <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
|Managed
|<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>) . Чтобы узнать, как его получить и использовать, см. раздел [[Токены и аутентификация (API)|Токены и аутентификация]] .

=== Ответ ===

==== Коды ответов ====
{| class="wikitable"
!Код
|Тип
!Описание
|-
|204
|
|Подтверждено. Представленная конфигурация действительна. Ответ не имеет тела.
|-
|400
|ErrorEnvelope
|Не удалось. Ввод недействителен
|}

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

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

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

==== Curl ====
<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

==== Результат ====
Обновленная конфигурация имеет следующие параметры: