Получение метрик: различия между версиями

Материал из Документация Ключ-АСТРОМ
(Новая страница: «Список всех доступных показателей. Вы можете ограничить вывод, используя нумерацию стр...»)
 
Строка 14: Строка 14:
Если с запросом не предоставлен заголовок Accept<code>application/json</code> , возвращается полезная нагрузка.
Если с запросом не предоставлен заголовок Accept<code>application/json</code> , возвращается полезная нагрузка.
{| class="wikitable"
{| class="wikitable"
| rowspan="3" |ПОЛУЧИТЬ
| rowspan="3" |GET
|Удалось
|Managed
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/metrics</nowiki></code>
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/metrics</nowiki></code>
|-
|-
|SaaS
|SaaS
|<code><nowiki>https://{your-environment-id}.live.dynatrace.com/api/v2/metrics</nowiki></code>
|<code><nowiki>https://{your-environment-id}.live.кruscomtech.ru/api/v2/metrics</nowiki></code>
|-
|-
|Окружающая среда ActiveGate
|Окружающая среда АктивногоШлюза
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/metrics</nowiki></code>
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/metrics</nowiki></code>
|}
|}


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


== Параметры ==
== Параметры ==
Строка 36: Строка 36:
!Необходимый
!Необходимый
|-
|-
|ключ следующей страницы
|nextPageKey
|нить
|string
|Курсор для следующей страницы результатов. Вы можете найти его в поле nextPageKey предыдущего ответа.
|Курсор для следующей страницы результатов. Вы можете найти его в поле nextPageKey предыдущего ответа.


Строка 46: Строка 46:
|по желанию
|по желанию
|-
|-
|размер страницы
|pageSize
|целое число
|integer
|Количество метрических схем в полезной нагрузке одного ответа.
|Количество метрических схем в полезной нагрузке одного ответа.


Строка 58: Строка 58:
|по желанию
|по желанию
|-
|-
|метрическийселектор
|metricSelector
|нить
|string
|Выбирает метрики для запроса по их ключам.
|Выбирает метрики для запроса по их ключам.


Можно указать несколько ключей метрик, разделенных запятыми (например, <code>metrickey1,metrickey2</code>). Чтобы выбрать несколько метрик, принадлежащих одному и тому же родителю, перечислите последнюю часть необходимых ключей метрик в круглых скобках, разделенных запятыми, не затрагивая общую часть. Например, чтобы перечислить метрику <code>builtin:host.cpu.idle</code>и , напишите: .<code>builtin:host.cpu.userbuiltin:host.cpu.(idle,user)</code>
Можно указать несколько ключей метрик, разделенных запятыми (например, <code>metrickey1,metrickey2</code>). Чтобы выбрать несколько метрик, принадлежащих одному и тому же родителю, перечислите последнюю часть необходимых ключей метрик в круглых скобках, разделенных запятыми, не затрагивая общую часть. Например, чтобы перечислить метрику <code>builtin:host.cpu.idle</code>и , напишите: .<code>builtin:host.cpu.userbuiltin:host.cpu.(idle,user)</code>


<code>*</code>Вы можете выбрать полный набор связанных показателей, используя подстановочный знак звездочки ( ). Например, <code>builtin:host.*</code>выбирает все метрики на основе хоста и <code>builtin:*</code>выбирает все метрики, предоставленные Dynatrace.
<code>*</code>Вы можете выбрать полный набор связанных показателей, используя подстановочный знак звездочки ( ). Например, <code>builtin:host.*</code>выбирает все метрики на основе хоста и <code>builtin:*</code>выбирает все метрики, предоставленные Ключ-АСТРОМ.


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


Эта конечная точка поддерживает только преобразования , <code>aggregation</code>, <code>merge</code>и <code>parents</code>.<code>splitBy</code>
Эта конечная точка поддерживает только преобразования , <code>aggregation</code>, <code>merge</code>и <code>parents</code>.<code>splitBy</code>
Строка 83: Строка 83:
|по желанию
|по желанию
|-
|-
|текст
|text
|нить
|string
|Критерий поиска реестра метрик. Показывать только те метрики, которые содержат термин в своем ключе, отображаемом имени или описании. Используйте этот <code>metricSelector</code>параметр вместо этого, чтобы выбрать полную иерархию метрик вместо текстового поиска.
|Критерий поиска реестра метрик. Показывать только те метрики, которые содержат термин в своем ключе, отображаемом имени или описании. Используйте этот <code>metricSelector</code>параметр вместо этого, чтобы выбрать полную иерархию метрик вместо текстового поиска.
|запрос
|запрос
|по желанию
|по желанию
|-
|-
|поля
|fields
|нить
|string
|Определяет список свойств метрик, включенных в ответ.
|Определяет список свойств метрик, включенных в ответ.


