Skip to content

Commit

Permalink
TCP - Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
BonnyAD9 committed Mar 28, 2024
1 parent c7876f9 commit 5fa524c
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions src/plugins/input/tcp/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ Unlike UDP, TCP is reliable transport protocol that allows exporters to detect c
disconnection of the collector. Therefore, the issues with templates retransmission and
initial period of inability to interpret flow records does not apply here.

Received IPFIX messages may be compressed using LZ4 stream compression. The compression is
enabled on the exporter and the plugin detects it automatically.

Example configuration
---------------------

Expand All @@ -35,3 +38,8 @@ Mandatory parameters:
is left empty, the plugin binds to all available network interfaces. The element can occur
multiple times (one IP address per occurrence) to manually select multiple interfaces.
[default: empty]

Notes
-----
The LZ4 compression uses special format that compatible with
`ipfixproble <https://github.com/CESNET/ipfixprobe>`.

0 comments on commit 5fa524c

Please sign in to comment.