Yandex Cloud
  • Сервисы
  • Решения
  • Почему Yandex Cloud
  • Сообщество
  • Тарифы
  • Документация
  • Связаться с нами
Подключиться
Language / Region
Проект Яндекса
© 2023 ООО «Яндекс.Облако»
Yandex Monitoring
  • Начало работы
  • Пошаговые инструкции
    • Все инструкции
    • Работа с метриками
      • Поставка системных метрик Linux
      • Поставка метрик пользовательских приложений
      • Поставка метрик HAProxy и других сторонних приложений
      • Поставка метрик с хостов вне Yandex Cloud
      • Запись пользовательских метрик через API
      • Получение списка метрик
      • Выгрузка метрик
      • Экспорт метрик в формате Prometheus
    • Работа с дашбордами
      • Создание дашборда
      • Копирование дашборда
      • Добавление виджета на дашборд
      • Удаление виджета с дашборда
      • Удаление дашборда
      • Примеры работы с gRPC API
    • Работа с алертами
      • Создание алерта
      • Создание канала уведомлений
      • Удаление алерта
  • Концепции
    • Обзор сервиса
    • Модель данных
    • Визуализация
      • Обзор
      • Строка запроса
      • Виджеты
      • Дашборд
    • Передача метрик
      • Агент для поставки метрик
        • Обзор
        • Установка и запуск
        • Конфигурирование
        • Рекомендации по использованию агента
    • Язык запросов
    • Алертинг
    • Прореживание данных
    • Удаление устаревших метрик (TTL)
    • Квоты и лимиты
  • Управление доступом
  • Правила тарификации
    • Действующие правила
    • Архив
      • Правила до 1 октября 2020 года
  • Справочник API
    • Аутентификация в API
    • REST
      • Обзор
      • MetricsData
        • Обзор
        • read
        • write
        • prometheusMetrics
      • MetricsMeta
        • Обзор
        • listLabelKeys
        • listLabelValues
        • listMetricNames
        • listMetrics
    • gRPC (англ.)
      • Обзор
      • DashboardService
  • Справочник метрик
  • Вопросы и ответы
    • Общие вопросы
    • Навигация
    • Сбор и экспорт метрик
    • Метрики и единицы измерения
    • Алерты / уведомления
    • Все вопросы на одной странице
  1. Пошаговые инструкции
  2. Работа с метриками
  3. Запись пользовательских метрик через API

Запись пользовательских метрик через API

Статья создана
Yandex Cloud

    Чтобы начать записывать пользовательские метрики через API, воспользуйтесь методом write.

    Перед началом

    Чтобы воспользоваться примерами в этом разделе:

    1. Убедитесь, что у вас установлена утилита cURL, используемая в примерах.

    2. Получите идентификатор каталога, на который у вас есть роль monitoring.editor или выше.

    3. Получите IAM-токен:

      • Инструкция для пользователя с аккаунтом на Яндексе.
      • Инструкция для сервисного аккаунта.
      • Инструкция для федеративного аккаунта.

    Пример запроса

    1. Создайте файл с телом запроса, например body.json. В свойстве metrics перечислите список метрик для записи. Обязательные метки передаются в query-параметрах запроса, а дополнительные — в теле запроса.

      body.json:

      {
          "metrics": [
              {
                  "name": "temperature",
                  "labels": {
                      "building": "office",
                      "room": "openspace"
                  },
                  "value": 18.6
              }
          ]
      }
      
    2. Отправьте запрос и сохраните ответ в файл, например output.json:

      export IAM_TOKEN=CggaATEVAgA...
      curl -X POST \
          -H "Content-Type: application/json" \
          -H "Authorization: Bearer ${IAM_TOKEN}" \
          -d '@body.json' \
          'https://monitoring.api.cloud.yandex.net/monitoring/v2/data/write?folderId=aoe6vrq0g3svvs3uf62u&service=custom' > output.json
      

      Пример ответа на запрос:

      output.json:

      {
          "metrics_written":"1"
      }
      

    Была ли статья полезна?

    Language / Region
    Проект Яндекса
    © 2023 ООО «Яндекс.Облако»