Получение дескриптора метрики - История изменений

IKuznetsov в 12:11, 29 декабря 2024

2024-12-29T12:11:38Z

← Предыдущая версия		Версия от 12:11, 29 декабря 2024
Строка 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=POST%20%D1%82%D0%BE%D1%87%D0%B5%D0%BA%20%D0%B4%D0%B0%D0%BD%D0%BD%D1%8B%D1%85-,%D0%9C%D0%B5%D1%82%D1%80%D0%B8%D0%BA%D0%B8%20v2,-GET%20%D0%BC%D0%B5%D1%82%D1%80%D0%B8%D0%BA Метрики v2] / Получение дескриптора метрики'''''

	Получает параметры указанной метрики.		Получает параметры указанной метрики.

IKuznetsov в 11:41, 29 декабря 2024

2024-12-29T11:41:59Z

← Предыдущая версия		Версия от 11:41, 29 декабря 2024
Строка 32:		Строка 32:
	\|Ключ требуемой метрики.		\|Ключ требуемой метрики.

	Вы можете установить дополнительные операторы преобразования, разделенные двоеточием ( <code>:</code>). Дополнительную информацию о доступных преобразованиях результатов и синтаксисе см. в разделе Преобразования селектора показателей в документации ~~Ключ-АСТРОМ~~.		Вы можете установить дополнительные операторы преобразования, разделенные двоеточием ( <code>:</code>). Дополнительную информацию о доступных преобразованиях результатов и синтаксисе см. в разделе Преобразования селектора показателей в документации АппОптима.
	\|path		\|path
	\|требуется		\|требуется
Строка 87:		Строка 87:
	\|Задержка показателя в минутах.		\|Задержка показателя в минутах.

	Задержка — это ожидаемая задержка в отчетах (например, вызванная ограничениями поставщиков облачных услуг или других сторонних источников данных) между наблюдением за точкой данных метрики и ее доступностью в ~~Ключ-АСТРОМ~~.		Задержка — это ожидаемая задержка в отчетах (например, вызванная ограничениями поставщиков облачных услуг или других сторонних источников данных) между наблюдением за точкой данных метрики и ее доступностью в АппОптима.

	Допустимый диапазон значений составляет от 1 до 60 минут.		Допустимый диапазон значений составляет от 1 до 60 минут.
Строка 411:		Строка 411:
	"latency": 1,		"latency": 1,
	"scalar": false		"scalar": false
	}~~</code>~~		}

	== Пример ==		== Пример ==
Строка 423:		Строка 423:
	<curl -L -X GET '<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/metrics/builtin:host.disk.avail'</nowiki> \		<curl -L -X GET '<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/metrics/builtin:host.disk.avail'</nowiki> \
	-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \		-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
	-H 'Accept: application/json'~~</code>~~		-H 'Accept: application/json'

	==== URL-адрес запроса ====		==== URL-адрес запроса ====
Строка 467:		Строка 467:
	}		}
	]		]
	}~~</code>~~		}
	Таблица CSV со строкой заголовка выглядит следующим образом. Чтобы получить его, измените заголовок Accept<code>text/csv; header=present</code> на .		Таблица CSV со строкой заголовка выглядит следующим образом. Чтобы получить его, измените заголовок Accept<code>text/csv; header=present</code> на .
	<metricId,displayName,description,unit,entityType,aggregationTypes,transformations,defaultAggregation,dimensionDefinitions		<metricId,displayName,description,unit,entityType,aggregationTypes,transformations,defaultAggregation,dimensionDefinitions
	builtin:host.cpu.usage,CPU usage %,Percentage of CPU time currently utilized.,Percent,[HOST],"[auto, avg, max, min]","[filter, fold, merge, names, parents]",avg,[Host:ENTITY]~~</code>~~		builtin:host.cpu.usage,CPU usage %,Percentage of CPU time currently utilized.,Percent,[HOST],"[auto, avg, max, min]","[filter, fold, merge, names, parents]",avg,[Host:ENTITY]

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

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

2024-12-26T09:41:33Z

← Предыдущая версия		Версия от 09:41, 26 декабря 2024
Строка 10:		Строка 10:
	{\| class="wikitable"		{\| class="wikitable"
	\| rowspan="2" \|GET		\| rowspan="2" \|GET
	\|~~Managed~~		\|АппОптима
	\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/metrics/{metricKey}</nowiki></code>		\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/metrics/{metricKey}</nowiki></code>
	\|-		\|-
Строка 358:		Строка 358:

	=== JSON-модель тела ответа ===		=== JSON-модель тела ответа ===
	<~~code>~~{		<{
	"metricId": "builtin:host.cpu.user:splitBy(\"dt.entity.host\"):max:fold",		"metricId": "builtin:host.cpu.user:splitBy(\"dt.entity.host\"):max:fold",
	"displayName": "CPU user",		"displayName": "CPU user",
Строка 421:		Строка 421:

	==== Curl ====		==== Curl ====
	<~~code>~~curl -L -X GET '<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/metrics/builtin:host.disk.avail'</nowiki> \		<curl -L -X GET '<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/metrics/builtin:host.disk.avail'</nowiki> \
	-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \		-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
	-H 'Accept: application/json'</code>		-H 'Accept: application/json'</code>
Строка 429:		Строка 429:

	==== Тело ответа ====		==== Тело ответа ====
	<~~code>~~{		<{
	"metricId": "builtin:host.disk.avail",		"metricId": "builtin:host.disk.avail",
	"displayName": "Disk available",		"displayName": "Disk available",
Строка 469:		Строка 469:
	}</code>		}</code>
	Таблица CSV со строкой заголовка выглядит следующим образом. Чтобы получить его, измените заголовок Accept<code>text/csv; header=present</code> на .		Таблица CSV со строкой заголовка выглядит следующим образом. Чтобы получить его, измените заголовок Accept<code>text/csv; header=present</code> на .
	<~~code>~~metricId,displayName,description,unit,entityType,aggregationTypes,transformations,defaultAggregation,dimensionDefinitions		<metricId,displayName,description,unit,entityType,aggregationTypes,transformations,defaultAggregation,dimensionDefinitions
	builtin:host.cpu.usage,CPU usage %,Percentage of CPU time currently utilized.,Percent,[HOST],"[auto, avg, max, min]","[filter, fold, merge, names, parents]",avg,[Host:ENTITY]</code>		builtin:host.cpu.usage,CPU usage %,Percentage of CPU time currently utilized.,Percent,[HOST],"[auto, avg, max, min]","[filter, fold, merge, names, parents]",avg,[Host:ENTITY]</code>

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

ENetrebin в 19:43, 23 июля 2024

2024-07-23T19:43:08Z

← Предыдущая версия		Версия от 19:43, 23 июля 2024
Строка 9:		Строка 9:
	Если с запросом не предоставлен заголовок Accept<code>application/json</code> , возвращается полезная нагрузка.		Если с запросом не предоставлен заголовок Accept<code>application/json</code> , возвращается полезная нагрузка.
	{\| class="wikitable"		{\| class="wikitable"
	\| rowspan="3" \|GET		\| rowspan="2" \|GET
	\|Managed		\|Managed
	\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/metrics/{metricKey}</nowiki></code>		\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/metrics/{metricKey}</nowiki></code>
	\|-		\|-
	\|~~SaaS~~		\|Среда АктивногоШлюза
	~~\|<code><nowiki>https://{your-environment-id}.live.ruscomtech.ru</nowiki><nowiki/>/api/v2/metrics/{metricKey}</code>~~
	\|-
	~~\|Окружающая среда~~ АктивногоШлюза
	\|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/metrics/{metricKey}</nowiki></code>		\|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/metrics/{metricKey}</nowiki></code>
	\|}		\|}

ENetrebin в 11:15, 10 октября 2022

2022-10-10T11:15:40Z

← Предыдущая версия		Версия от 11:15, 10 октября 2022
Строка 14:		Строка 14:
	\|-		\|-
	\|SaaS		\|SaaS
	\|<code>https://{your-environment-id}.live.ruscomtech.ru<nowiki/>/api/v2/metrics/{metricKey}</code>		\|<code><nowiki>https://{your-environment-id}.live.ruscomtech.ru</nowiki><nowiki/>/api/v2/metrics/{metricKey}</code>
	\|-		\|-
	\|Окружающая среда АктивногоШлюза		\|Окружающая среда АктивногоШлюза

ENetrebin в 16:57, 7 октября 2022

2022-10-07T16:57:50Z

Внесённые изменения

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

2022-10-05T15:33:04Z

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

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

Получает параметры указанной метрики.

Запрос создает один из следующих типов полезной нагрузки, в зависимости от значения заголовка запроса Accept :

* <code>application/json</code>
* <code>text/csv; header=present</code>— таблица CSV со строкой заголовка
* <code>text/csv; header=absent</code>— таблица CSV без строки заголовка

Если с запросом не предоставлен заголовок Accept<code>application/json</code> , возвращается полезная нагрузка.
{| class="wikitable"
| rowspan="3" |ПОЛУЧИТЬ
|Удалось
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/metrics/{metricKey}</nowiki></code>
|-
|SaaS
|<code><nowiki>https://{your-environment-id}.live.dynatrace.com/api/v2/metrics/{metricKey}</nowiki></code>
|-
|Окружающая среда ActiveGate
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/metrics/{metricKey}</nowiki></code>
|}

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

== Параметры ==
{| class="wikitable"
!Параметр
!Тип
!Описание
!В
!Необходимый
|-
|метрикей
|нить
|Ключ требуемой метрики.

Вы можете установить дополнительные операторы преобразования, разделенные двоеточием ( <code>:</code>). Дополнительную информацию о доступных преобразованиях результатов и синтаксисе см. в разделе Преобразования селектора показателей в документации Dynatrace.
|дорожка
|требуется
|}

== Ответ ==

=== Коды ответов ===
{| class="wikitable"
!Код
|Тип
!Описание
|-
|200
|Дескриптор метрики
|Успех
|-
|404
|
|Метрика не найдена.
|-
|406
|
|Неприемлимо. Запрошенный тип носителя не поддерживается. Проверьте заголовок Accept вашего запроса.
|}

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

==== Объект _ <code>MetricDescriptor</code> ====
Дескриптор метрики.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|размерность
|Количество элементов метрики [ ]
|Количество элементов метрических измерений MINT.
|-
|минимальное значение
|количество
|Минимально допустимое значение метрики.

Выражения показателей не возвращают это поле.
|-
|максимальное значение
|количество
|Максимально допустимое значение метрики.

Выражения показателей не возвращают это поле.
|-
|задержка
|целое число
|Задержка показателя в минутах.

Задержка — это ожидаемая задержка в отчетах (например, вызванная ограничениями поставщиков облачных услуг или других сторонних источников данных) между наблюдением за точкой данных метрики и ее доступностью в Dynatrace.

Допустимый диапазон значений составляет от 1 до 60 минут.

Выражения показателей не возвращают это поле.
|-
|разрешениеInfSupported
|логический
|Если установлено значение «true», разрешение=Inf может быть применено к запросу метрики.
|-
|unitDisplayFormat
|нить
|Необработанное значение хранится в битах или байтах. Пользовательский интерфейс может отображать его в следующих системах счисления:

Двоичный: 1 МБ = 1024 КиБ = 1 048 576 байт.

Десятичный: 1 МБ = 1000 КБ = 1 000 000 байт.

Если не задано, используется десятичная система.

Выражения показателей не возвращают это поле.

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

* <code>binary</code>
* <code>decimal</code>
|-
|rootCauseRelevant
|логический
|Метрика является ( <code>true</code>) или не является ( <code>false</code>) релевантной для основной причины.

Метрика, относящаяся к первопричине, представляет собой надежный индикатор неисправного компонента.

Выражения показателей не возвращают это поле.
|-
|dduBillable
|логический
|Если <code>true</code>использование метрики потребляет единицы данных Дэвиса .

Выражения показателей не возвращают это поле.
|-
|агрегация по умолчанию
|Агрегирование показателей по умолчанию
|Агрегирование метрики по умолчанию.
|-
|lastWritten
|целое число
|Отметка времени последней записи метрики.

Имеет значение <code>null</code>для метрических выражений или если данные никогда не записывались.
|-
|влияниеактуальный
|логический
|Метрика является ( <code>true</code>) или не является ( <code>false</code>) релевантной для воздействия.

Метрика, имеющая отношение к влиянию, сильно зависит от других метрик и изменений, поскольку базовая метрика первопричины изменилась.

Выражения показателей не возвращают это поле.
|-
|измерениеОпределения
|Определение метрического измерения []
|Точное разделение метрик (например, группа процессов и идентификатор процесса для некоторой метрики, связанной с процессом).

Для загруженных показателей параметры, по которым не было данных за последние 15 дней, опускаются.
|-
|тип метриквалуе
|Тип значения показателя
|Тип значения для метрики.
|-
|теги
|строка []
|Теги, примененные к метрике.

Выражения показателей не возвращают это поле.
|-
|тип объекта
|строка []
|Список допустимых основных типов сущностей для этой метрики. Может использоваться для <code>type</code>предиката в <code>entitySelector</code>.
|-
|идентификатор метрики
|нить
|Полный ключ метрики.

Если использовалось преобразование, оно отражается в ключе метрики.
|-
|метрическийселектор
|нить
|Селектор метрик, который используется при запросе метрики func:.
|-
|скаляр
|логический
|Указывает, разрешается ли метрическое выражение в скаляр ( <code>true</code>) или в ряд ( <code>false</code>). Скалярный результат всегда содержит одну точку данных. Количество точек данных в результате серии зависит от используемого разрешения.
|-
|типы агрегации
|строка []
|Список разрешенных агрегаций для этой метрики.

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

* <code>auto</code>
* <code>avg</code>
* <code>count</code>
* <code>max</code>
* <code>median</code>
* <code>min</code>
* <code>percentile</code>
* <code>sum</code>
* <code>value</code>
|-
|показать имя
|нить
|Имя метрики в пользовательском интерфейсе.
|-
|описание
|нить
|Краткое описание метрики.
|-
|преобразования
|строка []
|Операторы преобразования, которые можно добавить к текущему списку преобразований.

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

* <code>asGauge</code>
* <code>default</code>
* <code>delta</code>
* <code>evaluateModel</code>
* <code>filter</code>
* <code>fold</code>
* <code>last</code>
* <code>lastReal</code>
* <code>limit</code>
* <code>merge</code>
* <code>names</code>
* <code>parents</code>
* <code>partition</code>
* <code>rate</code>
* <code>rollup</code>
* <code>setUnit</code>
* <code>smooth</code>
* <code>sort</code>
* <code>splitBy</code>
* <code>timeshift</code>
* <code>toUnit</code>
|-
|Ед. изм
|нить
|Единица измерения.
|-
|предупреждения
|строка []
|Список потенциальных предупреждений, влияющих на этот идентификатор. Например, использование устаревших функций и т. д.
|-
|созданный
|целое число
|Отметка времени создания метрики.

Встроенные метрики и выражения метрик имеют значение <code>null</code>.
|}

==== Объект _ <code>MetricDimensionCardinality</code> ====
Количество элементов измерения метрики.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|родственник
|количество
|Относительная кардинальность измерения, выраженная в процентах
|-
|оценивать
|целое число
|Оценка количества элементов измерения.
|-
|ключ
|нить
|Ключ измерения.

Он должен быть уникальным в пределах метрики.
|}

==== Объект _ <code>MetricDefaultAggregation</code> ====
Агрегирование метрики по умолчанию.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|параметр
|количество
|Доставляемый процентиль. Допустимые значения находятся между <code>0</code>и <code>100</code>.

Применимо только к <code>percentile</code>типу агрегации.
|-
|тип
|нить
|Тип агрегации по умолчанию.

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

* <code>auto</code>
* <code>avg</code>
* <code>count</code>
* <code>max</code>
* <code>median</code>
* <code>min</code>
* <code>percentile</code>
* <code>sum</code>
* <code>value</code>
|}

==== Объект _ <code>MetricDimensionDefinition</code> ====
Размерность метрики.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|показать имя
|нить
|Отображаемое имя измерения.
|-
|имя
|нить
|Имя измерения.
|-
|ключ
|нить
|Ключ измерения.

Он должен быть уникальным в пределах метрики.
|-
|тип
|нить
|Тип измерения.

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

* <code>ENTITY</code>
* <code>NUMBER</code>
* <code>OTHER</code>
* <code>STRING</code>
* <code>VOID</code>
|-
|индекс
|целое число
|Уникальный индекс измерения, начинающийся с 0.

Добавление преобразований, таких как :names или :parents, может изменить индексы измерений. <code>null</code>используется для измерений метрики с гибкими измерениями, на которые можно ссылаться с помощью их ключа измерения, но у которых нет внутреннего порядка, который можно было бы использовать для индекса.
|}

==== Объект _ <code>MetricValueType</code> ====
Тип значения для метрики.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|тип
|нить
|Тип значения метрики

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

* <code>error</code>
* <code>score</code>
* <code>unknown</code>
|}

=== JSON-модель тела ответа ===
<code>{
"metricId": "builtin:host.cpu.user:splitBy(\"dt.entity.host\"):max:fold",
"displayName": "CPU user",
"description": "Percentage of user-space CPU time currently utilized, per host.",
"unit": "Percent",
"dduBillable": false,
"created": 1597400123451,
"lastWritten": 1597400717783,
"entityType": [
"HOST"
],
"aggregationTypes": [
"auto",
"value"
],
"transformations": [
"filter",
"fold",
"limit",
"merge",
"names",
"parents",
"timeshift",
"rate",
"sort",
"last",
"splitBy"
],
"defaultAggregation": {
"type": "value"
},
"dimensionDefinitions": [
{
"key": "dt.entity.host",
"name": "Host",
"displayName": "Host",
"index": 0,
"type": "ENTITY"
}
],
"tags": [],
"metricValueType": {
"type": "unknown"
},
"dimensionCardinalities": [
{
"key": "dt.entity.host",
"estimate": 20,
"relative": 0.2
}
],
"latency": 1,
"scalar": false
}</code>

== Пример ==
В этом примере запрос запрашивает параметры трех метрик: Builtin:host.cpu.idle , Builtin:host.cpu.usage и Builtin:host.disk.avail .

Метрики встроенные:host.cpu.idle и встроенные:host.cpu.usage имеют один и тот же родительский элемент, и их селектор объединен в встроенный:host.cpu.(idle,usage) .

Ответ в <code>application/json</code>формате.

==== Завиток ====
<code>curl -L -X GET '<nowiki>https://mySampleEnv.live.dynatrace.com/api/v2/metrics/builtin:host.disk.avail'</nowiki> \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
-H 'Accept: application/json'</code>

==== URL-адрес запроса ====
<code><nowiki>https://mySampleEnv.live.dynatrace.com/api/v2/metrics/builtin:host.disk.avail</nowiki></code>

==== Тело ответа ====
<code>{
"metricId": "builtin:host.disk.avail",
"displayName": "Disk available",
"description": "",
"unit": "Byte",
"entityType": [
"HOST"
],
"aggregationTypes": [
"auto",
"avg",
"max",
"min"
],
"transformations": [
"filter",
"fold",
"merge",
"names",
"parents"
],
"defaultAggregation": {
"type": "avg"
},
"dimensionDefinitions": [
{
"key": "dt.entity.host",
"name": "Host",
"index": 0,
"type": "ENTITY"
},
{
"key": "dt.entity.disk",
"name": "Disk",
"index": 1,
"type": "ENTITY"
}
]
}</code>
Таблица CSV со строкой заголовка выглядит следующим образом. Чтобы получить его, измените заголовок Accept<code>text/csv; header=present</code> на .
<code>metricId,displayName,description,unit,entityType,aggregationTypes,transformations,defaultAggregation,dimensionDefinitions
builtin:host.cpu.usage,CPU usage %,Percentage of CPU time currently utilized.,Percent,[HOST],"[auto, avg, max, min]","[filter, fold, merge, names, parents]",avg,[Host:ENTITY]</code>

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