SvayaИИ-платформаПлатформаПримерыПродуктыВнедрение

Svaya / Документация / Программный интерфейс

Метрики

Здесь собраны адреса, параметры, поля запросов и коды ответов раздела «Метрики». Каждая операция описана отдельно, с таблицами полей.

Описание собрано из договора core-api, версия 1.12.0. Как получить токен и в каком формате приходят ошибки, написано на странице «Обзор и вход».

Метрики установки в формате федерации Prometheus (тело `/federate` Prometheus установки как есть)

GET /api/core/v1/monitoring/federate операция getMonitoringFederate

Каналы service и staff; действие PDP `read` на `core:monitoring:metrics` (администратор платформы, аудитор установки, внешняя система с возможностью `metrics`). Прокси к `GET {BM_MONITORING_URL}/federate` со сроком 20 с; ответ хранилища больше 64 МБ — 502 `monitoring-unavailable` с текстом «ответ хранилища метрик больше 64 МБ — сузьте селектор». Ошибки (`application/problem+json`): 401 `unauthenticated`; 403 `forbidden` «Нет права на чтение метрик»; 400 `match-invalid` «Селектор метрик не принят»; 502 `monitoring-unavailable` «Хранилище метрик установки не ответило»; 503 `monitoring-not-configured` «В установке нет контура мониторинга» (нет `BM_MONITORING_URL`).

Параметры

ПолеТипОбязательноОписание
match[] (в запросе)string[]нетСелектор Prometheus; параметр повторяется (1…20 раз), каждый селектор — до 512 знаков. Без параметра — `{job=~".+"}`.

Ответы

200. Метрики установки в текстовом формате Prometheus

400. Ошибка RFC 9457

401. Ошибка RFC 9457

403. Ошибка RFC 9457

502. Ошибка RFC 9457

503. Ошибка RFC 9457