Строка 116: Строка 116:
** <code>score</code>: Метрика оценки — это метрика, где высокие значения указывают на хорошую ситуацию, а низкие значения указывают на проблемы. Примером такой метрики является показатель успешности.
** <code>score</code>: Метрика оценки — это метрика, где высокие значения указывают на хорошую ситуацию, а низкие значения указывают на проблемы. Примером такой метрики является показатель успешности.
** <code>error</code>: Метрика ошибок — это метрика, высокие значения которой указывают на проблему, а низкие значения указывают на хорошую ситуацию. Примером такой метрики является счетчик ошибок.
** <code>error</code>: Метрика ошибок — это метрика, высокие значения которой указывают на проблему, а низкие значения указывают на хорошую ситуацию. Примером такой метрики является счетчик ошибок.
* <code>latency</code>: задержка метрики в минутах. Задержка — это ожидаемая задержка в отчетах (например, вызванная ограничениями поставщиков облачных услуг или других сторонних источников данных) между наблюдением за точкой данных метрики и ее доступностью в Dynatrace. Допустимый диапазон значений от <code>1</code>до <code>60</code>минут.
* <code>latency</code>: задержка метрики в минутах. Задержка — это ожидаемая задержка в отчетах (например, вызванная ограничениями поставщиков облачных услуг или других сторонних источников данных) между наблюдением за точкой данных метрики и ее доступностью в Ключ-АСТРОМ. Допустимый диапазон значений от <code>1</code>до <code>60</code>минут.
* <code>metricSelector</code>: Базовый селектор метрик, используемый func: metric.
* <code>metricSelector</code>: Базовый селектор метрик, используемый func: metric.
* <code>scalar</code>: указывает, разрешается ли выражение метрики в скаляр ( <code>true</code>) или в ряд ( <code>false</code>). Скалярный результат всегда содержит одну точку данных. Количество точек данных в результате серии зависит от используемого разрешения.
* <code>scalar</code>: указывает, разрешается ли выражение метрики в скаляр ( <code>true</code>) или в ряд ( <code>false</code>). Скалярный результат всегда содержит одну точку данных. Количество точек данных в результате серии зависит от используемого разрешения.
Строка 129: Строка 129:
|по желанию
|по желанию
|-
|-
|написаноС тех пор
|writtenSince
|нить
|string
|Фильтрует результирующий набор метрик до тех, которые имеют точки данных в пределах указанного периода времени.
|Фильтрует результирующий набор метрик до тех, которые имеют точки данных в пределах указанного периода времени.


Строка 138: Строка 138:
* Человекочитаемый формат <code>2021-01-25T05:57:01.123+01:00</code>. Если часовой пояс не указан, используется UTC. Вы можете использовать пробел вместо <code>T</code>. Секунды и доли секунды не являются обязательными.
* Человекочитаемый формат <code>2021-01-25T05:57:01.123+01:00</code>. Если часовой пояс не указан, используется UTC. Вы можете использовать пробел вместо <code>T</code>. Секунды и доли секунды не являются обязательными.
* Относительный таймфрейм, назад. Формат: <code>now-NU/A</code>, где <code>N</code>количество времени, <code>U</code>единица времени и <code>A</code>выравнивание. Выравнивание округляет все меньшие значения до ближайшего нуля в прошлом. Например, <code>now-1y/w</code>это один год назад, выровненный на неделю. Вы также можете указать относительный таймфрейм без выравнивания: <code>now-NU</code>. Поддерживаемые единицы времени для относительного таймфрейма:
* Относительный таймфрейм, назад. Формат: <code>now-NU/A</code>, где <code>N</code>количество времени, <code>U</code>единица времени и <code>A</code>выравнивание. Выравнивание округляет все меньшие значения до ближайшего нуля в прошлом. Например, <code>now-1y/w</code>это один год назад, выровненный на неделю. Вы также можете указать относительный таймфрейм без выравнивания: <code>now-NU</code>. Поддерживаемые единицы времени для относительного таймфрейма:
** <code>m</code>: минут
** <code>m</code>: минуты
** <code>h</code>: часы
** <code>h</code>: часы
** <code>d</code>: дней
** <code>d</code>: дни
** <code>w</code>: недели
** <code>w</code>: недели
** <code>M</code>: месяцы
** <code>M</code>: месяцы
Строка 147: Строка 147:
|по желанию
|по желанию
|-
|-
|селектор метаданных
|metadataSelector
|нить
|string
|Область метаданных запроса. В ответ включаются только метрики с указанными свойствами.
|Область метаданных запроса. В ответ включаются только метрики с указанными свойствами.


