POST введённых точек данных: различия между версиями

Материал из Документация Ключ-АСТРОМ
 
Строка 3: Строка 3:
Отправляет пользовательские точки данных в Ключ-АСТРОМ.
Отправляет пользовательские точки данных в Ключ-АСТРОМ.


Предоставленные точки данных должны соответствовать протоколу приема метрик. Вам не нужно сначала регистрировать метрику. После того, как Ключ-АСТРОМ приняла и обработала данные, вы можете использовать их так же, как и любые другие показатели в Ключ-АСТРОМ, например, в диаграммах или событиях показателей. Вы также можете предоставить метаданные для введенной метрики через API настроек.
Доступ к загруженным точкам данных можно получить через:


Предпочитаете использовать метрики прямо на хосте?
* Визуализация данных
* Запрос '''GET''' метрических точек данных '''API Metric v2'''.


Вы также можете передавать точки данных напрямую с узла, контролируемого ЕдиногоАгента, в модуль ЕдиныйАгент Extensions Execution Controller (EEC) по защищенному каналу с использованием локальной <code><nowiki>http://localhost</nowiki>:<port>/metrics/ingest</code>конечной точки, которая не требует проверки подлинности токена. Порт по умолчанию <code>14499</code>. При использовании этого метода <code>dt.entity.host=<host-ID></code>к каждой метрике добавляется зарезервированное измерение Ключ-АСТРОМ. Дополнительные сведения см. в разделе API метрик ЕдиногоАгента .
Предоставленные точки данных должны соответствовать протоколу приема метрик. Предварительно регистрировать метрику не требуется. После того, как Ключ-АСТРОМ получит и обработает данные, вы можете использовать их так же, как и любые другие метрики в Ключ-АСТРОМ, например, в диаграммах или событиях метрик. Вы также можете предоставить метаданные для полученной метрики через '''API''' настроек.


Для просмотра точек данных введенной метрики можно использовать:
<u>Предпочитаете собирать метрики прямо на хосте?</u>


* Обозреватель данных
Вы также можете передавать точки данных непосредственно с хоста, контролируемого ЕдиногоАгента, в модуль ЕдиногоАгента контроллера выполнения расширений (EEC) по защищенному каналу, используя локальную конечную точку <code><nowiki>http://localhost</nowiki>:<port>/metrics/ingest</code>, не требующую аутентификации с помощью токена. Порт по умолчанию — <code>14499</code>. При использовании этого метода зарезервированное измерение Ключ-АСТРОМ <code>dt.entity.host=<host-ID></code> добавляется к каждой метрике.
* GET запрос точек данных метрики из API Metric v2.


Запрос использует в качестве полезной нагрузки формат text/plain. Полезная нагрузка ограничена <code>1,000</code>строками.
Измерение <code>dt.process.id=<PID></code> можно использовать для добавления идентификатора группы процессов. При указании идентификатора группы процессов измерение <code>dt.entity.process_group_instance</code> будет добавлено к заданной метрике. Функция работает только при получении метрик ЕдиныйАгент через API <code>dynatrace_ingest</code>.
{| class="wikitable"
|Вы не можете загрузить метрики с ключевым префиксом <code>dt.</code>— они зарезервированы для использования Ключ-АСТРОМ.
|}
Запрос <code>text/plain</code> использует полезную нагрузку. Размер полезной нагрузки ограничен 1 МБ.
 
Количество показателей не ограничено.
{| class="wikitable"
{| class="wikitable"
| rowspan="2" |POST
| rowspan="2" |POST
Строка 20: Строка 26:
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/metrics/ingest</nowiki></code>
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/metrics/ingest</nowiki></code>
|-
|-
|Среда АктивногоШлюза
|Среда и кластер АктивногоШлюза (порт по умолчанию 9999)
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/metrics/ingest</nowiki></code>
|<code><nowiki>https://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/metrics/ingest</nowiki></code>
|}
|}


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


== Параметры ==
== Параметры ==
Строка 32: Строка 40:
!Тип
!Тип
!Описание
!Описание
!In
!Находится в
!Необходимость
!Необходимость
|-
|-
|body
|body
|string
|string
|Точки данных, указанные в линейном протоколе. Каждая строка представляет одну точку данных.
|Точки данных, представленные в линейном протоколе. Каждая линия представляет собой одну точку данных.
|body
|body
|требуется
|необходимый
|}
|}


=== Запрос объектов тела ===
=== Запрос объекта тела ===


==== Объект <code>RequestBody</code> ====
==== Объект <code>RequestBody</code>====
Объект не предоставляет никаких параметров.


