API

Collector имеет REST API для управления напрямую без интеграции с MITIGATOR.

API управления

Для доступа к API необходимо в /srv/collector/docker-compose.override.yml поместить следующий текст:

version: "2.2"
services:
  collector-backend:
    ports:
    - "8000:8000"

Затем необходимо перезапустить Collector: docker-compose up -d.

Документация в формате Swagger доступна по адресу: http://$COLLECTOR_HOST_ADDRESS:8000/docs

По умолчанию Collector игнорирует все приходящие данные. Для адреса каждого сетевого устройства, отправляющего данные, задается сэмплирование и тайм-ауты для отслеживания состояния flow. Только после этого Collector начинает учитывать данные с этого адреса.

API получения данных

Для получения данных непосредственно у коллектора используется порт 50055. Значение порта можно изменить через переменную COLLECTOR_API_PORT. За подробностями необходимо обратиться к команде MITIGATOR.