Строка 159: Строка 159:
Чтобы задать несколько критериев, разделите их запятой ( <code>,</code>). Например, <code>tags("feature","cloud"),unit("Percent"),dimensionKey("location")</code>. В ответ включаются только результаты, соответствующие всем критериям.
Чтобы задать несколько критериев, разделите их запятой ( <code>,</code>). Например, <code>tags("feature","cloud"),unit("Percent"),dimensionKey("location")</code>. В ответ включаются только результаты, соответствующие всем критериям.


Например, чтобы вывести список метрик, у которых есть функция тегов И облако с единицей измерения Проценты ИЛИ Мегабайты И измерение с ключевым местоположением измерения , используйте этот селектор метаданных : <code>tags("feature"),unit("Percent","MegaByte"),tags("cloud"),dimensionKey("location")</code>.
Например, чтобы вывести список метрик, у которых есть функция тегов '''feature''' AND '''cloud''' с единицей измерения '''Percent''' OR '''MegaByte''' AND измерение с измерением ключа '''location''' , используйте следующий '''metadataSelector ''': <code>tags("feature"),unit("Percent","MegaByte"),tags("cloud"),dimensionKey("location")</code>.
|запрос
|запрос
|по желанию
|по желанию
Строка 173: Строка 173:
|-
|-
|200
|200
|Коллекция дескрипторов метрик
|MetricDescriptorCollection
|Успех
|Успех
|-
|-
Строка 191: Строка 191:
=== Объекты тела ответа ===
=== Объекты тела ответа ===


==== Объект _ <code>MetricDescriptorCollection</code> ====
==== Объект <code>MetricDescriptorCollection</code> ====
Список метрик вместе с их дескрипторами.
Список метрик вместе с их дескрипторами.
{| class="wikitable"
{| class="wikitable"
Строка 198: Строка 198:
!Описание
!Описание
|-
|-
|ключ следующей страницы
|nextPageKey
|нить
|string
|Курсор для следующей страницы результатов. Имеет значение <code>null</code>на последней странице.
|Курсор для следующей страницы результатов. Имеет значение <code>null</code>на последней странице.


Используйте его в параметре запроса nextPageKey для получения последующих страниц результата.
Используйте его в параметре запроса nextPageKey для получения последующих страниц результата.
|-
|-
|общее количество
|totalCount
|целое число
|integer
|Предполагаемое количество метрик в результате.
|Предполагаемое количество метрик в результате.
|-
|-
|показатели
|metrics
|Дескриптор метрики []
|MetricDescriptor[]
|Список метрик вместе с их дескрипторами
|Список метрик вместе с их дескрипторами
|-
|-
|предупреждения
|warnings
|строка []
|string []
|Список возможных предупреждений о запросе. Например, использование устаревших функций и т. д.
|Список возможных предупреждений о запросе. Например, использование устаревших функций и т. д.
|}
|}


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


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


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


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


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


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


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


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


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


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


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


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


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


Строка 353: Строка 353:
* <code>value</code>
* <code>value</code>
|-
|-
|показать имя
|displayName
|нить
|string
|Имя метрики в пользовательском интерфейсе.
|Имя метрики в пользовательском интерфейсе.
|-
|-
|описание
|description
|нить
|string
|Краткое описание метрики.
|Краткое описание метрики.
|-
|-
|преобразования
|transformations
|строка []
|string []
|Операторы преобразования, которые можно добавить к текущему списку преобразований.
|Операторы преобразования, которые можно добавить к текущему списку преобразований.


