Skip to content

Commit 70d4059

Browse files
committed
doc: add TCP input readme, fix typo in UDP readme
1 parent 4bb0c10 commit 70d4059

File tree

2 files changed

+38
-1
lines changed

2 files changed

+38
-1
lines changed

src/plugins/input/tcp/README.rst

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
TCP (input plugin)
2+
==================
3+
4+
The plugin receives IPFIX messages over TCP transport protocol from one or more exporters
5+
and pass them into the collector. Multiple instances of the plugin can run concurrently.
6+
However, they must listen on different ports or local IP addresses.
7+
8+
Unlike UDP, TCP is reliable transport protocol that allows exporters to detect connection or
9+
disconnection of the collector. Therefore, the issues with templates retransmission and
10+
initial period of inability to interpret flow records does not apply here.
11+
12+
Example configuration
13+
---------------------
14+
15+
.. code-block:: xml
16+
17+
<input>
18+
<name>TCP input</name>
19+
<plugin>tcp</plugin>
20+
<params>
21+
<localPort>4739</localPort>
22+
<localIPAddress></localIPAddress>
23+
</params>
24+
</input>
25+
26+
Parameters
27+
----------
28+
29+
Mandatory parameters:
30+
31+
:``localPort``:
32+
Local port on which the plugin listens. [default: 4739]
33+
:``localIPAddress``:
34+
Local IPv4/IPv6 address on which the TCP input plugin listens. If the element
35+
is left empty, the plugin binds to all available network interfaces. The element can occur
36+
multiple times (one IP address per occurrence) to manually select multiple interfaces.
37+
[default: empty]

src/plugins/input/udp/README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Mandatory parameters:
5454
:``localPort``:
5555
Local port on which the plugin listens. [default: 4739]
5656
:``localIPAddress``:
57-
Local IPv4/IPv6 address an which the UDP input plugin listens. If the element
57+
Local IPv4/IPv6 address on which the UDP input plugin listens. If the element
5858
is left empty, the plugin binds to all available network interfaces. The element can occur
5959
multiple times (one IP address per occurrence) to manually select multiple interfaces.
6060
[default: empty]

0 commit comments

Comments
 (0)