Skip to content

Commit c00b643

Browse files
author
Pavel Siska
committed
ipfixprobed: Add example YAML configuration
1 parent 1021fb0 commit c00b643

File tree

5 files changed

+97
-0
lines changed

5 files changed

+97
-0
lines changed

init/CMakeLists.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
install(FILES
2+
link0.conf.example
23
DESTINATION ${CMAKE_INSTALL_FULL_SYSCONFDIR}/ipfixprobe
34
)
45

init/link0.conf.example

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
# Input plugin configuration (input_plugin)
2+
input_plugin:
3+
raw:
4+
interface: eth0 # Network interface name
5+
blocks_count: 2048 # Number of blocks in the circular buffer (power of 2)
6+
packets_in_block: 32 # Number of packets in each block (power of 2)
7+
8+
pcap_file:
9+
file: /path/to/pcap/file.pcap # Path to the PCAP file
10+
bpf_filter: null # Optional BPF filter (e.g., "port 80"), null = no filter
11+
12+
pcap_live:
13+
interface: eth0 # Network interface for live capture
14+
bpf_filter: null # BPF filter, null = no filter
15+
snap_length: 65535 # Maximum packet capture length
16+
17+
ndp:
18+
device: /dev/nfb0 # Device for packet capture
19+
queues: "0-15" # List of queues (e.g., "0,1,2-3,7")
20+
21+
dpdk_ring:
22+
ring_name: ring0 # Name of the shared DPDK ring buffer
23+
eal_opts: null # EAL options (null = default)
24+
burst_size: 64 # Number of packets processed in each cycle
25+
26+
dpdk:
27+
allowed_nics: "0000:00:00.0,0000:00:00.1" # List of allowed NICs (PCI addresses)
28+
burst_size: 64 # Number of packets processed in each cycle
29+
mempool_size: 8192 # Size of the memory pool (power of 2)
30+
rx_queues: 1 # Number of RX queues
31+
eal_opts: null # EAL options (null = default)
32+
mtu: null # Maximum Transmission Unit (defaults to RTE_ETHER_MAX_LEN)
33+
34+
# Storage configuration (storage)
35+
storage:
36+
cache:
37+
size_exponent: 20 # Cache size as a power of 2 (2^20)
38+
line_size_exponent: 4 # Cache line size as a power of 2 (2^4)
39+
timeouts:
40+
active: 65 # Active timeout (in seconds)
41+
inactive: 300 # Inactive timeout (in seconds)
42+
split_biflow: true # Split biflow into uniflow (true/false)
43+
44+
fragmentation_cache:
45+
enabled: true # Enable fragmentation cache (true/false)
46+
size: 10007 # Fragmentation cache size (minimum 1)
47+
timeout: 3 # Timeout for fragments in cache (in seconds)
48+
49+
# List of active process plugins (process_plugins)
50+
process_plugins:
51+
- http
52+
- dns
53+
- quic
54+
- tls
55+
56+
57+
# Output plugin configuration (output_plugin)
58+
output_plugin:
59+
ipfix:
60+
collector:
61+
host: localhost # IPFIX collector address
62+
port: 4739 # Collector port
63+
mtu: 1458 # Maximum size of IPFIX packets
64+
exporter:
65+
id: 0 # Exporter ID
66+
dir: 0 # Direction bit field value
67+
68+
protocol:
69+
udp:
70+
template_refresh: 60 # Template refresh rate (for UDP only)
71+
tcp:
72+
non_blocking: false # Use non-blocking TCP socket
73+
74+
compression:
75+
lz4:
76+
enabled: true # Enable LZ4 compression
77+
buffer_size: 4500 # Buffer size for LZ4 (default: mtu * 3)
78+
79+
text:
80+
file: /path/to/output/file.txt # Path to output file (null = stdout)
81+
82+
# Telemetry settings (telemetry)
83+
telemetry:
84+
appfs:
85+
enabled: true # Enable AppFS telemetry
86+
mount_point: /var/run/ipfixprobe/ # Mount point path
87+
88+
# General configuration (general)
89+
general:
90+
queues_size:
91+
input: 64 # Size of the input queue
92+
output: 16536 # Size of the output queue
93+
cpu_mask: 0x1 # CPU mask for processes

pkg/rpm/ipfixprobe-msec.spec.in

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,7 @@ source /opt/rh/gcc-toolset-14/enable
9696
%{_libdir}/ipfixprobe/storage/libipfixprobe-storage-cache.so
9797

9898
%{_libdir}/ipfixprobe/config2args.py
99+
%{_sysconfdir}/ipfixprobe/link0.conf.example
99100

100101
%{_unitdir}/ipfixprobe-monitoring.target
101102
%{_unitdir}/[email protected]

pkg/rpm/ipfixprobe-nemea.spec.in

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,7 @@ source /opt/rh/gcc-toolset-14/enable
112112
%{_libdir}/ipfixprobe/storage/libipfixprobe-storage-cache.so
113113

114114
%{_libdir}/ipfixprobe/config2args.py
115+
%{_sysconfdir}/ipfixprobe/link0.conf.example
115116

116117
%{_unitdir}/ipfixprobe-monitoring.target
117118
%{_unitdir}/[email protected]

pkg/rpm/ipfixprobe.spec.in

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,7 @@ source /opt/rh/gcc-toolset-14/enable
141141
%{_libdir}/ipfixprobe/storage/libipfixprobe-storage-cache.so
142142

143143
%{_libdir}/ipfixprobe/config2args.py
144+
%{_sysconfdir}/ipfixprobe/link0.conf.example
144145

145146
%{_unitdir}/ipfixprobe-monitoring.target
146147
%{_unitdir}/[email protected]

0 commit comments

Comments
 (0)