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

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

2025-01-02T17:48:14Z

← Предыдущая версия		Версия от 17:48, 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 обнаружения аномалий - Службы\|Службы]] / GET конфигурация'''''

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

Строка 350:		Строка 352:
	}		}
	}		}
	}~~</code>~~		}

	== Пример ==		== Пример ==
Строка 364:		Строка 366:
	<curl -X GET \		<curl -X GET \
	<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/config/v1/anomalyDetection/services</nowiki> \		<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/config/v1/anomalyDetection/services</nowiki> \
	-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'~~</code>~~		-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

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

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

IKuznetsov в 10:32, 26 декабря 2024

2024-12-26T10:32:23Z

← Предыдущая версия		Версия от 10:32, 26 декабря 2024
Строка 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/services</nowiki></code>		\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/config/v1/anomalyDetection/services</nowiki></code>
	\|-		\|-
Строка 35:		Строка 35:

	==== Объект <code>ServiceAnomalyDetectionConfig</code> ====		==== Объект <code>ServiceAnomalyDetectionConfig</code> ====
	~~Ключ-АСТРОМ~~ автоматически обнаруживает аномалии производительности, связанные с обслуживанием, такие как снижение времени отклика и увеличение частоты отказов. Используйте эти параметры, чтобы настроить чувствительность обнаружения, установить пороги предупреждений или отключить предупреждения для определенных служб.		АппОптима автоматически обнаруживает аномалии производительности, связанные с обслуживанием, такие как снижение времени отклика и увеличение частоты отказов. Используйте эти параметры, чтобы настроить чувствительность обнаружения, установить пороги предупреждений или отключить предупреждения для определенных служб.
	{\| class="wikitable"		{\| class="wikitable"
	!Элемент		!Элемент
Строка 79:		Строка 79:
	\|clusterVersion		\|clusterVersion
	\|string		\|string
	\|Версия ~~Ключ-АСТРОМ~~.		\|Версия АппОптима.
	\|}		\|}

Строка 317:		Строка 317:

	=== JSON-модель тела ответа ===		=== JSON-модель тела ответа ===
	<~~code>~~{		<{
	"metadata": {		"metadata": {
	"configurationVersions": [		"configurationVersions": [
Строка 362:		Строка 362:

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

	==== Тело ответа ====		==== Тело ответа ====
	<~~code>~~{		<{
	"metadata": {		"metadata": {
	"clusterVersion": "1.163.14.20190204-102159",		"clusterVersion": "1.163.14.20190204-102159",

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

2023-03-02T16:31:13Z

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

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

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

Запрос создает в качестве полезной нагрузки<code>application/json</code>формат.
{| class="wikitable"
| rowspan="2" |GET
|Ключ-АСТРОМ Managed для управления
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/config/v1/anomalyDetection/services</nowiki></code>
|-
|Среда АктивногоШлюза
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/anomalyDetection/services</nowiki></code>
|}

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

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

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

== Ответ ==

=== Коды ответов ===
{| class="wikitable"
!Код
|Тип
!Описание
|-
|200
|Конфигурация обнаружения аномалий обслуживания
|Успех
|}

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

==== Объект <code>ServiceAnomalyDetectionConfig</code> ====
Ключ-АСТРОМ автоматически обнаруживает аномалии производительности, связанные с обслуживанием, такие как снижение времени отклика и увеличение частоты отказов. Используйте эти параметры, чтобы настроить чувствительность обнаружения, установить пороги предупреждений или отключить предупреждения для определенных служб.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|metadata
|ConfigurationMetadata
|Метаданные, полезные для отладки
|-
|responseTimeDegradation
|ResponseTimeDegradationDetectionConfig
|Настройка обнаружения ухудшения времени отклика.
|-
|loadDrop
|LoadDropDetectionConfig
|Конфигурация обнаружения падения нагрузки.
|-
|loadSpike
|LoadSpikeDetectionConfig
|Настройка обнаружения скачков нагрузки.
|-
|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>LoadDropDetectionConfig</code> ====
Конфигурация обнаружения падения нагрузки.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|enabled
|boolean
|Обнаружение включено ( <code>true</code>) или отключено ( <code>false</code>).
|-
|loadDropPercent
|integer
|Предупреждать, если наблюдаемая нагрузка меньше ''X'' % от ожидаемого значения.
|-
|minAbnormalStateDurationInMinutes
|integer
|Оповещение, если служба остается в ненормальном состоянии не менее ''X'' минут.
|}

==== Объект <code>LoadSpikeDetectionConfig</code> ====
Настройка обнаружения скачков нагрузки.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|enabled
|boolean
|Обнаружение включено ( <code>true</code>) или отключено ( <code>false</code>).
|-
|loadSpikePercent
|integer
|Предупреждать, если наблюдаемая нагрузка превышает ''X'' % ожидаемого значения.
|-
|minAbnormalStateDurationInMinutes
|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>{
"metadata": {
"configurationVersions": [
4,
2
],
"clusterVersion": "Mock version"
},
"responseTimeDegradation": {
"detectionMode": "DETECT_AUTOMATICALLY",
"automaticDetection": {
"responseTimeDegradationMilliseconds": 250,
"responseTimeDegradationPercent": 90,
"slowestResponseTimeDegradationMilliseconds": 500,
"slowestResponseTimeDegradationPercent": 200,
"loadThreshold": "ONE_REQUEST_PER_MINUTE"
}
},
"loadDrop": {
"enabled": true,
"loadDropPercent": 40,
"minAbnormalStateDurationInMinutes": 5
},
"loadSpike": {
"enabled": false
},
"failureRateIncrease": {
"detectionMode": "DETECT_USING_FIXED_THRESHOLDS",
"thresholds": {
"threshold": 10,
"sensitivity": "LOW"
}
}
}</code>

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

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

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

[[Файл:serv1.png]]

==== Curl ====
<code>curl -X GET \
<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/config/v1/anomalyDetection/services</nowiki> \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>

==== URL-адрес запроса ====
<code><nowiki>https://mySampleEnv.live.ruscomtech.ru/api/config/v1/anomalyDetection/services</nowiki></code>

==== Тело ответа ====
<code>{
"metadata": {
"clusterVersion": "1.163.14.20190204-102159",
"configurationVersions": [
2
]
},
"responseTimeDegradation": {
"detectionMode": "DETECT_AUTOMATICALLY",
"automaticDetection": {
"responseTimeDegradationMilliseconds": 100,
"responseTimeDegradationPercent": 50,
"slowestResponseTimeDegradationMilliseconds": 100,
"slowestResponseTimeDegradationPercent": 100,
"loadThreshold": "TEN_REQUESTS_PER_MINUTE"
}
},
"failureRateIncrease": {
"detectionMode": "DETECT_AUTOMATICALLY",
"automaticDetection": {
"failingServiceCallPercentageIncreaseAbsolute": 0,
"failingServiceCallPercentageIncreaseRelative": 50
}
}
}</code>

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