Список всех метрик: различия между версиями

Текущая версия от 12:18, 29 декабря 2024

API АппОптима / Эндпойнты среды / Развёртывание / Метрики v2 / Примеры и варианты использования / Список всех метрик

Конечная точка метрик GET предоставляет вам возможность запрашивать несколько метрик, а также частичные или даже полные дескрипторы метрик.

В этом примере показано, как получить список всех метрик в среде с необходимыми метаданными.

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

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

Настройка запроса

Для получения полного списка метрик необходимо задать следующие параметры запроса:

до 500 символов. Полный список показателей может быть длинным, поэтому мы используем максимально возможное значение.
поля до displayName,unit,aggregationTypes. Это удаляет все остальные поля из полезной нагрузки, оставляя только те, которые нас интересуют. Обратите внимание, что metricIdздесь это опущено, потому что оно всегда представлено в ответе.

Вы можете получить ответ в двух форматах:

JSON: установите для заголовка Acceptapplication/json запроса значение .
Таблица CSV: установите для заголовка Accepttext/csv; header=present запроса значение . Если вас не интересует строка заголовка, используйте text/csv; header=absent.

Чтобы аутентифицировать запрос, установите для заголовка AuthorizationApi-token {your-token} запроса значение . Токен должен иметь разрешение на чтение метрик ( metrics.read)

Curl

Вот Curl-код запроса. Обязательно используйте URL-адрес вашей собственной среды и настоящий токен API.

Полезная нагрузка JSON

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

Полезная нагрузка таблицы CSV

<curl -L -X GET 'https://mySampleEnv.live.ruscomtech.ru/api/v2/metrics?fields=displayName,unit,aggregationTypes&pageSize=500' \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
-H 'Accept: text/csv; header=present'

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

https://mySampleEnv.live.ruscomtech.ru/api/v2/metrics?fields=displayName,unit,aggregationTypes&pageSize=500

Ответ

Полный список метрик слишком длинный, поэтому в каждом случае он усекается до одних и тех же 3 записей.

Полезная нагрузка JSON

<{
  "totalCount": 1812,
  "nextPageKey": null,
  "metrics": [
    {
      "metricId": "builtin:apps.other.apdex.osAndVersion",
      "displayName": "Apdex (by os and app version)",
      "unit": "NotApplicable",
      "aggregationTypes": [
        "auto",
        "value"
      ]
    },
    {
      "metricId": "builtin:apps.other.keyUserActions.requestErrorCount.os",
      "displayName": "Request error count (by os)",
      "unit": "Count",
      "aggregationTypes": [
        "auto",
        "value"
      ]
    },
    {
      "metricId": "builtin:tech.activemq.CurrentConnectionsCount",
      "displayName": "Current connections count",
      "unit": "Count",
      "aggregationTypes": [
        "auto",
        "avg",
        "count",
        "max",
        "min",
        "sum"
      ]
    }
  ]
}

Полезная нагрузка таблицы CSV

<metricId,displayName,unit,aggregationTypes
builtin:apps.other.apdex.osAndVersion,Apdex (by os and app version),NotApplicable,"[auto, value]"
builtin:apps.other.keyUserActions.requestErrorCount.os,Request error count (by os),Count,"[auto, value]"
builtin:tech.activemq.CurrentConnectionsCount,Current connections count,Count,"[auto, avg, count, max, min, sum]

@@ Строка 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] / [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%9F%D1%80%D0%B8%D0%BC%D0%B5%D1%80%D1%8B%20%D0%B8%20%D0%B2%D0%B0%D1%80%D0%B8%D0%B0%D0%BD%D1%82%D1%8B%20%D0%B8%D1%81%D0%BF%D0%BE%D0%BB%D1%8C%D0%B7%D0%BE%D0%B2%D0%B0%D0%BD%D0%B8%D1%8F Примеры и варианты использования] / Список всех метрик'''''
 Конечная точка метрик GET предоставляет вам возможность запрашивать несколько метрик, а также частичные или даже полные дескрипторы метрик.
@@ Строка 25: / Строка 27: @@
 === Полезная нагрузка JSON ===
-  <code>curl -L -X GET '<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/metrics?fields=displayName,unit,aggregationTypes&pageSize=500'</nowiki> \
+  <curl -L -X GET '<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/metrics?fields=displayName,unit,aggregationTypes&pageSize=500'</nowiki> \
   -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
   -H 'Accept: application/json'</code>
 === Полезная нагрузка таблицы CSV ===
-  <code>curl -L -X GET '<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/metrics?fields=displayName,unit,aggregationTypes&pageSize=500'</nowiki> \
+  <curl -L -X GET '<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/metrics?fields=displayName,unit,aggregationTypes&pageSize=500'</nowiki> \
   -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
   -H 'Accept: text/csv; header=present'</code>
@@ Строка 41: / Строка 43: @@
 === Полезная нагрузка JSON ===
-  <code>{
+  <{
     "totalCount": 1812,
     "nextPageKey": null,
@@ Строка 80: / Строка 82: @@
 === Полезная нагрузка таблицы CSV ===
-  <code>metricId,displayName,unit,aggregationTypes
+  <metricId,displayName,unit,aggregationTypes
   builtin:apps.other.apdex.osAndVersion,Apdex (by os and app version),NotApplicable,"[auto, value]"
   builtin:apps.other.keyUserActions.requestErrorCount.os,Request error count (by os),Count,"[auto, value]"
   builtin:tech.activemq.CurrentConnectionsCount,Current connections count,Count,"[auto, avg, count, max, min, sum]</code>