From c574f232107dbf565d0b2751551a8e1adef3b1db Mon Sep 17 00:00:00 2001 From: Joachim Wiberg Date: Sat, 12 Jul 2025 17:09:58 +0200 Subject: [PATCH] doc: reformat eth-counters.md to a proper markdown table This will be easier to typset also in the PDF generated version. Signed-off-by: Joachim Wiberg --- doc/eth-counters.md | 56 ++++++++++++++------------------------------- mkdocs.yml | 3 ++- 2 files changed, 19 insertions(+), 40 deletions(-) diff --git a/doc/eth-counters.md b/doc/eth-counters.md index a2f96f05..6cbe88cf 100644 --- a/doc/eth-counters.md +++ b/doc/eth-counters.md @@ -1,41 +1,19 @@ -# YANG to Ethtool Mapping +# RMON Counters -This column contains the mapping between YANG and Linux / Ethtool counters. +This document show the mapping between YANG and Linux / Ethtool counters. -``` -┌─────────────────────────────────┬──────────────────────────────────┐ -│ YANG │ Linux / Ethtool │ -├─────────────────────────────────┼──────────────────────────────────┤ -│ in-total-octets │ FramesReceivedOK, │ -│ │ FrameCheckSequenceErrors │ -│ │ FramesLostDueToIntMACRcvError │ -│ │ AlignmentErrors │ -│ │ etherStatsOversizePkts │ -│ │ etherStatsJabbers │ -├─────────────────────────────────┼──────────────────────────────────┤ -│ in-frames │ FramesReceivedOK │ -├─────────────────────────────────┼──────────────────────────────────┤ -│ in-multicast-frames │ MulticastFramesReceivedOK │ -├─────────────────────────────────┼──────────────────────────────────┤ -│ in-broadcast-frames │ BroadcastFramesReceivedOK │ -├─────────────────────────────────┼──────────────────────────────────┤ -│ in-error-fcs-frames │ FrameCheckSequenceErrors │ -├─────────────────────────────────┼──────────────────────────────────┤ -│ in-error-undersize-frames │ undersize_pkts │ -├─────────────────────────────────┼──────────────────────────────────┤ -| in-error-oversize-frames | etherStatsJabbers, | -| | etherStatsOversizePkts | -├─────────────────────────────────┼──────────────────────────────────┤ -│ in-error-mac-internal-frames │ FramesLostDueToIntMACRcvError │ -├─────────────────────────────────┼──────────────────────────────────┤ -│ out-frames │ FramesTransmittedOK │ -├─────────────────────────────────┼──────────────────────────────────┤ -│ out-multicast-frames │ MulticastFramesXmittedOK │ -├─────────────────────────────────┼──────────────────────────────────┤ -│ out-broadcast-frames │ BroadcastFramesXmittedOK │ -├─────────────────────────────────┼──────────────────────────────────┤ -│ infix-eth:out-good-octets │ OctetsTransmittedOK │ -├─────────────────────────────────┼──────────────────────────────────┤ -│ infix-eth:in-good-octets │ OctetsReceivedOK │ -└─────────────────────────────────┴──────────────────────────────────┘ -``` +| **YANG** | **Linux / Ethtool** | +|--------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| `in-total-octets` | `FramesReceivedOK`, `FrameCheckSequenceErrors`, `FramesLostDueToIntMACRcvError`, `AlignmentErrors`, `etherStatsOversizePkts`, `etherStatsJabbers` | +| `in-frames` | `FramesReceivedOK` | +| `in-multicast-frames` | `MulticastFramesReceivedOK` | +| `in-broadcast-frames` | `BroadcastFramesReceivedOK` | +| `in-error-fcs-frames` | `FrameCheckSequenceErrors` | +| `in-error-undersize-frames` | `undersize_pkts` | +| `in-error-oversize-frames` | `etherStatsJabbers`, `etherStatsOversizePkts` | +| `in-error-mac-internal-frames` | `FramesLostDueToIntMACRcvError` | +| `out-frames` | `FramesTransmittedOK` | +| `out-multicast-frames` | `MulticastFramesXmittedOK` | +| `out-broadcast-frames` | `BroadcastFramesXmittedOK` | +| `infix-eth:out-good-octets` | `OctetsTransmittedOK` | +| `infix-eth:in-good-octets` | `OctetsReceivedOK` | diff --git a/mkdocs.yml b/mkdocs.yml index 16a3b7cd..dc9fa422 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -11,7 +11,7 @@ edit_uri: edit/master/doc/ exclude_docs: | ChangeLog.md cli/README.md - eth-counters.md + README.md TODO.org nav: @@ -39,6 +39,7 @@ nav: - Scripting Infix: scripting.md - Tunneling (L2/L3): tunnels.md - Quality of Service: qos.md + - RMON Counters: eth-counters.md - Syslog Support: syslog.md - Virtual Environments: virtual.md - Wireless LAN (WiFi): wifi.md