Skip to content

Commit 0911c68

Browse files
committed
Readme - update telemetry docs
1 parent 541af95 commit 0911c68

File tree

1 file changed

+33
-1
lines changed

1 file changed

+33
-1
lines changed

README.md

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,9 +128,41 @@ To install ipfixprobe with NEMEA dependency from binary RPM packages, it is poss
128128

129129
## Telemetry
130130

131-
`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
131+
`ipfixprobe` exports statistics and other diagnostic information through a telemetry interface based on appFs library, which leverages the fuse3 library (filesystem in userspace) to allow telemetry data to be accessed and manipulated
132132
through standard filesystem operations.
133133

134+
```
135+
/var/run/ipfixprobe/
136+
├── output
137+
│   └── ipxRing
138+
│   └── stats
139+
└── pipeline
140+
└── queues
141+
├── 0
142+
│   ├── cache-stats
143+
│   ├── fragmentation-cache-stats
144+
│   ├── input-stats
145+
│   └── parser-stats
146+
├── 1
147+
...
148+
```
149+
150+
From telemetry stats you can read:
151+
152+
**Output Directory:**
153+
154+
In the output directory, you can monitor the capacity and current usage of the ipxRing. This helps determine whether the output plugin can export flows quickly enough or if there are bottlenecks caused by insufficient ring capacity.
155+
156+
157+
**Pipeline Directory:**
158+
159+
The pipeline directory provides statistics for all worker queues. Each queue is identified by its ID (e.g., 0, 1) and includes the following files:
160+
- cache-stats: Provides detailed metrics about flow cache usage and exported flow statistics.
161+
- fragmentation-cache-stats: Provides metrics related to packet fragmentation.
162+
- input-stats: Provides metrics on the data received by by the queue.
163+
- parser-stats: Provides detailed information about the types of packets processed by the parser,
164+
165+
134166
## Input / Output of the flow exporter
135167

136168
The availability of the input and output interfaces depends on the ipfixprobe build settings. By default, we provide RPM package with pcap and raw inputs. The default provided outpus are ipfix and text.

0 commit comments

Comments
 (0)