Строка 389: Строка 389:
* <code>toUnit</code>
* <code>toUnit</code>
|-
|-
|Ед. изм
|unit
|нить
|string
|Единица измерения.
|Единица измерения.
|-
|-
|предупреждения
|warnings
|строка []
|string[]
|Список потенциальных предупреждений, влияющих на этот идентификатор. Например, использование устаревших функций и т. д.
|Список потенциальных предупреждений, влияющих на этот идентификатор. Например, использование устаревших функций и т. д.
|-
|-
|созданный
|created
|целое число
|integer
|Отметка времени создания метрики.
|Отметка времени создания метрики.


Строка 404: Строка 404:
|}
|}


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


Строка 426: Строка 426:
|}
|}


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


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


Строка 456: Строка 456:
|}
|}


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


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


Строка 489: Строка 489:
* <code>VOID</code>
* <code>VOID</code>
|-
|-
|индекс
|index
|целое число
|integer
|Уникальный индекс измерения, начинающийся с 0.
|Уникальный индекс измерения, начинающийся с 0.


Строка 496: Строка 496:
|}
|}


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


Строка 625: Строка 625:
Ответ имеет <code>application/json</code>формат и усекается до четырех записей.
Ответ имеет <code>application/json</code>формат и усекается до четырех записей.


==== Завиток ====
==== Curl ====
  <code>curl -L -X GET '<nowiki>https://mySampleEnv.live.dynatrace.com/api/v2/metrics?fields=unit,aggregationTypes&metricSelector=builtin:*'</nowiki> \
  <code>curl -L -X GET '<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/metrics?fields=unit,aggregationTypes&metricSelector=builtin:*'</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>


==== URL-адрес запроса ====
==== URL-адрес запроса ====
  <code><nowiki>https://mySampleEnv.live.dynatrace.com/api/v2/metrics?fields=unit,aggregationTypes&metricSelector=builtin:*</nowiki></code>
  <code><nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/metrics?fields=unit,aggregationTypes&metricSelector=builtin:*</nowiki></code>


==== Тело ответа ====
==== Тело ответа ====

Версия 16:04, 7 октября 2022

Список всех доступных показателей.

Вы можете ограничить вывод, используя нумерацию страниц:

  1. Укажите количество результатов на странице в параметре запроса pageSize .
  2. Затем используйте курсор из поля nextPageKey предыдущего ответа в параметре запроса nextPageKey для получения последующих страниц.

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

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

Если с запросом не предоставлен заголовок Acceptapplication/json , возвращается полезная нагрузка.

GET Managed https://{your-domain}/e/{your-environment-id}/api/v2/metrics
SaaS https://{your-environment-id}.live.кruscomtech.ru/api/v2/metrics
Окружающая среда АктивногоШлюза https://{your-activegate-domain}/e/{your-environment-id}/api/v2/metrics

Аутентификация

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

Параметры

Параметр Тип Описание В Необходимый
nextPageKey string Курсор для следующей страницы результатов. Вы можете найти его в поле nextPageKey предыдущего ответа.

Первая страница всегда возвращается, если вы не укажете параметр запроса nextPageKey .

Когда nextPageKey настроен на получение последующих страниц, вы должны опустить все остальные параметры запроса.

запрос по желанию
pageSize integer Количество метрических схем в полезной нагрузке одного ответа.

Максимально допустимый размер страницы – 500.

Если не установлено, используется 100.

Если используется значение выше 500, возвращается только 500 результатов на страницу.

запрос по желанию
metricSelector string Выбирает метрики для запроса по их ключам.

Можно указать несколько ключей метрик, разделенных запятыми (например, metrickey1,metrickey2). Чтобы выбрать несколько метрик, принадлежащих одному и тому же родителю, перечислите последнюю часть необходимых ключей метрик в круглых скобках, разделенных запятыми, не затрагивая общую часть. Например, чтобы перечислить метрику builtin:host.cpu.idleи , напишите: .builtin:host.cpu.userbuiltin:host.cpu.(idle,user)

*Вы можете выбрать полный набор связанных показателей, используя подстановочный знак звездочки ( ). Например, builtin:host.*выбирает все метрики на основе хоста и builtin:*выбирает все метрики, предоставленные Ключ-АСТРОМ.

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

Эта конечная точка поддерживает только преобразования , aggregation, mergeи parents.splitBy

