Запись пользовательских метрик через API
Статья создана
Обновлена 1 октября 2024 г.
Чтобы начать записывать пользовательские метрики через API, воспользуйтесь методом write.
Перед началом работы
Чтобы воспользоваться примерами в этом разделе:
-
Убедитесь, что у вас установлена утилита cURL
, используемая в примерах. -
Получите идентификатор каталога, на который у вас есть роль
monitoring.editor
или выше. -
Получите IAM-токен:
- Инструкция для пользователя с аккаунтом на Яндексе.
- Инструкция для сервисного аккаунта.
- Инструкция для федеративного аккаунта.
Пример запроса
-
Создайте файл с телом запроса, например
body.json
. В свойствеmetrics
перечислите список метрик для записи. Обязательные метки передаются в query-параметрах запроса, а дополнительные — в теле запроса.body.json:
{ "metrics": [ { "name": "temperature", "labels": { "building": "office", "room": "openspace" }, "value": 18.6 } ] }
-
Отправьте запрос и сохраните ответ в файл, например
output.json
:export IAM_TOKEN=CggaATEVAgA... curl \ --request POST \ --header "Content-Type: application/json" \ --header "Authorization: Bearer ${IAM_TOKEN}" \ --data '@body.json' \ 'https://monitoring.api.cloud.yandex.net/monitoring/v2/data/write?folderId=aoe6vrq0g3sv********&service=custom' > output.json
Пример ответа на запрос:
output.json:
{ "metrics_written":"1" }