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

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

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

Запрос потребляет и создает 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" : "Dropped TCP connections",
  "unit" : "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