IKuznetsov в 16:56, 2 января 2025

2025-01-02T16:56:59Z

← Предыдущая версия		Версия от 16:56, 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=DELETE%20%D1%82%D0%B5%D0%B3%D0%BE%D0%B2-,%D0%A0%D0%B0%D0%B7%D0%B2%D1%91%D1%80%D1%82%D1%8B%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5,-%D0%BF%D1%80%D0%B0%D0%B2%D0%B8%D1%82%D1%8C Развёртывание] / [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=GET%20%D1%81%D1%85%D0%B5%D0%BC%D0%B0-,%D0%A1%D0%B8%D0%BD%D1%82%D0%B5%D1%82%D0%B8%D0%BA%D0%B0%20v1,-%D0%A1%D0%B8%D0%BD%D1%82%D0%B5%D1%82%D0%B8%D1%87%D0%B5%D1%81%D0%BA%D0%B8%D0%B5%20%D0%BC%D0%BE%D0%BD%D0%B8%D1%82%D0%BE%D1%80%D1%8B Синтетика v1] / [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%A1%D0%B8%D0%BD%D1%82%D0%B5%D1%82%D0%B8%D1%87%D0%B5%D1%81%D0%BA%D0%B8%D0%B5%20%D0%BC%D0%BE%D0%BD%D0%B8%D1%82%D0%BE%D1%80%D1%8B Синтетические мониторы] / JSON модели*'''''

	Некоторые модели JSON API синтетических мониторов различаются в зависимости от типа модели. Модели JSON для каждого варианта перечислены ниже.		Некоторые модели JSON API синтетических мониторов различаются в зависимости от типа модели. Модели JSON для каждого варианта перечислены ниже.

Строка 79:		Строка 81:
	\|}		\|}
	'''JSON модель:'''		'''JSON модель:'''
	<~~code>~~{		<{
	"entityId": "SYNTHETIC_TEST-790745B687BE4D0E",		"entityId": "SYNTHETIC_TEST-790745B687BE4D0E",
	"name": "Browser monitor",		"name": "Browser monitor",
Строка 200:		Строка 202:
	\|}		\|}
	'''JSON модель:'''		'''JSON модель:'''
	<~~code>~~{		<{
	"entityId": "HTTP_CHECK-B58DA1B8B892A05C",		"entityId": "HTTP_CHECK-B58DA1B8B892A05C",
	"name": "HTTP monitor",		"name": "HTTP monitor",
Строка 323:		Строка 325:
	\|}		\|}
	'''JSON модель:'''		'''JSON модель:'''
	<~~code>~~{		<{

	"name": "Browser monitor",		"name": "Browser monitor",
Строка 576:		Строка 578:

	==== Объект <code>TagWithSourceInfo</code> ====		==== Объект <code>TagWithSourceInfo</code> ====
	Тег с источником объекта ~~Ключ-АСТРОМ~~.		Тег с источником объекта АппОптима.
	{\| class="wikitable"		{\| class="wikitable"
	!Элемент		!Элемент
Строка 622:		Строка 624:
	\|}		\|}
	'''JSON модель:'''		'''JSON модель:'''
	<~~code>~~{		<{
	"name": "HTTP monitor",		"name": "HTTP monitor",
	"frequencyMin": 1,		"frequencyMin": 1,

ENetrebin: Новая страница: «Некоторые модели JSON API синтетических мониторов различаются в зависимости от типа модели...»

2022-10-24T13:57:42Z

Новая страница: «Некоторые модели JSON API синтетических мониторов различаются в зависимости от типа модели...»

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

Некоторые модели JSON API синтетических мониторов различаются в зависимости от типа модели. Модели JSON для каждого варианта перечислены ниже.

== Вариации <code>SyntheticMonitor</code>объекта ==

=== БРАУЗЕР ===
BrowserSyntheticMonitor

'''Параметры:'''

==== Объект _ <code>BrowserSyntheticMonitor</code> ====
Синтетический монитор.

Фактический набор полей зависит от типа монитора. Список актуальных объектов ищите в описании поля типа или смотрите Синтетические мониторы API-модели JSON .
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|keyPerformanceMetrics
|KeyPerformanceMetrics
|Конфигурация ключевых показателей производительности.
|-
|events
|EventDto[]
|Список событий для этого монитора
|}

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

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

* <code>VISUALLY_COMPLETE</code>
* <code>SPEED_INDEX</code>
* <code>USER_ACTION_DURATION</code>
* <code>TIME_TO_FIRST_BYTE</code>
* <code>HTML_DOWNLOADED</code>
* <code>DOM_INTERACTIVE</code>
* <code>LOAD_EVENT_START</code>
* <code>LOAD_EVENT_END</code>
|-
|xhrActionKpm
|string
|Определяет ключевой показатель производительности для действий XHR.

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

* <code>VISUALLY_COMPLETE</code>
* <code>USER_ACTION_DURATION</code>
* <code>TIME_TO_FIRST_BYTE</code>
* <code>RESPONSE_END</code>
|}

==== Объект <code>EventDto</code> ====
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|идентификатор сущности
|string
|Идентификатор события
|-
|имя
|string
|Название события
|-
|Последовательность чисел
|integer
|Порядковый номер события
|}
'''JSON модель:'''
<code>{
"entityId": "SYNTHETIC_TEST-790745B687BE4D0E",
"name": "Browser monitor",
"frequencyMin": 10,
"enabled": true,
"type": "BROWSER",
"createdFrom": "GUI",
"script": {
"type": "clickpath",
"version": "1.0",
"configuration": {
"device": {
"mobile": false,
"touchEnabled": false,
"width": 1024,
"height": 768,
"scaleFactor": 1
}
},
"events": [
{
"type": "navigate",
"description": "Loading of \"<nowiki>https://orf.at</nowiki>\"",
"url": "<nowiki>https://orf.at</nowiki>",
"wait": {
"waitFor": "page_complete"
}
}
]
},
"locations": [
"GEOLOCATION-0A41430434C388A9"
],
"anomalyDetection": {
"outageHandling": {
"globalOutage": true,
"localOutage": false,
"localOutagePolicy": {
"affectedLocations": 1,
"consecutiveRuns": 3
}
},
"loadingTimeThresholds": {
"enabled": true,
"thresholds": [
{
"type": "TOTAL",
"valueMs": 10000
}
]
}
},
"tags": [
{
"context": "CONTEXTLESS",
"key": "blabla"
}
],
"managementZones": [
{
"id": "-7832237287622819191",
"name": "!!allSynthetic"
}
],
"automaticallyAssignedApps": [
"APPLICATION-7ADA0EF404C7C545"
],
"manuallyAssignedApps": [
"APPLICATION-4ADF0EF407C7C545"
],
"keyPerformanceMetrics": {
"loadActionKpm": "VISUALLY_COMPLETE",
"xhrActionKpm": "VISUALLY_COMPLETE"
},
"events": [
{
"entityId": "SYNTHETIC_TEST_STEP-2E6FDA5B4BC39A27",
"name": "Loading of \"<nowiki>https://orf.at</nowiki>\"",
"sequenceNumber": 1
}
]
}</code>

=== HTTP ===
HttpSyntheticMonitor

'''Параметры:'''

==== Объект <code>HttpSyntheticMonitor</code> ====
Синтетический монитор.

Фактический набор полей зависит от типа монитора. Список актуальных объектов ищите в описании поля типа или смотрите Синтетические мониторы API-модели JSON .
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|requests
|RequestDto[]
|Список событий для этого монитора
|}

==== Объект <code>RequestDto</code> ====
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|entityId
|string
|Идентификатор запроса
|-
|name
|string
|Имя запроса
|-
|sequenceNumber
|integer
|Порядковый номер запроса
|}
'''JSON модель:'''
<code>{
"entityId": "HTTP_CHECK-B58DA1B8B892A05C",
"name": "HTTP monitor",
"frequencyMin": 1,
"enabled": true,
"type": "HTTP",
"createdFrom": "GUI",
"script": {
"version": "1.0",
"requests": [
{
"description": "orf.at",
"url": "<nowiki>https://orf.at</nowiki>",
"method": "GET",
"requestBody": "",
"configuration": {
"acceptAnyCertificate": true,
"followRedirects": true
},
"preProcessingScript": "",
"postProcessingScript": ""
}
]
},
"locations": [
"SYNTHETIC_LOCATION-61F43EECF5FB8345"
],
"anomalyDetection": {
"outageHandling": {
"globalOutage": true,
"localOutage": false,
"localOutagePolicy": {
"affectedLocations": 1,
"consecutiveRuns": 3
}
},
"loadingTimeThresholds": {
"enabled": false,
"thresholds": [
{
"type": "TOTAL",
"valueMs": 10000
}
]
}
},
"tags": [],
"managementZones": [
{
"id": "-7832237287622819191",
"name": "!!allSynthetic"
}
],
"automaticallyAssignedApps": [
"APPLICATION-4ADF0EF407C7C545"
],
"manuallyAssignedApps": [
"APPLICATION-7ADA0EF404C7C545"
],
"requests": [
{
"entityId": "HTTP_CHECK_STEP-E9208469D53BAF38",
"name": "orf.at",
"sequenceNumber": 1
}
]
}</code>

== Вариации <code>SyntheticMonitorUpdate</code>объекта ==

=== БРАУЗЕР ===
BrowserSyntheticMonitorUpdate

'''Параметры:'''

==== Объект <code>BrowserSyntheticMonitorUpdate</code> ====
Синтетическое обновление монитора.

Фактический набор полей зависит от типа монитора. Список актуальных объектов ищите в описании поля типа или смотрите Синтетические мониторы API-модели JSON .
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|keyPerformanceMetrics
|KeyPerformanceMetrics
|Конфигурация ключевых показателей производительности.
|}

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

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

* <code>VISUALLY_COMPLETE</code>
* <code>SPEED_INDEX</code>
* <code>USER_ACTION_DURATION</code>
* <code>TIME_TO_FIRST_BYTE</code>
* <code>HTML_DOWNLOADED</code>
* <code>DOM_INTERACTIVE</code>
* <code>LOAD_EVENT_START</code>
* <code>LOAD_EVENT_END</code>
|-
|xhrActionKpm
|string
|Определяет ключевой показатель производительности для действий XHR.

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

* <code>VISUALLY_COMPLETE</code>
* <code>USER_ACTION_DURATION</code>
* <code>TIME_TO_FIRST_BYTE</code>
* <code>RESPONSE_END</code>
|}
'''JSON модель:'''
<code>{

"name": "Browser monitor",
"frequencyMin": 10,
"enabled": true,
"type": "BROWSER",
"script": {
"type": "clickpath",
"version": "1.0",
"configuration": {
"device": {
"mobile": false,
"touchEnabled": false,
"width": 1024,
"height": 768,
"scaleFactor": 1
}
},
"events": [
{
"type": "navigate",
"description": "Loading of \"<nowiki>https://orf.at</nowiki>\"",
"url": "<nowiki>https://orf.at</nowiki>",
"wait": {
"waitFor": "page_complete"
}
}
]
},
"locations": [
"GEOLOCATION-0A41430434C388A9"
],
"anomalyDetection": {
"outageHandling": {
"globalOutage": true,
"localOutage": false,
"localOutagePolicy": {
"affectedLocations": 1,
"consecutiveRuns": 3
}
},
"loadingTimeThresholds": {
"enabled": true,
"thresholds": [
{
"type": "TOTAL",
"valueMs": 10000
}
]
}
},
"tags": [
{
"context": "CONTEXTLESS",
"key": "blabla"
}
],
"manuallyAssignedApps": [
"APPLICATION-4ADF0EF407C7C545"
],
"keyPerformanceMetrics": {
"loadActionKpm": "VISUALLY_COMPLETE",
"xhrActionKpm": "VISUALLY_COMPLETE"
}
}</code>

=== HTTP ===
HttpSyntheticMonitorUpdate

'''Параметры:'''

==== Объект <code>HttpSyntheticMonitorUpdate</code> ====
Синтетическое обновление монитора.

Фактический набор полей зависит от типа монитора. Список актуальных объектов ищите в описании поля типа или смотрите Синтетические мониторы API-модели JSON .
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|frequencyMin
|integer
|Частота монитора в минутах.

Вы можете использовать одно из следующих значений: <code>5</code>, <code>10</code>, <code>15</code>, <code>30</code>и <code>60</code>.
|-
|anomalyDetection
|AnomalyDetection
|Конфигурация обнаружения аномалий.
|-
|type
|string
|Определяет фактический набор полей в зависимости от значения. См. один из следующих объектов:

* <code>BROWSER</code>-> BrowserSyntheticMonitorUpdate
* <code>HTTP</code>-> HttpSyntheticMonitorUpdate

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

* <code>BROWSER</code>
* <code>HTTP</code>
|-
|name
|string
|Название монитора.
|-
|locations
|string[]
|Список местоположений, из которых выполняется монитор.

Чтобы указать местоположение, используйте его идентификатор объекта.
|-
|enabled
|boolean
|Монитор включен ( <code>true</code>) или отключен ( <code>false</code>).
|-
|script
|object
|Скрипт браузера или HTTP-монитора.
|-
|tags
|TagWithSourceInfo[]
|Набор тегов, присвоенных монитору.

Здесь вы можете указать только значение тега, а <code>CONTEXTLESS</code>контекст и источник «ПОЛЬЗОВАТЕЛЬ» будут добавлены автоматически. Но предпочтительным вариантом является использование модели TagWithSourceDto.
|-
|manuallyAssignedApps
|string[]
|Набор назначенных вручную приложений.
|}

==== Объект <code>AnomalyDetection</code> ====
Конфигурация обнаружения аномалий.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|outageHandling
|OutageHandlingPolicy
|Конфигурация обработки сбоев.
|-
|loadingTimeThresholds
|LoadingTimeThresholdsPolicyDto
|Настройка порогов производительности.
|}

==== Объект <code>OutageHandlingPolicy</code> ====
Конфигурация обработки сбоев.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|globalOutage
|boolean
|Когда включено ( <code>true</code>), генерирует проблему и отправляет оповещение, когда монитор недоступен во всех настроенных местоположениях.
|-
|globalOutagePolicy
|GlobalOutagePolicy
|Конфигурация глобальной обработки сбоев.
|-
|localOutage
|boolean
|Если этот параметр включен ( <code>true</code>), генерирует проблему и отправляет оповещение, когда монитор недоступен для одного или нескольких последовательных запусков в любом месте.
|-
|localOutagePolicy
|LocalOutagePolicy
|Конфигурация локальной обработки сбоев.

Предупреждать, если затронутые местоположения местоположений не могут получить доступ к веб-приложению последовательно Запускается несколько раз подряд.
|-
|retryOnError
|boolean
|Запланируйте повторную попытку, если выполнение монитора браузера приведет к сбою. Для HTTP-мониторов это свойство игнорируется.
|}

==== Объект <code>GlobalOutagePolicy</code> ====
Конфигурация глобальной обработки сбоев.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|consecutiveRuns
|integer
|Оповещение, если все местоположения не могут получить доступ к веб-приложению ''X'' раз подряд.
|}

==== Объект <code>LocalOutagePolicy</code> ====
Конфигурация локальной обработки сбоев.

Предупреждать, если затронутые местоположения местоположений не могут получить доступ к веб-приложению последовательно Запускается несколько раз подряд.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|affectedLocations
|integer
|Количество затронутых местоположений, для которых выдается оповещение.
|-
|consecutiveRuns
|integer
|Количество последовательных неудачных попыток вызвать оповещение.
|}

==== Объект <code>LoadingTimeThresholdsPolicyDto</code> ====
Настройка порогов производительности.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|enabled
|boolean
|Порог производительности включен ( <code>true</code>) или отключен ( <code>false</code>).
|-
|thresholds
|LoadingTimeThreshold[]
|Список правил порога производительности.
|}

==== Объект <code>LoadingTimeThreshold</code> ====
Правило порога производительности.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|type
|string
|Тип порога: общее время загрузки или время загрузки действия.

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

* <code>ACTION</code>
* <code>TOTAL</code>
|-
|valueMs
|integer
|Уведомляtт, если загрузка монитора занимает больше ''X'' миллисекунд.
|-
|requestIndex
|integer
|Указывает запрос, к которому применяется порог ACTION.
|-
|eventIndex
|integer
|Укаpsdftn событие, к которому применяется порог ACTION.
|}

==== Объект <code>TagWithSourceInfo</code> ====
Тег с источником объекта Ключ-АСТРОМ.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|source
|string
|Источник тега, например USER, RULE_BASED или AUTO.

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

* <code>AUTO</code>
* <code>RULE_BASED</code>
* <code>USER</code>
|-
|context
|string
|Происхождение тега, например AWS или Cloud Foundry.

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

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

* <code>AWS</code>
* <code>AWS_GENERIC</code>
* <code>AZURE</code>
* <code>CLOUD_FOUNDRY</code>
* <code>CONTEXTLESS</code>
* <code>ENVIRONMENT</code>
* <code>GOOGLE_CLOUD</code>
* <code>KUBERNETES</code>
|-
|key
|string
|Ключ тега.

Пользовательские теги имеют значение тега здесь.
|-
|value
|string
|Значение тега.

Не применимо к пользовательским тегам.
|}
'''JSON модель:'''
<code>{
"name": "HTTP monitor",
"frequencyMin": 1,
"enabled": true,
"type": "HTTP",
"script": {
"version": "1.0",
"requests": [
{
"description": "orf.at",
"url": "<nowiki>https://orf.at</nowiki>",
"method": "GET",
"requestBody": "",
"configuration": {
"acceptAnyCertificate": true,
"followRedirects": true
},
"preProcessingScript": "",
"postProcessingScript": ""
}
]
},
"locations": [
"SYNTHETIC_LOCATION-61F43EECF5FB8345"
],
"anomalyDetection": {
"outageHandling": {
"globalOutage": true,
"localOutage": false,
"localOutagePolicy": {
"affectedLocations": 1,
"consecutiveRuns": 3
}
},
"loadingTimeThresholds": {
"enabled": false,
"thresholds": [
{
"type": "TOTAL",
"valueMs": 10000
}
]
}
},
"tags": [],
"manuallyAssignedApps": [
"APPLICATION-7ADA0EF404C7C545"
]
}</code>

JSON модели* - История изменений

IKuznetsov в 16:56, 2 января 2025

ENetrebin: Новая страница: «Некоторые модели JSON API синтетических мониторов различаются в зависимости от типа модели...»