Если ключ метрики содержит какие-либо символы, ключ необходимо заключить в кавычки ( "). Следующие символы внутри заключенного в кавычки метрического ключа должны быть экранированы тильдой ( ~):

  • Цитаты ( ")
  • Тильд ( ~)

Например, чтобы запросить метрику с ключом ext:selfmonitoring.jmx.Agents: Введите «APACHE» , вы должны указать этот селектор:

"ext:selfmonitoring.jmx.Agents: Type ~"APACHE~""

Чтобы найти метрики на основе условия поиска, а не metricId, используйте текстовый параметр запроса вместо этого.

запрос по желанию
text string Критерий поиска реестра метрик. Показывать только те метрики, которые содержат термин в своем ключе, отображаемом имени или описании. Используйте этот metricSelectorпараметр вместо этого, чтобы выбрать полную иерархию метрик вместо текстового поиска. запрос по желанию
fields string Определяет список свойств метрик, включенных в ответ.

metricIdвсегда включается в результат. Доступны следующие дополнительные свойства:

  • displayName: имя метрики в пользовательском интерфейсе. Включено по умолчанию.
  • description: краткое описание метрики. Включено по умолчанию.
  • unit: единица измерения. Включено по умолчанию.
  • tags: теги метрики.
  • dduBillable: индикатор того, расходуются ли при использовании метрики единицы данных Дейвиса .
  • created: Отметка времени (в миллисекундах UTC), когда метрика была создана.
  • lastWritten: Отметка времени (в миллисекундах UTC), когда точки данных метрики были записаны в последний раз.
  • aggregationTypes: список разрешенных агрегаций для метрики. Обратите внимание, что после применения преобразования оно может измениться .
  • defaultAggregation: Агрегирование метрики по умолчанию. Он используется, когда агрегация не указана или задано :autoпреобразование.
  • dimensionDefinitions: точное разделение метрик (например, группа процессов и идентификатор процесса для некоторой связанной с процессом метрики).
  • transformations: список преобразований , которые можно применить к метрике.
  • entityType: список типов объектов, поддерживаемых метрикой.
  • minimumValue: минимально допустимое значение метрики.
  • maximumValue: Максимально допустимое значение метрики.
  • rootCauseRelevant: Связана ли (истина или ложь) метрика с первопричиной проблемы. Метрика, относящаяся к первопричине, представляет собой надежный индикатор неисправного компонента.
  • impactRelevant: Относится ли метрика к влиянию проблемы (верно или нет). Метрика, имеющая отношение к влиянию, сильно зависит от других метрик и изменений, поскольку базовая метрика первопричины изменилась.
  • metricValueType: тип значения метрики. У вас есть следующие варианты:
    • score: Метрика оценки — это метрика, где высокие значения указывают на хорошую ситуацию, а низкие значения указывают на проблемы. Примером такой метрики является показатель успешности.
    • error: Метрика ошибок — это метрика, высокие значения которой указывают на проблему, а низкие значения указывают на хорошую ситуацию. Примером такой метрики является счетчик ошибок.
  • latency: задержка метрики в минутах. Задержка — это ожидаемая задержка в отчетах (например, вызванная ограничениями поставщиков облачных услуг или других сторонних источников данных) между наблюдением за точкой данных метрики и ее доступностью в Ключ-АСТРОМ. Допустимый диапазон значений от 1до 60минут.
  • metricSelector: Базовый селектор метрик, используемый func: metric.
  • scalar: указывает, разрешается ли выражение метрики в скаляр ( true) или в ряд ( false). Скалярный результат всегда содержит одну точку данных. Количество точек данных в результате серии зависит от используемого разрешения.
  • resolutionInfSupported: если true, разрешение=Inf может быть применено к запросу метрики.

Чтобы добавить свойства, перечислите их с начальным плюсом +. Чтобы исключить свойства по умолчанию, перечислите их с начальным минусом -.

Чтобы указать несколько свойств, соедините их запятой (например, fields=+aggregationTypes,-description).

Если указать только одно свойство, ответ будет содержать ключ метрики и указанное свойство. Чтобы вернуть только ключи метрик, укажите metricIdздесь.

запрос по желанию
writtenSince string Фильтрует результирующий набор метрик до тех, которые имеют точки данных в пределах указанного периода времени.

Вы можете использовать один из следующих форматов:

  • Отметка времени в миллисекундах UTC.
  • Человекочитаемый формат 2021-01-25T05:57:01.123+01:00. Если часовой пояс не указан, используется UTC. Вы можете использовать пробел вместо T. Секунды и доли секунды не являются обязательными.
  • Относительный таймфрейм, назад. Формат: now-NU/A, где Nколичество времени, Uединица времени и Aвыравнивание. Выравнивание округляет все меньшие значения до ближайшего нуля в прошлом. Например, now-1y/wэто один год назад, выровненный на неделю. Вы также можете указать относительный таймфрейм без выравнивания: now-NU. Поддерживаемые единицы времени для относительного таймфрейма:
    • m: минуты
    • h: часы
    • d: дни
    • w: недели
    • M: месяцы
    • y: годы
запрос по желанию
metadataSelector string Область метаданных запроса. В ответ включаются только метрики с указанными свойствами.

Вы можете установить один или несколько из следующих критериев. Значения чувствительны к регистру и используется EQUALSоператор. Если указано несколько значений, применяется логика ИЛИ .

  • unit("unit-1","unit-2")
  • tags("tag-1","tag-2")
  • dimensionKey("dimkey")Вы можете указать только одно значение. Фильтрация применяется только к измерениям, которые были записаны в течение последних 14 дней.

Чтобы задать несколько критериев, разделите их запятой ( ,). Например, tags("feature","cloud"),unit("Percent"),dimensionKey("location"). В ответ включаются только результаты, соответствующие всем критериям.

Например, чтобы вывести список метрик, у которых есть функция тегов feature AND cloud с единицей измерения Percent OR MegaByte AND измерение с измерением ключа location , используйте следующий metadataSelector : tags("feature"),unit("Percent","MegaByte"),tags("cloud"),dimensionKey("location").

запрос по желанию

Ответ

Коды ответов

Код Тип Описание
200 MetricDescriptorCollection Успех
400 Ошибка синтаксиса или проверки. metricSelector или поля содержат синтаксические или семантические ошибки.
404 Метрика не найдена.
406 Неприемлимо. Запрошенный тип носителя не поддерживается. Проверьте заголовок Accept вашего запроса.

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

Объект MetricDescriptorCollection

Список метрик вместе с их дескрипторами.

Элемент Тип Описание
nextPageKey string Курсор для следующей страницы результатов. Имеет значение nullна последней странице.

Используйте его в параметре запроса nextPageKey для получения последующих страниц результата.

totalCount integer Предполагаемое количество метрик в результате.
metrics MetricDescriptor[] Список метрик вместе с их дескрипторами
warnings string [] Список возможных предупреждений о запросе. Например, использование устаревших функций и т. д.

Объект MetricDescriptor

Дескриптор метрики.

Элемент Тип Описание
dimensionCardinalities MetricDimensionCardinality[] Количество элементов метрических измерений MINT.
minimumValue number Минимально допустимое значение метрики.

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

maximumValue number Максимально допустимое значение метрики.

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

latency integer Задержка показателя в минутах.

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

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

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

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

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

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

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

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

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

  • binary
  • decimal
rootCauseRelevant boolean Метрика является ( true) или не является ( false) релевантной для основной причины.

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

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

dduBillable boolean Если trueиспользование метрики потребляет единицы данных Дэвиса .

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

defaultAggregation MetricDefaultAggregation Агрегирование метрики по умолчанию.
lastWritten integer Отметка времени последней записи метрики.

Имеет значение nullдля метрических выражений или если данные никогда не записывались.

impactRelevant boolean Метрика является ( true) или не является ( false) релевантной для воздействия.

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

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

dimensionDefinitions MetricDimensionDefinition[] Точное разделение метрик (например, группа процессов и идентификатор процесса для некоторой метрики, связанной с процессом).

Для загруженных показателей параметры, по которым не было данных за последние 15 дней, опускаются.

metricValueType MetricValueType Тип значения для метрики.
tags string [] Теги, примененные к метрике.

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

entityType string [] Список допустимых основных типов сущностей для этой метрики. Может использоваться для typeпредиката в entitySelector.
metricId string Полный ключ метрики.

Если использовалось преобразование, оно отражается в ключе метрики.

metricSelector string Селектор метрик, который используется при запросе метрики func:.
scalar boolean Указывает, разрешается ли метрическое выражение в скаляр ( true) или в ряд ( false). Скалярный результат всегда содержит одну точку данных. Количество точек данных в результате серии зависит от используемого разрешения.
aggregationTypes string [] Список разрешенных агрегаций для этой метрики.

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

  • auto
  • avg
  • count
  • max
  • median
  • min
  • percentile
  • sum
  • value
displayName string Имя метрики в пользовательском интерфейсе.
description string Краткое описание метрики.
transformations string [] Операторы преобразования, которые можно добавить к текущему списку преобразований.

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

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

Встроенные метрики и выражения метрик имеют значение null.

Объект MetricDimensionCardinality

Количество элементов измерения метрики.

Элемент Тип Описание
relative number Относительная кардинальность измерения, выраженная в процентах
estimate integer Оценка количества элементов измерения.
key string Ключ измерения.

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

Объект MetricDefaultAggregation

Агрегирование метрики по умолчанию.

Элемент Тип Описание
parameter number Доставляемый процентиль. Допустимые значения находятся между 0и 100.

Применимо только к percentileтипу агрегации.

type string Тип агрегации по умолчанию.

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

  • auto
  • avg
  • count
  • max
  • median
  • min
  • percentile
  • sum
  • value

Объект MetricDimensionDefinition

Размерность метрики.

Элемент Тип Описание
displayName string Отображаемое имя измерения.
name string Имя измерения.
key string Ключ измерения.

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

type string Тип измерения.

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

  • ENTITY
  • NUMBER
  • OTHER
  • STRING
  • VOID
index integer Уникальный индекс измерения, начинающийся с 0.

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

Объект MetricValueType

Тип значения для метрики.

Элемент Тип Описание
type string Тип значения метрики

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

  • error
  • score
  • unknown

JSON-модель тела ответа

{
  "totalCount": 3,
  "nextPageKey": "ABCDEFABCDEFABCDEF_",
  "metrics": [
    {
      "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"
      }
    },
    {
      "metricId": "builtin:host.cpu.user:splitBy()",
      "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"
      }
    }
  ]
}

