From: Petr Machata <petrm@nvidia.com>
Date: Mon, 9 May 2022 14:00:03 +0000 (+0200)
Subject: man: ip-stats.8: Describe groups xstats, xstats_slave and afstats
X-Git-Tag: v5.19.0~24^2~1^2
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=5a1ad9f8c1e62f080d4249d572f5ebe0ae870c12;p=thirdparty%2Fiproute2.git

man: ip-stats.8: Describe groups xstats, xstats_slave and afstats

Add description of the newly-added statistics groups.

Signed-off-by: Petr Machata <petrm@nvidia.com>
Reviewed-by: Ido Schimmel <idosch@nvidia.com>
Signed-off-by: David Ahern <dsahern@kernel.org>
---

diff --git a/man/man8/ip-stats.8 b/man/man8/ip-stats.8
index a82fe9f75..26336454e 100644
--- a/man/man8/ip-stats.8
+++ b/man/man8/ip-stats.8
@@ -68,6 +68,20 @@ The following groups are recognized:
 - A group that contains a number of HW-oriented statistics. See below for
 individual subgroups within this group.
 
+.ti 14
+.B group xstats
+- Extended statistics. A subgroup identifies the type of netdevice to show the
+statistics for.
+
+.ti 14
+.B group xstats_slave
+- Extended statistics for the slave of a netdevice of a given type. A subgroup
+identifies the type of master netdevice.
+
+.ti 14
+.B group afstats
+- A group for address-family specific netdevice statistics.
+
 .TQ
 .BR "group offload " subgroups:
 .in 21
@@ -133,6 +147,39 @@ For example:
 
 Note how the l3_stats_info for the selected group is also part of the dump.
 
+.TQ
+.BR "group xstats " and " group xstats_slave " subgroups:
+.in 21
+
+.ti 14
+.B subgroup bridge \fR[\fB suite stp \fR] [\fB suite mcast \fR]
+- Statistics for STP and, respectively, IGMP / MLD (under the keyword
+\fBmcast\fR) traffic on bridges and their slaves.
+
+.ti 14
+.B subgroup bond \fR[\fB suite 802.3ad \fR]
+- Statistics for LACP traffic on bond devices and their slaves.
+
+.TQ
+.BR "group afstats " subgroups:
+.in 21
+
+.ti 14
+.B subgroup mpls
+- Statistics for MPLS traffic seen on the netdevice. For example:
+
+# ip stats show dev veth01 group afstats subgroup mpls
+.br
+3: veth01: group afstats subgroup mpls
+.br
+    RX: bytes packets errors dropped noroute
+.br
+            0       0      0       0       0
+.br
+    TX: bytes packets errors dropped
+.br
+          216       2      0       0
+
 .SH EXAMPLES
 .PP
 # ip stats set dev swp1 l3_stats on