Skip to content

Commit 146397e

Browse files
committed
doc: introduce example configuration for JSON-Kafka
1 parent e451558 commit 146397e

File tree

2 files changed

+60
-0
lines changed

2 files changed

+60
-0
lines changed
Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
<!--
2+
Receive flow data over UDP, convert them into JSON and provide them as
3+
a server on local port
4+
-->
5+
<ipfixcol2>
6+
<!-- Input plugins -->
7+
<inputPlugins>
8+
<input>
9+
<name>UDP collector</name>
10+
<plugin>udp</plugin>
11+
<params>
12+
<!-- List on port 4739 -->
13+
<localPort>4739</localPort>
14+
<!-- Bind to all local adresses -->
15+
<localIPAddress></localIPAddress>
16+
</params>
17+
</input>
18+
</inputPlugins>
19+
20+
<!-- Output plugins -->
21+
<outputPlugins>
22+
<output>
23+
<name>JSON output</name>
24+
<plugin>json-kafka</plugin>
25+
<params>
26+
<!-- JSON format paramters -->
27+
<tcpFlags>formatted</tcpFlags>
28+
<timestamp>formatted</timestamp>
29+
<protocol>formatted</protocol>
30+
<ignoreUnknown>true</ignoreUnknown>
31+
<ignoreOptions>true</ignoreOptions>
32+
<nonPrintableChar>true</nonPrintableChar>
33+
<octetArrayAsUint>true</octetArrayAsUint>
34+
<numericNames>false</numericNames>
35+
<splitBiflow>false</splitBiflow>
36+
<detailedInfo>false</detailedInfo>
37+
<templateInfo>false</templateInfo>
38+
39+
<!-- Output methods -->
40+
<outputs>
41+
<kafka>
42+
<name>Send to Kafka</name>
43+
<brokers>127.0.0.1</brokers>
44+
<topic>ipfix</topic>
45+
<blocking>false</blocking>
46+
<partition>unassigned</partition>
47+
48+
<!-- Zero or more additional properties -->
49+
<property>
50+
<key>compression.codec</key>
51+
<value>lz4</value>
52+
</property>
53+
</kafka>
54+
</outputs>
55+
</params>
56+
</output>
57+
</outputPlugins>
58+
</ipfixcol2>

doc/sphinx/configuration.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -169,6 +169,8 @@ of IPFIXcol. Always keep in mind that you should modify a configuration to fit y
169169

170170
:`udp2json <../data/configs/udp2json.xml>`_:
171171
Receive flow data over UDP, convert them into JSON and provide them as a server on local port.
172+
:`udp2json-kafka <../data/configs/udp2json-kafka.xml>`_:
173+
Receive flow data over UDP, convert them into JSON and send them to Apache Kafka.
172174
:`tcp2anon2json <../data/configs/tcp2anon2json.xml>`_:
173175
Receive flow data over TCP, anonymize them and store in JSON format on a local drive.
174176
:`tcpUdp2lnf <../data/configs/tcpUdp2lnf.xml>`_:

0 commit comments

Comments
 (0)