Documentation/networking/statistics.rst

1 .. SPDX-License-Identifier: GPL-2.0
14  - standard interface statistics based on
16  - protocol-specific statistics; and
17  - driver-defined statistics available via ethtool.
20 -----------------------------
25   $ ip -s -s link show dev ens4u1u1
38 Note that `-s` has been specified twice to see all members of
40 If `-s` is specified once the detailed errors won't be shown.
42 `ip` supports JSON formatting via the `-j` option.
44 Protocol-specific statistics
45 ----------------------------
47 Protocol-specific statistics are exposed via relevant interfaces,
53 Ethtool exposes common low-level statistics.
55 by the device, not the driver (as opposed to driver-defined stats
58 switches (e.g. legacy SR-IOV or multi-host NICs) the events counted
61 be counted at the network port (MAC/PHY blocks) without separation
70   $ ethtool --include-statistics -a eth0
80 functionality are exposed via ``ethtool -S $ifc`` by specifying
81 the ``--groups`` parameter::
83   $ ethtool -S eth0 --groups eth-phy eth-mac eth-ctrl rmon
85   eth-phy-SymbolErrorDuringCarrier: 0
86   eth-mac-FramesTransmittedOK: 1
87   eth-mac-FrameTooLongErrors: 1
88   eth-ctrl-MACControlFramesTransmitted: 1
89   eth-ctrl-MACControlFramesReceived: 0
90   eth-ctrl-UnsupportedOpcodesReceived: 1
91   rmon-etherStatsUndersizePkts: 1
92   rmon-etherStatsJabbers: 0
93   rmon-rx-etherStatsPkts64Octets: 1
94   rmon-rx-etherStatsPkts65to127Octets: 0
95   rmon-rx-etherStatsPkts128to255Octets: 0
96   rmon-tx-etherStatsPkts64Octets: 2
97   rmon-tx-etherStatsPkts65to127Octets: 3
98   rmon-tx-etherStatsPkts128to255Octets: 0
100 Driver-defined statistics
101 -------------------------
103 Driver-defined ethtool statistics can be dumped using `ethtool -S $ifc`, e.g.::
105   $ ethtool -S ens4u1u1
114 ------
124 -----
137 `Documentation/ABI/testing/sysfs-class-net-statistics`.
141 -------
151 -------
155 statistics for which other APIs did not exist, like per-device-queue
156 statistics, or standard-based statistics (e.g. RFC 2863).
163 ethtool-netlink
164 ---------------
168 Protocol-related statistics can be requested in get commands by setting
172   - `ETHTOOL_MSG_PAUSE_GET`
173   - `ETHTOOL_MSG_FEC_GET`
174   - `ETHTOOL_MSG_MM_GET`
177 -------
184 .. kernel-doc:: include/uapi/linux/if_link.h
206 Retrieving ethtool statistics is a multi-syscall process, drivers are advised
213 Kernel-internal data structures
214 -------------------------------
220 - ethtool_pause_stats()
221 - ethtool_fec_stats()