Settings

Basic settings

Flow collection

The main task of the Collector is to accept and store flow from network devices.

Supported protocols:

  • NetFlow v5
  • NetFlow v9
  • IPFIX
  • sFlow v5

Collector settings are specified through environment variables, which are set in the .envfile. Details.

To receive data for each protocol, you need to specify the port to which its packets will be received through environment variables:

IPv4

  • COLLECTOR_NETFLOW_V5_PORT – is the port used to receive NetFlow v5 protocol packets. The default 9555.
  • COLLECTOR_NETFLOW_V9_PORT – is the port used to receive NetFlow v9 protocol packets. The default is 9555.
  • COLLECTOR_IPFIX_UDP_PORT – is the port used to receive ipfix protocol packets. The default is 4739.
  • COLLECTOR_IPFIX_TCP_PORT – is the port used to receive ipfix protocol packets. The default is 4739.
  • COLLECTOR_SFLOW_PORT – is the port used to receive sFlow v5 protocol packets. The default is 6343.

IPv6

Ports for IPv6 traffic are set automatically to one more than the port for IPv4, for example, for netflow v5, port 9556 will be used by default.

ClickHouse setup

Collector saves metrics from incoming packets to ClickHouse, whose coordinates are set via variables:

  • COLLECTOR_CLICKHOUSE_ADDRESS – address of the host with the ClickHouse database. The default is clickhouse:9000.

Integration with MITIGATOR

Grafana setup

Grafana is used to display the metrics collected by Collector. Grafana runs on port 3000, which can be accessed via a browser.

Default login/password: admin/admin.

At the first start, in the Grafana settings, select data sources,
then select Collector. Enter the host where ClickHouse is located in the URL field.

URL recommendation: in base distribution it should match host IP or clickhouse.mitigator.