Получение дескриптора метрики

Материал из Dynatrace
Версия от 16:09, 31 января 2023; ENetrebin (обсуждение | вклад) (→‎URL-адрес запроса)
(разн.) ← Предыдущая | Текущая версия (разн.) | Следующая → (разн.)

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

Запрос создает один из следующих типов полезной нагрузки, в зависимости от значения заголовка запроса 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/{metricKey}
SaaS https://{your-environment-id}.live.dynatrace.com/api/v2/metrics/{metricKey}
Окружающая среда АктивногоШлюза https://{your-activegate-domain}/e/{your-environment-id}/api/v2/metrics/{metricKey}

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

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

Параметры

Параметр Тип Описание In Необходимость
metricKey string Ключ требуемой метрики.

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

path требуется

Ответ

Коды ответов

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

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

Объект MetricDescriptor

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

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

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

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

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

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

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

Допустимый диапазон значений составляет от 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-модель тела ответа

{
  "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
}

Пример

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

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

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

Curl

curl -L -X GET 'https://mySampleEnv.live.dynatrace.com/api/v2/metrics/builtin:host.disk.avail' \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
-H 'Accept: application/json'

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

https://mySampleEnv.live.dynatrace.com/api/v2/metrics/builtin:host.disk.avail

Тело ответа

{
  "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"
    }
  ]
}

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

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]

Код ответа

200

Источник — https://doc.expert-apm.kz/index.php?title=Получение_дескриптора_метрики&oldid=2939