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

Материал из Dynatrace
(Новая страница: «Регистрирует вашу пользовательскую метрику. Вам необходимо указать идентификатор, отоб...»)
 
 
(не показаны 3 промежуточные версии этого же участника)
Строка 5: Строка 5:
Запрос потребляет и создает <code>application/json</code>полезную нагрузку.
Запрос потребляет и создает <code>application/json</code>полезную нагрузку.
{| class="wikitable"
{| class="wikitable"
| rowspan="3" |ПОМЕЩАТЬ
| rowspan="3" |PUT
|Удалось
|Managed
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v1/timeseries/{timeseriesIdentifier}</nowiki></code>
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v1/timeseries/{timeseriesIdentifier}</nowiki></code>
|-
|-
|SaaS
|SaaS
|<code><nowiki>https://{your-environment-id}.live.dynatrace.com/api/v1/timeseries/{timeseriesIdentifier}</nowiki></code>
|<code><nowiki>https://{your-environment-id}.live.dynatrace.com</nowiki><nowiki/>/api/v1/timeseries/{timeseriesIdentifier}</code>
|-
|-
|Окружающая среда ActiveGate
|Окружающая среда АктивногоШлюза
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v1/timeseries/{timeseriesIdentifier}</nowiki></code>
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v1/timeseries/{timeseriesIdentifier}</nowiki></code>
|}
|}


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


== Параметры ==
== Параметры ==
Строка 24: Строка 24:
!Тип
!Тип
!Описание
!Описание
!В
!In
!Необходимый
!Необходимость
|-
|-
|Идентификатор таймсерии
|timeseriesIdentifier
|нить
|string
|Идентификатор новой метрики. Он должен начинаться с <code>custom:</code>префикса.
|Идентификатор новой метрики. Он должен начинаться с <code>custom:</code>префикса.


Строка 36: Строка 36:


Длина идентификатора ограничена 256 символами .
Длина идентификатора ограничена 256 символами .
|дорожка
|path
|требуется
|требуется
|-
|-
|тело
|body
|Сообщение о регистрации таймсерии
|TimeseriesRegistrationMessage
|Тело JSON запроса. Содержит параметры новой пользовательской метрики.
|Тело JSON запроса. Содержит параметры новой пользовательской метрики.
|тело
|body
|по желанию
|по желанию
|}
|}
Строка 48: Строка 48:
=== Объекты тела запроса ===
=== Объекты тела запроса ===


==== Объект _ <code>TimeseriesRegistrationMessage</code> ====
==== Объект <code>TimeseriesRegistrationMessage</code> ====
Определение пользовательской метрики.
Определение пользовательской метрики.
{| class="wikitable"
{| class="wikitable"
Строка 54: Строка 54:
!Тип
!Тип
!Описание
!Описание
!Необходимый
!Необходимость
|-
|-
|показать имя
|displayName
|нить
|string
|Имя показателя, которое будет отображаться в пользовательском интерфейсе. Он ограничен 256 символами.
|Имя показателя, которое будет отображаться в пользовательском интерфейсе. Он ограничен 256 символами.


Строка 63: Строка 63:
|по желанию
|по желанию
|-
|-
|Ед. изм
|unit
|нить
|string
|Единица, которую будет использовать метрика.
|Единица, которую будет использовать метрика.


Строка 134: Строка 134:
|по желанию
|по желанию
|-
|-
|Габаритные размеры
|dimensions
|строка []
|string[]
|Ключ параметра метрики, который будет использоваться для отчета по нескольким параметрам. Например, ключ измерения для отчета о метрике для разных сетевых карт для одного и того же брандмауэра.
|Ключ параметра метрики, который будет использоваться для отчета по нескольким параметрам. Например, ключ измерения для отчета о метрике для разных сетевых карт для одного и того же брандмауэра.


Строка 145: Строка 145:
|по желанию
|по желанию
|-
|-
|типы
|types
|строка []
|string []
|Определение типа техники. Он используется для группировки метрик под логическим именем технологии в пользовательском интерфейсе.
|Определение типа техники. Он используется для группировки метрик под логическим именем технологии в пользовательском интерфейсе.


Строка 180: Строка 180:
|-
|-
|201
|201
|Определение таймсерии
|TimeseriesDefinition
|Успех. Пользовательский показатель создан.
|Успех. Пользовательский показатель создан.
|}
|}
Строка 186: Строка 186:
=== Объекты тела ответа ===
=== Объекты тела ответа ===


