Получение списка метрик: различия между версиями
ENetrebin (обсуждение | вклад) (Новая страница: «Список всех определений метрик, а также параметры каждой метрики, доступные в вашей сред...») |
ENetrebin (обсуждение | вклад) |
||
Строка 5: | Строка 5: | ||
Запрос создает <code>application/json</code>полезную нагрузку. | Запрос создает <code>application/json</code>полезную нагрузку. | ||
{| class="wikitable" | {| class="wikitable" | ||
| rowspan="3" | | | rowspan="3" |GET | ||
| | |Managed | ||
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v1/timeseries</nowiki></code> | |<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v1/timeseries</nowiki></code> | ||
|- | |- | ||
Строка 12: | Строка 12: | ||
|<code><nowiki>https://{your-environment-id}.live.dynatrace.com/api/v1/timeseries</nowiki></code> | |<code><nowiki>https://{your-environment-id}.live.dynatrace.com/api/v1/timeseries</nowiki></code> | ||
|- | |- | ||
|Окружающая среда | |Окружающая среда АктивногоШлюза | ||
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v1/timeseries</nowiki></code> | |<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v1/timeseries</nowiki></code> | ||
|} | |} | ||
== Аутентификация == | == Аутентификация == | ||
Чтобы выполнить этот запрос, вам нужен токен доступа с проблемой доступа и каналом событий, метриками и областью топологии ( <code>DataExport</code>) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация . | Чтобы выполнить этот запрос, вам нужен токен доступа с проблемой доступа и каналом событий, метриками и областью топологии ( <code>DataExport</code>) . Чтобы узнать, как его получить и использовать, см. раздел [[Токены и аутентификация (API)|Токены и аутентификация]] . | ||
== Параметры == | == Параметры == | ||
Строка 24: | Строка 24: | ||
!Тип | !Тип | ||
!Описание | !Описание | ||
! | !In | ||
!Необходимый | !Необходимый | ||
|- | |- | ||
| | |source | ||
| | |string | ||
|Тип показателя, например BUILTIN или CUSTOM. | |Тип показателя, например BUILTIN или CUSTOM. | ||
Элемент может содержать эти значения | Элемент может содержать эти значения | ||
| | |query | ||
|по желанию | |по желанию | ||
|- | |- | ||
| | |detailedSource | ||
| | |string | ||
|Функция, из которой берутся метрики, например, синтетическая или RUM. | |Функция, из которой берутся метрики, например, синтетическая или RUM. | ||
| | |query | ||
|по желанию | |по желанию | ||
|} | |} | ||
Строка 55: | Строка 55: | ||
|- | |- | ||
|200 | |200 | ||
| | |TimeseriesDefinition[] | ||
|Успех | |Успех | ||
|} | |} | ||
Строка 71: | Строка 71: | ||
!Описание | !Описание | ||
|- | |- | ||
| | |timeseriesId | ||
| | |string | ||
|Идентификатор метрики. | |Идентификатор метрики. | ||
|- | |- | ||
| | |displayName | ||
| | |string | ||
|Имя метрики в пользовательском интерфейсе. | |Имя метрики в пользовательском интерфейсе. | ||
|- | |- | ||
| | |dimensions | ||
| | |string[] | ||
|Точное разделение метрик, например, группа процессов и идентификатор процесса для какой-либо метрики, связанной с процессом. | |Точное разделение метрик, например, группа процессов и идентификатор процесса для какой-либо метрики, связанной с процессом. | ||
|- | |- | ||
| | |aggregationTypes | ||
| | |string[] | ||
|Список разрешенных агрегаций для этой метрики. | |Список разрешенных агрегаций для этой метрики. | ||
Элемент может содержать эти значения | Элемент может содержать эти значения | ||
* <code>AVG</code> | |||
* <code>COUNT</code> | |||
* <code>MAX</code> | |||
* <code>MEDIAN</code> | |||
* <code>MIN</code> | |||
* <code>PERCENTILE</code> | |||
* <code>SUM</code> | |||
|- | |- | ||
| | |unit | ||
| | |string | ||
|Единица измерения. | |Единица измерения. | ||
Элемент может содержать эти значения | Элемент может содержать эти значения | ||
* <code>Billion (bilcount)</code> | |||
* <code>Bit (bit)</code> | |||
* <code>BitPerHour (bit/h)</code> | |||
* <code>BitPerMinute (bit/min)</code> | |||
* <code>BitPerSecond (bit/s)</code> | |||
* <code>Byte (B)</code> | |||
* <code>BytePerHour (B/h)</code> | |||
* <code>BytePerMinute (B/min)</code> | |||
* <code>BytePerSecond (B/s)</code> | |||
* <code>Cores</code> | |||
* <code>Count (count)</code> | |||
* <code>Day (ds)</code> | |||
* <code>DecibelMilliWatt (dBm)</code> | |||
* <code>G</code> | |||
* <code>GibiByte (GiB)</code> | |||
* <code>GigaByte (GB)</code> | |||
* <code>Hour (hs)</code> | |||
* <code>KibiByte (KiB)</code> | |||
* <code>KibiBytePerHour (KiB/h)</code> | |||
* <code>KibiBytePerMinute (KiB/min)</code> | |||
* <code>KibiBytePerSecond (KiB/s)</code> | |||
* <code>KiloByte (kB)</code> | |||
* <code>KiloBytePerHour (kB/h)</code> | |||
* <code>KiloBytePerMinute (kB/min)</code> | |||
* <code>KiloBytePerSecond (kB/s)</code> | |||
* <code>M</code> | |||
* <code>MSU</code> | |||
* <code>MebiByte (MiB)</code> | |||
* <code>MebiBytePerHour (MiB/h)</code> | |||
* <code>MebiBytePerMinute (MiB/min)</code> | |||
* <code>MebiBytePerSecond (MiB/s)</code> | |||
* <code>MegaByte (MB)</code> | |||
* <code>MegaBytePerHour (MB/h)</code> | |||
* <code>MegaBytePerMinute (MB/min)</code> | |||
* <code>MegaBytePerSecond (MB/s)</code> | |||
* <code>MicroSecond (µs)</code> | |||
* <code>MilliSecond (ms)</code> | |||
* <code>MilliSecondPerMinute (ms/min)</code> | |||
* <code>Million (milcount)</code> | |||
* <code>Minute (mins)</code> | |||
* <code>Month (mos)</code> | |||
* <code>N/A</code> | |||
* <code>NanoSecond (ns)</code> | |||
* <code>NanoSecondPerMinute (ns/min)</code> | |||
* <code>PerHour (count/h)</code> | |||
* <code>PerMinute (count/min)</code> | |||
* <code>PerSecond (count/s)</code> | |||
* <code>Percent (%)</code> | |||
* <code>Pixel (px)</code> | |||
* <code>Promille (‰)</code> | |||
* <code>Ratio</code> | |||
* <code>Second (s)</code> | |||
* <code>State</code> | |||
* <code>Unspecified</code> | |||
* <code>Week (ws)</code> | |||
* <code>Year (ys)</code> | |||
* <code>k</code> | |||
* <code>km/h</code> | |||
* <code>m/h</code> | |||
* <code>m/s</code> | |||
* <code>mCores</code> | |||
|- | |- | ||
| | |filter | ||
| | |string | ||
|Функция, из которой берется метрика. | |Функция, из которой берется метрика. | ||
Элемент может содержать эти значения | Элемент может содержать эти значения | ||
* <code>ALL</code> | |||
* <code>BUILTIN</code> | |||
* <code>CUSTOM</code> | |||
* <code>PLUGIN</code> | |||
* <code>REMOTE_PLUGIN</code> | |||
|- | |- | ||
| | |detailedSource | ||
| | |string | ||
|Функция, из которой берется метрика. | |Функция, из которой берется метрика. | ||
|- | |- | ||
| | |pluginId | ||
| | |string | ||
|Идентификатор плагина, из которого создается метрика. | |Идентификатор плагина, из которого создается метрика. | ||
|- | |- | ||
| | |types | ||
| | |string [] | ||
|Определение типа технологии. Используется для группировки метрик под логическим именем технологии. | |Определение типа технологии. Используется для группировки метрик под логическим именем технологии. | ||
|- | |- | ||
| | |warnings | ||
| | |string [] | ||
|Предупреждения, возникшие при создании метрики. | |Предупреждения, возникшие при создании метрики. | ||
|} | |} | ||
Строка 149: | Строка 225: | ||
Результат усекается до двух записей. | Результат усекается до двух записей. | ||
==== | ==== Curl ==== | ||
<code>curl -X GET \ | <code>curl -X GET \ | ||
'<nowiki>https://mySampleEnv.live.dynatrace.com/api/v1/timeseries?source=plugin&detailedsource=PHP-FPM'</nowiki> \ | '<nowiki>https://mySampleEnv.live.dynatrace.com/api/v1/timeseries?source=plugin&detailedsource=PHP-FPM'</nowiki> \ | ||
Строка 203: | Строка 279: | ||
== Типы процессов == | == Типы процессов == | ||
Список известных типов процессов, которые мы отслеживаем с помощью | Список известных типов процессов, которые мы отслеживаем с помощью Ключ-АСТРОМ, постоянно растет. Если вы не видите нужный тип процесса в приведенном ниже списке, перейдите на страницу процессов Ключ-АСТРОМ, чтобы узнать, включен ли туда этот процесс. | ||
Нажмите, чтобы просмотреть список типов процессов | Нажмите, чтобы просмотреть список типов процессов | ||
== типы ОС == | == типы ОС == | ||
Список известных операционных систем, которые мы отслеживаем с помощью | Список известных операционных систем, которые мы отслеживаем с помощью Ключ-АСТРОМ, постоянно растет. Если вы не видите нужный тип ОС в списке ниже, обратитесь к странице хостов Ключ-АСТРОМ, чтобы узнать, указан ли там тип ОС. | ||
Нажмите, чтобы просмотреть список ОС | Нажмите, чтобы просмотреть список ОС |
Версия 20:20, 6 октября 2022
Список всех определений метрик, а также параметры каждой метрики, доступные в вашей среде.
Полный список может быть длинным, но вы можете сузить его, указав параметры фильтра, такие как источник метрики. Дополнительные сведения см. в раскрывающемся разделе « Параметры ».
Запрос создает application/json
полезную нагрузку.
GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v1/timeseries
|
SaaS | https://{your-environment-id}.live.dynatrace.com/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 и Managed . Используйте их точно так же, как и в заголовках, включая пробелы.
Ответ
Результатом является JSON, содержащий массив объектов, где каждый объект представляет собой метрику.
Коды ответов
Код | Тип | Описание |
---|---|---|
200 | TimeseriesDefinition[] | Успех |
Объекты тела ответа
Объект _ ResponseBody
Объект не предоставляет никаких параметров.
Объект _ TimeseriesDefinition
Конфигурация метрики со всеми ее параметрами.
Элемент | Тип | Описание |
---|---|---|
timeseriesId | string | Идентификатор метрики. |
displayName | string | Имя метрики в пользовательском интерфейсе. |
dimensions | string[] | Точное разделение метрик, например, группа процессов и идентификатор процесса для какой-либо метрики, связанной с процессом. |
aggregationTypes | string[] | Список разрешенных агрегаций для этой метрики.
Элемент может содержать эти значения
|
unit | string | Единица измерения.
Элемент может содержать эти значения
|
filter | string | Функция, из которой берется метрика.
Элемент может содержать эти значения
|
detailedSource | string | Функция, из которой берется метрика. |
pluginId | string | Идентификатор плагина, из которого создается метрика. |
types | string [] | Определение типа технологии. Используется для группировки метрик под логическим именем технологии. |
warnings | string [] | Предупреждения, возникшие при создании метрики. |
JSON-модель тела ответа
[
{
"timeseriesId": "com.dynatrace.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.dynatrace.com/api/v1/timeseries?source=plugin&detailedsource=PHP-FPM' \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'
URL-адрес запроса
https://mySampleEnv.live.dynatrace.com/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
Типы процессов
Список известных типов процессов, которые мы отслеживаем с помощью Ключ-АСТРОМ, постоянно растет. Если вы не видите нужный тип процесса в приведенном ниже списке, перейдите на страницу процессов Ключ-АСТРОМ, чтобы узнать, включен ли туда этот процесс.
Нажмите, чтобы просмотреть список типов процессов
типы ОС
Список известных операционных систем, которые мы отслеживаем с помощью Ключ-АСТРОМ, постоянно растет. Если вы не видите нужный тип ОС в списке ниже, обратитесь к странице хостов Ключ-АСТРОМ, чтобы узнать, указан ли там тип ОС.
Нажмите, чтобы просмотреть список ОС
Типы услуг
Нажмите, чтобы просмотреть список услуг
Типы технологий
Нажмите, чтобы просмотреть список технологий
Типы агрегации
Нажмите, чтобы просмотреть список типов агрегации
|
|