API

Основная задача Collector – принять и сохранить flow с сетевых устройств.

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

По умолчанию список пар «адрес-семплирование» пуст, вследствие чего Collector не обрабатывает пришедшие flow. Для их обработки необходимо добавить список с помощью RESTful HTTP API, представленного ниже.

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

В качестве параметров запросов выступают:

  • ip – адрес сетевого устройства, которое присылает flow.
  • sample – коэффициент семплирования flow для сетевого устройства. Показывает, сколько пакетов характеризуется данным пакетом. По умолчанию 1.

Получение списка маршрутизаторов

  • Путь: /exporters

  • Метод: GET

  • Ответ:

    
    [
      {
        "ip": "192.168.0.1",
        "sample": 10,
        "active_timeout": 30,
        "inactive_timeout": 30
      }
    ]
    

Установка списка маршрутизаторов

  • Путь: /exporters

  • Метод: POST

  • Данные:

    [
      {
        "src": "192.168.0.1",
        "sample": 10,
        "active_timeout": 30,
        "inactive_timeout": 30
      },
      {
        "src": "192.168.0.2",
        "sample": 1,
        "active_timeout": 30,
        "inactive_timeout": 30
      }
    ]
    

Очистка списка маршрутизаторов

  • Путь: /exporters
  • Метод: DELETE