Пример

В этом примере запрос запрашивает все встроенные метрики ( для metricSelector установлено значение builtin:*), доступные в среде mySampleEnv . В ответ включаются следующие поля:

  • идентификатор метрики
  • Ед. изм
  • типы агрегации

Для этого для параметра запроса полейunit,aggregationTypes установлено значение .

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

Ответ имеет application/jsonформат и усекается до четырех записей.

Curl

curl -L -X GET 'https://mySampleEnv.live.ruscomtech.ru/api/v2/metrics?fields=unit,aggregationTypes&metricSelector=builtin:*' \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
-H 'Accept: application/json'

URL-адрес запроса

https://mySampleEnv.live.ruscomtech.ru/api/v2/metrics?fields=unit,aggregationTypes&metricSelector=builtin:*

Тело ответа

{
  "totalCount": 1808,
  "nextPageKey": "___a7acX3q0AAAAGAQAJYnVpbHRpbjoqAQA",
  "metrics": [
    {
      "metricId": "builtin:host.cpu.idle",
      "unit": "Percent",
      "aggregationTypes": [
        "auto",
        "avg",
        "max",
        "min"
      ]
    },
    {
      "metricId": "builtin:host.cpu.load",
      "unit": "Ratio",
      "aggregationTypes": [
        "auto",
        "avg",
        "max",
        "min"
      ]
    },
    {
      "metricId": "builtin:service.errors.server.count",
      "unit": "Count",
      "aggregationTypes": [
        "auto",
        "value"
      ]
    },
    {
      "metricId": "builtin:service.keyRequest.count.client",
      "unit": "Count",
      "aggregationTypes": [
        "auto",
        "value"
      ]
    }
  ]
}

Таблица CSV со строкой заголовка выглядит следующим образом. Чтобы получить его, измените заголовок Accepttext/csv; header=present на .

metricId,unit,aggregationTypes
builtin:host.cpu.idle,Percent,"[auto, avg, max, min]"
builtin:host.cpu.load,Ratio,"[auto, avg, max, min]"
builtin:service.errors.server.count,Count,"[auto, value]"
builtin:service.keyRequest.count.client,Count,"[auto, value]"

Код ответа

200