Skip to content

Commit d44905d

Browse files
committed
README.md - add telemetry section
1 parent e16a158 commit d44905d

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,7 @@ See `ipfixprobe -h output` for more information and complete list of output plug
127127
- `-f NUM` Export max flows per second
128128
- `-c SIZE` Quit after number of packets are processed on each interface
129129
- `-P FILE` Create pid file
130+
- `-t PATH` Mount point of AppFs telemetry directory
130131
- `-d` Run as a standalone process
131132
- `-h [PLUGIN]` Print help text. Supported help for input, storage, output and process plugins
132133
- `-V` Show version and exit
@@ -147,8 +148,8 @@ Here are the examples of various plugins usage:
147148
# Capture from a COMBO card using ndp plugin, sends ipfix data to 127.0.0.1:4739 using TCP by default
148149
./ipfixprobe -i 'ndp;dev=/dev/nfb0:0' -i 'ndp;dev=/dev/nfb0:1' -i 'ndp;dev=/dev/nfb0:2'
149150
150-
# Capture from eth0 interface using pcap plugin, split biflows into flows and prints them to console without mac addresses
151-
./ipfixprobe -i 'pcap;ifc=eth0' -s 'cache;split' -o 'text;m'
151+
# Capture from eth0 interface using pcap plugin, split biflows into flows and prints them to console without mac addresses, telemetry data are exposed via the appFs library in /var/run/ipfixprobe directory
152+
./ipfixprobe -i 'pcap;ifc=eth0' -s 'cache;split' -o 'text;m' -t /var/run/ipfixprobe
152153
153154
# Read packets from pcap file, enable 4 processing plugins, sends L7 HTTP extended biflows to unirec interface named `http` and data from 3 other plugins to the `stats` interface
154155
./ipfixprobe -i 'pcap;file=pcaps/http.pcap' -p http -p pstats -p idpcontent -p phists -o 'unirec;i=u:http:timeout=WAIT,u:stats:timeout=WAIT;p=http,(pstats,phists,idpcontent)'
@@ -168,6 +169,11 @@ Here are the examples of various plugins usage:
168169
`./ipfixprobe -i 'dpdk-ring;r=rx_ipfixprobe_0;e= --proc-type=secondary' -i 'dpdk-ring;r=rx_ipfixprobe_1' -i 'dpdk-ring;r=rx_ipfixprobe_2' -i 'dpdk-ring;r=rx_ipfixprobe_3' -o 'text'`
169170
```
170171

172+
## Telemetry
173+
174+
`ipfixprobe` can expose telemetry data using the appFs library, which leverages the fuse3 library (filesystem in userspace) to allow telemetry data to be accessed and manipulated
175+
through standard filesystem operations.
176+
171177
## Flow Data Extension - Processing Plugins
172178

173179
`ipfixprobe` can be extended by new plugins for exporting various new information from flow.

0 commit comments

Comments
 (0)