GET списка метрик

API АппОптима / Эндпойнты среды / Развёртывание / Таймсерии v1 / Определение метрик / GET списка метрик

Список всех определений метрик, а также параметры каждой метрики, доступные в вашей среде.

Полный список может быть длинным, но вы можете сузить его, указав параметры фильтра, такие как источник метрики.

Запрос создает application/jsonполезную нагрузку.

GET	АппОптима	https://{your-domain}/e/{your-environment-id}/api/v1/timeseries
	Среда АктивногоШлюза	https://{your-activegate-domain}/e/{your-environment-id}/api/v1/timeseries

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

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

Параметры

Параметр	Тип	Описание	In	Необходимость
source	string	Тип показателя, например BUILTIN или CUSTOM. Элемент может содержать эти значения	query	по желанию
detailedSource	string	Функция, из которой берутся метрики, например, синтетическая или RUM.	query	по желанию

Возможные значения detailedSourceэлемента:

Вы можете найти допустимые значения для detailedSourceэлемента в подзаголовках разделов Встроенные метрики и Плагинные метрики на страницах доступных метрик для SaaS и АппОптима . Используйте их точно так же, как и в заголовках, включая пробелы.

Ответ

Результатом является JSON, содержащий массив объектов, где каждый объект представляет собой метрику.

Коды ответов

Код	Тип	Описание
200	TimeseriesDefinition[]	Успех

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

Объект ResponseBody

Объект не предоставляет никаких параметров.

Объект TimeseriesDefinition

Конфигурация метрики со всеми ее параметрами.

Элемент	Тип	Описание
timeseriesId	string	Идентификатор метрики.
displayName	string	Имя метрики в пользовательском интерфейсе.
dimensions	string[]	Точное разделение метрик, например, группа процессов и идентификатор процесса для какой-либо метрики, связанной с процессом.
aggregationTypes	string[]	Список разрешенных агрегаций для этой метрики. Элемент может содержать эти значения AVG COUNT MAX MEDIAN MIN PERCENTILE SUM
unit	string	Единица измерения. Элемент может содержать эти значения Billion (bilcount) Bit (bit) BitPerHour (bit/h) BitPerMinute (bit/min) BitPerSecond (bit/s) Byte (B) BytePerHour (B/h) BytePerMinute (B/min) BytePerSecond (B/s) Cores Count (count) Day (ds) DecibelMilliWatt (dBm) G GibiByte (GiB) GigaByte (GB) Hour (hs) KibiByte (KiB) KibiBytePerHour (KiB/h) KibiBytePerMinute (KiB/min) KibiBytePerSecond (KiB/s) KiloByte (kB) KiloBytePerHour (kB/h) KiloBytePerMinute (kB/min) KiloBytePerSecond (kB/s) M MSU MebiByte (MiB) MebiBytePerHour (MiB/h) MebiBytePerMinute (MiB/min) MebiBytePerSecond (MiB/s) MegaByte (MB) MegaBytePerHour (MB/h) MegaBytePerMinute (MB/min) MegaBytePerSecond (MB/s) MicroSecond (µs) MilliSecond (ms) MilliSecondPerMinute (ms/min) Million (milcount) Minute (mins) Month (mos) N/A NanoSecond (ns) NanoSecondPerMinute (ns/min) PerHour (count/h) PerMinute (count/min) PerSecond (count/s) Percent (%) Pixel (px) Promille (‰) Ratio Second (s) State Unspecified Week (ws) Year (ys) k km/h m/h m/s mCores
filter	string	Функция, из которой берется метрика. Элемент может содержать эти значения ALL BUILTIN CUSTOM PLUGIN REMOTE_PLUGIN
detailedSource	string	Функция, из которой берется метрика.
pluginId	string	Идентификатор плагина, из которого создается метрика.
types	string []	Определение типа технологии. Используется для группировки метрик под логическим именем технологии.
warnings	string []	Предупреждения, возникшие при создании метрики.

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

<[
  {
    "timeseriesId": "com.ruscomtech.builting:host.cpu.idle",
    "displayName": "CPU idle",
    "dimensions": [
      "HOST"
    ],
    "aggregationTypes": [
      "AVG",
      "SUM",
      "MIN",
      "MAX"
    ],
    "unit": "Percent",
    "filter": "BUILTIN",
    "detailedSource": "Infrastructure",
    "types": [
      "Test"
    ],
    "warnings": []
  }
]

Пример

В этом примере в запросе указана метрика типа PLUGIN , где подробный источник — PHP-FPM .

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

Результат усекается до двух записей.

Curl

<curl -X GET \
  'https://mySampleEnv.live.ruscomtech.ru/api/v1/timeseries?source=plugin&detailedsource=PHP-FPM' \
  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

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

https://mySampleEnv.live.ruscomtech.ru/api/v1/timeseries?api-token&source=plugin&detailedsource=PHP-FPM

Содержание ответа

<[
  {
    "timeseriesId": "beta.python.phpfpm.dev:accepted conn",
    "displayName": "accepted conn",
    "dimensions": [
      "PROCESS_GROUP_INSTANCE",
      "pool"
    ],
    "aggregationTypes": [
      "AVG",
      "SUM",
      "MIN",
      "MAX"
    ],
    "unit": "Count (count)",
    "filter": "PLUGIN",
    "detailedSource": "PHP-FPM",
    "pluginId": "beta.python.phpfpm.dev",
    "types": []
   },
   {
     "timeseriesId": "beta.python.phpfpm.dev:active processes",
     "displayName": "active processes",
     "dimensions": [
       "PROCESS_GROUP_INSTANCE",
       "pool"
     ],
    "aggregationTypes": [
      "AVG",
      "SUM",
      "MIN",
      "MAX"
    ],
    "unit": "Count (count)",
    "filter": "PLUGIN",
    "detailedSource": "PHP-FPM",
    "pluginId": "beta.python.phpfpm.dev",
    "types": []
  }
]

Код ответа

200

Типы процессов

Список известных типов процессов, которые мы отслеживаем с помощью АппОптима, постоянно растет. Если вы не видите нужный тип процесса в приведенном ниже списке, перейдите на страницу процессов АппОптима, чтобы узнать, включен ли туда этот процесс.

Cписок типов процессов:

apachehttp apmng awsrds cassandra couchdb db2 dockerdaemon dotnet erlang glassfish

haproxy iis iisapppool java jboss linuxsystem memcached mongodb mongodbrouter

mssql mysql nginx nodejs oracledb perl php postgres python

redis ruby tomcat unknown varnishcache weblogic websphere windowsservice windowssystem

Типы ОС

Список известных операционных систем, которые мы отслеживаем с помощью АппОптима, постоянно растет. Если вы не видите нужный тип ОС в списке ниже, обратитесь к странице хостов АппОптима, чтобы узнать, указан ли там тип ОС.

Cписок ОС:

aix darwin hpux linux

solaris unknown windows zos

Типы услуг

Список услуг:

database messaging method mobile process

rmi unknown webrequest webservice website

Типы технологий

Список технологий:

apache dotnet iis java loganalytics net nginx nodejs

os php ruby sdk unknown varnish wsmb z

Типы агрегации

Нажмите, чтобы просмотреть список типов агрегации

максимум минимум сумма считать

среднее медиана процентиль