ENetrebin (обсуждение | вклад) (Новая страница: «Отправляет пользовательские точки данных в Ключ-АСТРОМ. Предоставленные точки данных д...») |
Нет описания правки |
||
| (не показана 1 промежуточная версия этого же участника) | |||
| Строка 1: | Строка 1: | ||
'''''[[API АппОптима]] / [[API АппОптима|Эндпойнты среды]] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=DELETE%20%D1%82%D0%B5%D0%B3%D0%BE%D0%B2-,%D0%A0%D0%B0%D0%B7%D0%B2%D1%91%D1%80%D1%82%D1%8B%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5,-%D0%BF%D1%80%D0%B0%D0%B2%D0%B8%D1%82%D1%8C Развёртывание] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=POST%20%D1%82%D0%BE%D1%87%D0%B5%D0%BA%20%D0%B4%D0%B0%D0%BD%D0%BD%D1%8B%D1%85-,%D0%9C%D0%B5%D1%82%D1%80%D0%B8%D0%BA%D0%B8%20v2,-GET%20%D0%BC%D0%B5%D1%82%D1%80%D0%B8%D0%BA Метрики v2] / POST введённых точек данных''''' | |||
Предоставленные точки данных должны соответствовать протоколу приема метрик. Вам не нужно сначала регистрировать метрику. После того, как | Отправляет пользовательские точки данных в АппОптима. | ||
Предоставленные точки данных должны соответствовать протоколу приема метрик. Вам не нужно сначала регистрировать метрику. После того, как АппОптима приняла и обработала данные, вы можете использовать их так же, как и любые другие показатели в АппОптима, например, в диаграммах или событиях показателей. Вы также можете предоставить метаданные для введенной метрики через API настроек. | |||
Предпочитаете использовать метрики прямо на хосте? | Предпочитаете использовать метрики прямо на хосте? | ||
Вы также можете передавать точки данных напрямую с узла, контролируемого ЕдиногоАгента, в модуль ЕдиныйАгент Extensions Execution Controller (EEC) по защищенному каналу с использованием локальной <code><nowiki>http://localhost</nowiki>:<port>/metrics/ingest</code>конечной точки, которая не требует проверки подлинности токена. Порт по умолчанию <code>14499</code>. При использовании этого метода <code>dt.entity.host=<host-ID></code>к каждой метрике добавляется зарезервированное измерение | Вы также можете передавать точки данных напрямую с узла, контролируемого ЕдиногоАгента, в модуль ЕдиныйАгент Extensions Execution Controller (EEC) по защищенному каналу с использованием локальной <code><nowiki>http://localhost</nowiki>:<port>/metrics/ingest</code>конечной точки, которая не требует проверки подлинности токена. Порт по умолчанию <code>14499</code>. При использовании этого метода <code>dt.entity.host=<host-ID></code>к каждой метрике добавляется зарезервированное измерение АппОптима. Дополнительные сведения см. в разделе API метрик ЕдиногоАгента . | ||
Для просмотра точек данных введенной метрики можно использовать: | Для просмотра точек данных введенной метрики можно использовать: | ||
| Строка 15: | Строка 17: | ||
{| class="wikitable" | {| class="wikitable" | ||
| rowspan="2" |POST | | rowspan="2" |POST | ||
| | |АппОптима | ||
|<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> | ||
|- | |- | ||
| Строка 61: | Строка 63: | ||
== Пример == | == Пример == | ||
<code>curl</code>С помощью этой команды вы будете использовать метрику, назначенную измерению.<code>cpu.temperatureHOST-06F288EE2A930951</code> | <code>curl</code>С помощью этой команды вы будете использовать метрику, назначенную измерению.<code>cpu.temperatureHOST-06F288EE2A930951</code> | ||
< | <curl -L -X POST '<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/metrics/ingest'</nowiki> \ | ||
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \ | -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \ | ||
-H 'Content-Type: text/plain' \ | -H 'Content-Type: text/plain' \ | ||
--data-raw 'cpu.temperature,dt.entity.host=HOST-06F288EE2A930951,cpu=1 55' | --data-raw 'cpu.temperature,dt.entity.host=HOST-06F288EE2A930951,cpu=1 55' | ||
Текущая версия от 12:15, 29 декабря 2024
API АппОптима / Эндпойнты среды / Развёртывание / Метрики v2 / POST введённых точек данных
Отправляет пользовательские точки данных в АппОптима.
Предоставленные точки данных должны соответствовать протоколу приема метрик. Вам не нужно сначала регистрировать метрику. После того, как АппОптима приняла и обработала данные, вы можете использовать их так же, как и любые другие показатели в АппОптима, например, в диаграммах или событиях показателей. Вы также можете предоставить метаданные для введенной метрики через API настроек.
Предпочитаете использовать метрики прямо на хосте?
Вы также можете передавать точки данных напрямую с узла, контролируемого ЕдиногоАгента, в модуль ЕдиныйАгент Extensions Execution Controller (EEC) по защищенному каналу с использованием локальной http://localhost:<port>/metrics/ingestконечной точки, которая не требует проверки подлинности токена. Порт по умолчанию 14499. При использовании этого метода dt.entity.host=<host-ID>к каждой метрике добавляется зарезервированное измерение АппОптима. Дополнительные сведения см. в разделе API метрик ЕдиногоАгента .
Для просмотра точек данных введенной метрики можно использовать:
- Обозреватель данных
- GET запрос точек данных метрики из API Metric v2.
Запрос использует в качестве полезной нагрузки формат text/plain. Полезная нагрузка ограничена 1,000строками.
| POST | АппОптима | https://{your-domain}/e/{your-environment-id}/api/v2/metrics/ingest
|
| Среда АктивногоШлюза | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/metrics/ingest
|
Аутентификация
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Ingest metrics (metrics.ingest). Чтобы узнать, как получить и использовать его, см. раздел Токены и аутентификация.
Параметры
| Параметр | Тип | Описание | In | Необходимость |
|---|---|---|---|---|
| body | string | Точки данных, указанные в линейном протоколе. Каждая строка представляет одну точку данных. | body | требуется |
Запрос объектов тела
Объект RequestBody
Объект не предоставляет никаких параметров.
Ответ
Коды ответов
| Код | Описание |
|---|---|
| 202 | Предоставленные точки данных метрики принимаются и будут обрабатываться в фоновом режиме. |
| 400 | Некоторые точки данных являются недопустимыми. Допустимые точки данных принимаются и будут обрабатываться в фоновом режиме. |
Пример
curlС помощью этой команды вы будете использовать метрику, назначенную измерению.cpu.temperatureHOST-06F288EE2A930951
<curl -L -X POST 'https://mySampleEnv.live.ruscomtech.ru/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'