==== Объект _ <code>TimeseriesDefinition</code> ====
==== Объект <code>TimeseriesDefinition</code> ====
Конфигурация метрики со всеми ее параметрами.
Конфигурация метрики со всеми ее параметрами.
{| class="wikitable"
{| class="wikitable"
Строка 193: Строка 193:
!Описание
!Описание
|-
|-
|идентификатор таймсерии
|timeseriesId
|нить
|string
|Идентификатор метрики.
|Идентификатор метрики.
|-
|-
|показать имя
|displayName
|нить
|string
|Имя метрики в пользовательском интерфейсе.
|Имя метрики в пользовательском интерфейсе.
|-
|-
|Габаритные размеры
|dimensions
|строка []
|string[]
|Точное разделение метрик, например, группа процессов и идентификатор процесса для какой-либо метрики, связанной с процессом.
|Точное разделение метрик, например, группа процессов и идентификатор процесса для какой-либо метрики, связанной с процессом.
|-
|-
|типы агрегации
|aggregationTypes
|строка []
|string[]
|Список разрешенных агрегаций для этой метрики.
|Список разрешенных агрегаций для этой метрики.


Строка 219: Строка 219:
* <code>SUM</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>
|-
|-
|фильтр
|filter
|нить
|string
|Функция, из которой берется метрика.
|Функция, из которой берется метрика.


Строка 237: Строка 268:
* <code>REMOTE_PLUGIN</code>
* <code>REMOTE_PLUGIN</code>
|-
|-
|подробныйИсточник
|detailedSource
|нить
|string
|Функция, из которой берется метрика.
|Функция, из которой берется метрика.
|-
|-
|идентификатор плагина
|pluginId
|нить
|string
|Идентификатор плагина, из которого создается метрика.
|Идентификатор плагина, из которого создается метрика.
|-
|-
|типы
|types
|строка []
|string []
|Определение типа технологии. Используется для группировки метрик под логическим именем технологии.
|Определение типа технологии. Используется для группировки метрик под логическим именем технологии.
|-
|-
|предупреждения
|warnings
|строка []
|string []
|Предупреждения, возникшие при создании метрики.
|Предупреждения, возникшие при создании метрики.
|}
|}
Строка 283: Строка 314:
Запрос возвращает параметры вновь созданной метрики в качестве подтверждения.
Запрос возвращает параметры вновь созданной метрики в качестве подтверждения.


==== Завиток ====
==== Curl ====
  <code>curl -X PUT \
  <code>curl -X PUT \
   <nowiki>https://mySampleEnv.live.dynatrace.com/api/v1/timeseries/custom:firewall.connections.dropped</nowiki> \
   <nowiki>https://mySampleEnv.live.dynatrace.com/api/v1/timeseries/custom:firewall.connections.dropped</nowiki> \
