Документация

Matcher Suggestions API

Версия v2.3.1 · Обновлено

Matcher Suggestions API#

Эндпоинт подсказок матчеров поддерживает общий редактор матчеров, а также может использоваться внешними инструментами администрирования.

GET /api/matchers/suggestions

Требуется аутентификация. Вызывающая сторона должна иметь доступ на чтение к выбранной команде.

Параметры запроса#

ПараметрОбязателенПо умолчаниюОписание
team_idда—Команда, используемая для RBAC и выборки алертов
route_idнет—Ограничить выборку одним маршрутом
service_idнет—Ограничить выборку одним сервисом
limitнет200Сколько недавних алертов проверять, максимум 500
values_limitнет20Количество значений на имя матчера, максимум 50

Пример:

GET /api/matchers/suggestions?team_id=4&service_id=12&limit=100

Пример ответа:

{
  "team_id": 4,
  "route_id": null,
  "service_id": 12,
  "sample_size": 37,
  "sample_limit": 100,
  "values_limit": 20,
  "labels": {
    "alertname": ["DiskFull", "HighLatency"],
    "environment": ["production", "staging"],
    "severity": ["critical", "warning"]
  },
  "fields": {
    "source": ["alertmanager"],
    "status": ["firing", "resolved"],
    "priority": ["p1", "p3"]
  }
}

Эндпоинт возвращает только наблюдаемые значения. Он не вычисляет матчер и не сообщает, какие алерты ему соответствовали бы.