Skip to content

Commit 8d5beff

Browse files
smagnani96joestringer
authored andcommitted
doc:monitor: clarify direction traced with default aggregation level
We do rely on monitorAggregation value to know which/when tracing network packets in our datapath. The current default `medium` level allows tracing ONLY send packets matching the conditions correctly described in the documentation. However, prior to this commit, we did not specify the send direction only in its definition, causing potential misinterpretation. Signed-off-by: Simone Magnani <simone.magnani@isovalent.com>
1 parent 9fad605 commit 8d5beff

2 files changed

Lines changed: 7 additions & 6 deletions

File tree

Documentation/network/kubernetes/configuration.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,9 @@ to your preferences:
4949

5050
- ``none`` - Generate a tracing event on every receive and send packet.
5151
- ``low`` - Generate a tracing event on every send packet.
52-
- ``medium`` - Generate a tracing event on every new connection, any time a
53-
packet contains TCP flags that have not been previously seen for the packet
54-
direction, and on average once per ``monitor-aggregation-interval``
52+
- ``medium`` - Generate a tracing event for send packets only on every new
53+
connection, any time a packet contains TCP flags that have not been previously
54+
seen for the packet direction, and on average once per ``monitor-aggregation-interval``
5555
(assuming that a packet is seen during the interval). Each direction tracks
5656
TCP flags and report interval separately. If Cilium drops a packet, it will
5757
emit one event per packet dropped.

Documentation/operations/performance/tuning.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -447,9 +447,10 @@ should consider increasing the aggregation interval or rate limiting events.
447447
Increase Aggregation Interval
448448
-----------------------------
449449

450-
By default Cilium generates a tracing event on every new connection, any time a packet
451-
contains TCP flags that have not been previously seen for the packet direction, and on
452-
average once per ``monitor-aggregation-interval``, which defaults to 5 seconds.
450+
By default Cilium generates a tracing event for send packets only on every new
451+
connection, any time a packet contains TCP flags that have not been previously
452+
seen for the packet direction, and on average once per ``monitor-aggregation-interval``,
453+
which defaults to 5 seconds.
453454

454455
Depending on your network traffic patterns, the re-emitting of trace events per
455456
aggregation interval can make up a large part of the total events. Increasing the

0 commit comments

Comments
 (0)