Строка 289: Строка 320:
   -H 'Content-Type: application/json' \
   -H 'Content-Type: application/json' \
   -d '{
   -d '{
   "displayName" : "Dropped TCP connections",
   "displayName"a: "Dropped TCP connections",
   "unit" : "Count",
   "unit"u: "Count",
   "dimensions": [
   "dimensions": [
     "nic"
     "nic"

Текущая версия на 15:29, 27 января 2023

Регистрирует вашу пользовательскую метрику. Вам необходимо указать идентификатор, отображаемое имя и тип метрики.

Если вы используете идентификатор существующей метрики, соответствующие параметры будут обновлены.

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

PUT Managed https://{your-domain}/e/{your-environment-id}/api/v1/timeseries/{timeseriesIdentifier}
SaaS https://{your-environment-id}.live.dynatrace.com/api/v1/timeseries/{timeseriesIdentifier}
Окружающая среда АктивногоШлюза https://{your-activegate-domain}/e/{your-environment-id}/api/v1/timeseries/{timeseriesIdentifier}

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

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

Параметры

Параметр Тип Описание In Необходимость
timeseriesIdentifier string Идентификатор новой метрики. Он должен начинаться с custom:префикса.

Вы можете использовать буквенно-цифровые символы и следующие знаки препинания: точки ( .), дефисы ( -) и запятые ( ,). Число не может следовать за знаком препинания.

Если вы используете идентификатор существующей метрики, соответствующие параметры будут обновлены.

Длина идентификатора ограничена 256 символами .

path требуется
body TimeseriesRegistrationMessage Тело JSON запроса. Содержит параметры новой пользовательской метрики. body по желанию

Объекты тела запроса

Объект TimeseriesRegistrationMessage

Определение пользовательской метрики.

Элемент Тип Описание Необходимость
displayName string Имя показателя, которое будет отображаться в пользовательском интерфейсе. Он ограничен 256 символами.

Чтобы изменить значение этого поля, вам необходимо разрешение « Запись конфигурации » ( WriteConfig) или « Запись настроек » ( settings.write), назначенное вашему токену API.

по желанию
unit string Единица, которую будет использовать метрика.

Чтобы изменить значение этого поля, вам необходимо разрешение « Запись конфигурации » ( WriteConfig) или « Запись настроек » ( settings.write), назначенное вашему токену API.

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

  • 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
по желанию
dimensions string[] Ключ параметра метрики, который будет использоваться для отчета по нескольким параметрам. Например, ключ измерения для отчета о метрике для разных сетевых карт для одного и того же брандмауэра.

Вы можете использовать буквенно-цифровые символы и следующие знаки препинания: точки ( .), дефисы ( -) и символы подчеркивания ( _).

Параметр CUSTOM_DEVICE автоматически добавляется к каждому новому пользовательскому показателю.

Длина ключей и значений размеров ограничена 128 символами каждый.

по желанию
types string [] Определение типа техники. Он используется для группировки метрик под логическим именем технологии в пользовательском интерфейсе.

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

Например, если вы определяете свое пользовательское устройство с помощью типа F5-Firewall, вы также должны зарегистрировать все связанные с ним пользовательские показатели как тип F5-Firewall.

Поле обязательно для заполнения при создании новой метрики.

по желанию

JSON-модель тела запроса

Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.

{
  "displayName": "received.coffees",
  "unit": "Count",
  "dimensions": [
    "coffee"
  ],
  "types": [
    "coffee machine"
  ]
}

Ответ

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

Коды ответов

Код Тип Описание
201 TimeseriesDefinition Успех. Пользовательский показатель создан.

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

Объект 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)
filter string Функция, из которой берется метрика.

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

  • ALL
  • BUILTIN
  • CUSTOM
  • PLUGIN
  • REMOTE_PLUGIN
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": []
}

Пример

В этом примере запрос создает новую пользовательскую метрику с custom:firewall.connections.droppedидентификатором F5-Firewallтипа. Его единица count. nicКлюч измерения используется для отчета о метрике для разных сетевых карт для одного и того же брандмауэра .

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

Запрос возвращает параметры вновь созданной метрики в качестве подтверждения.

Curl

curl -X PUT \
  https://mySampleEnv.live.dynatrace.com/api/v1/timeseries/custom:firewall.connections.dropped \
  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
  -H 'Content-Type: application/json' \
  -d '{
  "displayName"a: "Dropped TCP connections",
  "unit"u: "Count",
  "dimensions": [
    "nic"
  ],
  "types": [
    "F5-Firewall"
  ]
}'

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

https://mySampleEnv.live.dynatrace.com/api/v1/timeseries/custom:firewall.connections.dropped

Тело запроса

{
  "displayName" : "Dropped TCP connections",
  "unit" : "Count",
  "dimensions": [
    "nic"
  ],
  "types": [
    "F5-Firewall"
  ]
}

Тело ответа

{
  "timeseriesId": "custom:firewall.connections.dropped",
  "displayName": "Dropped TCP connections",
  "dimensions": [
    "CUSTOM_DEVICE",
    "nic"
  ],
  "unit": "Count (count)",
  "detailedSource": "API",
  "types": [
    "F5-Firewall"
  ],
  "aggregationTypes": [
    "AVG",
    "SUM",
    "MIN",
    "MAX"
  ],
  "filter": "CUSTOM"
}

Код ответа

201