agent

Перед работой api сервиса рекомендуется ознакомиться с архитектурой продукта и особенностями обращения к api и возможностями конфигурирования агента системы мониторинга.

Ниже представлена полная документация на api agent компонет мониторинга конечных устройств. Он отвечает за запуск экспортёров, сбор метрик и логов, первичную агрегацию событий.

GET /config

Получение конфигурации

Получает конфигурацию агента в формате YAML

Status Codes:
GET /health

Проверка здоровья

Проверяет, работает ли сервер

Status Codes:
GET /info

Получение информации об агенте

Получает информацию об агенте в формате JSON

Status Codes:
POST /logs/write

Отправка логов в upstreams

Отправляет логи с vector в указанные в конфигурации upstreams

Request JSON Object:

  • [] (object)

Status Codes:

  • 200 OK – Логи успешно отправлены

  • 400 Bad Request – Некорректный JSON в теле запроса

  • 401 Unauthorized – Недействительный AuthToken в заголовке Authorization

  • 500 Internal Server Error – Внутренняя ошибка сервера

Request Headers:

  • X-Am-Proxy-Id – ID агентов-прокси, через которые прошел агент

POST /metrics/write

Отправка метрик в upstreams

Отправляет метрики с vmagent в указанные в конфигурации upstreams

Request JSON Object:

  • [] (integer)

Status Codes:

  • 200 OK – Метрики успешно отправлены

  • 401 Unauthorized – Недействительный AuthToken в заголовке Authorization

  • 500 Internal Server Error – Внутренняя ошибка сервера

Request Headers:

  • X-Am-Agent-Id – ID агента, с которого пришли метрики (если данный сервер - агент-прокси)