== Ответ ==
== Ответ ==
Строка 52: Строка 59:
{| class="wikitable"
{| class="wikitable"
!Код
!Код
!Тип
!Описание
!Описание
|-
|-
|202
|202
|Предоставленные точки данных метрики принимаются и будут обрабатываться в фоновом режиме.
|Ответ на проверку
|Предоставленные метрические данные принимаются и будут обрабатываться в фоновом режиме.
|-
|-
|400
|400
|Некоторые точки данных являются недопустимыми. Допустимые точки данных принимаются и будут обрабатываться в фоновом режиме.
|Ответ на проверку
|Некоторые точки данных недействительны. Верные точки данных принимаются и будут обработаны в фоновом режиме.
|-
|4ХХ
|Конверт ошибки
|Ошибка на стороне клиента.
|-
|5XX
|Конверт ошибки
|Ошибка на стороне сервера.
|}
|}


== Пример ==
== Пример ==
<code>curl</code>С помощью этой команды вы будете использовать метрику, назначенную измерению.<code>cpu.temperatureHOST-06F288EE2A930951</code>
С помощью этой <code>curl</code> команды вы примете метрику <code>cpu.temperature</code>, назначенную измерению <code>HOST-06F288EE2A930951</code>.
<code>curl -L -X POST '<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/metrics/ingest'</nowiki> \
{| class="wikitable"
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
|curl -L -X POST '<nowiki>https://mySampleEnv.live.dynatrace.com/api/v2/metrics/ingest'</nowiki> \
-H 'Content-Type: text/plain' \
 
--data-raw 'cpu.temperature,dt.entity.host=HOST-06F288EE2A930951,cpu=1 55'</code>
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
 
-H 'Content-Type: text/plain' \
 
--data-raw 'cpu.temperature,dt.entity.host=HOST-06F288EE2A930951,cpu=1 55'
|}

Текущая версия на 16:40, 29 октября 2025

API Ключ-АСТРОМ / Эндпойнты среды / Развёртывание / Метрики v2 / POST введённых точек данных

Отправляет пользовательские точки данных в Ключ-АСТРОМ.

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

  • Визуализация данных
  • Запрос GET метрических точек данных API Metric v2.

Предоставленные точки данных должны соответствовать протоколу приема метрик. Предварительно регистрировать метрику не требуется. После того, как Ключ-АСТРОМ получит и обработает данные, вы можете использовать их так же, как и любые другие метрики в Ключ-АСТРОМ, например, в диаграммах или событиях метрик. Вы также можете предоставить метаданные для полученной метрики через API настроек.

Предпочитаете собирать метрики прямо на хосте?

Вы также можете передавать точки данных непосредственно с хоста, контролируемого ЕдиногоАгента, в модуль ЕдиногоАгента контроллера выполнения расширений (EEC) по защищенному каналу, используя локальную конечную точку http://localhost:<port>/metrics/ingest, не требующую аутентификации с помощью токена. Порт по умолчанию — 14499. При использовании этого метода зарезервированное измерение Ключ-АСТРОМ dt.entity.host=<host-ID> добавляется к каждой метрике.

Измерение dt.process.id=<PID> можно использовать для добавления идентификатора группы процессов. При указании идентификатора группы процессов измерение dt.entity.process_group_instance будет добавлено к заданной метрике. Функция работает только при получении метрик ЕдиныйАгент через API dynatrace_ingest.

Вы не можете загрузить метрики с ключевым префиксом dt.— они зарезервированы для использования Ключ-АСТРОМ.

Запрос text/plain использует полезную нагрузку. Размер полезной нагрузки ограничен 1 МБ.

Количество показателей не ограничено.

POST Managed https://{your-domain}/e/{your-environment-id}/api/v2/metrics/ingest
Среда и кластер АктивногоШлюза (порт по умолчанию 9999) https://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/metrics/ingest

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

Для выполнения этого запроса вам понадобится токен доступа с областью действия metrics.ingest.

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

Параметры

Параметр Тип Описание Находится в Необходимость
body string Точки данных, представленные в линейном протоколе. Каждая линия представляет собой одну точку данных. body необходимый

Запрос объекта тела

Объект RequestBody

Ответ

Коды ответов

Код Тип Описание
202 Ответ на проверку Предоставленные метрические данные принимаются и будут обрабатываться в фоновом режиме.
400 Ответ на проверку Некоторые точки данных недействительны. Верные точки данных принимаются и будут обработаны в фоновом режиме.
4ХХ Конверт ошибки Ошибка на стороне клиента.
5XX Конверт ошибки Ошибка на стороне сервера.

Пример

С помощью этой curl команды вы примете метрику cpu.temperature, назначенную измерению HOST-06F288EE2A930951.

curl -L -X POST 'https://mySampleEnv.live.dynatrace.com/api/v2/metrics/ingest' \

-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \

-H 'Content-Type: text/plain' \

--data-raw 'cpu.temperature,dt.entity.host=HOST-06F288EE2A930951,cpu=1 55'