Пользовательские метаданные метрик

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

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

Вы не можете предоставлять метаданные для встроенных или вычисляемых метрик; метаданные поддерживаются только для пользовательских, автоматически собираемых метрик.

Доступные параметры

Для метаданных метрик доступны следующие параметры.

Параметр	Тип	Описание
displayName	string	Название метрики в пользовательском интерфейсе.
description	string	Краткое описание метрики.
unit	string	Единица метрической системы.
sourceEntityType	string	Тип сущности метрики. Используется для фильтрации менеджмент зон.
tags	string[]	Список тегов, примененных к метрике.
metricProperties	MetricProperties	Список свойств метрики.
dimensions	MetricDimensions[]	Список параметров метрики.

Объект MetricProperties​

Свойства метрики.

Параметр	Тип	Описание
minValue	integer	Минимально допустимое значение показателя.
maxValue	integer	Максимально допустимое значение показателя.
rootCauseRelevant	boolean	Связана ли (true или false) эта метрика с первопричиной проблемы. Показатель, позволяющий выявить первопричину проблемы, является надежным индикатором наличия неисправного компонента.
impactRelevant	boolean	Имеет ли (true или false) значение этот показатель для оценки влияния проблемы. Показатель, имеющий значение для оценки воздействия, в значительной степени зависит от других показателей и изменяется, поскольку изменился основной показатель, являющийся первопричиной проблемы.
valueType	string	Тип значения метрики. Вам доступны следующие варианты: Показатель эффективности score — это метрика, высокие значения которой указывают на благоприятную ситуацию, а низкие — на проблемы. Примером такой метрики является процент успешных результатов. Показатель ошибок error — это показатель, высокие значения которого указывают на проблемы, а низкие — на благоприятную ситуацию. Примером такого показателя является количество ошибок.
latency	integer	Задержка в предоставлении данных по показателям, в минутах. Задержка, вызванная ограничениями облачных провайдеров или других сторонних источников данных, приводит к задержке при приеме данных на стороне Ключ-АСТРОМ.

Объект MetricDimensions​

Одно из измерений метрики.

Параметр	Тип	Описание
key	string	Ключ к параметру, используемому в протоколе приема.
displayName	string	Название измерения в пользовательском интерфейсе.

Пример JSON

{   "displayName": "Total revenue",   "description": "Total store revenue by region, city, and store",   "unit": "Unspecified",   "sourceEntityType": "string",   "tags": ["KPI", "Business"],   "metricProperties": {     "maxValue": 1000000,     "minValue": 0,     "rootCauseRelevant": false,     "impactRelevant": true,     "valueType": "score",     "latency": 1   },   "dimensions": [     {       "key": "city",       "displayName": "City name"     },     {       "key": "country",       "displayName": "Country name"     },     {       "key": "region",       "displayName": "Sales region"     },     {       "key": "store",       "displayName": "Store #"     }   ] }

Установка метаданных метрик

Используйте POST-запрос объекта к API настроек для предоставления метаданных для вашей метрики. Используйте следующие параметры в полезной нагрузке:

Field	Value
scope	metric-{your-metric-key}
schemaId	builtin:metric.metadata
value	Необходимый набор метаданных. См. доступные поля выше.

Пример полезной нагрузки

[   {     "scope": "metric-business.shop.revenue",     "schemaId": "builtin:metric.metadata",     "value": {       "displayName": "Total revenue",       "description": "Total store revenue by region, city, and store",       "unit": "Unspecified",       "sourceEntityType": "string",       "tags": ["KPI", "Business"],       "metricProperties": {         "maxValue": 1000000,         "minValue": 0,         "rootCauseRelevant": false,         "impactRelevant": true,         "valueType": "score",         "latency": 1       },       "dimensions": [         {           "key": "city",           "displayName": "City name"         },         {           "key": "country",           "displayName": "Country name"         },         {           "key": "region",           "displayName": "Sales region"         },         {           "key": "store",           "displayName": "Store #"         }       ]     }   } ]

В качестве альтернативы вы можете:

• Отправлять метаданные через протокол приема.
• Настроить метаданные метрики в обзоре метрик.