Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ieee802-eth-if: missing documentation for Ethernet counters #770

Open
jovatn opened this issue Oct 28, 2024 · 0 comments
Open

ieee802-eth-if: missing documentation for Ethernet counters #770

jovatn opened this issue Oct 28, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@jovatn
Copy link
Contributor

jovatn commented Oct 28, 2024

Supported Ethernet counters as YANG references can extracted from ieee-802-ethernet-interface.yang and infix-ethernet, see the statistics branch below.

PC:~/repos/infix/src/confd/yang $ pyang -f tree [email protected] infix-ethernet-interface.yang 
module: ieee802-ethernet-interface

  augment /if:interfaces/if:interface:
    +--rw ethernet
       +--rw auto-negotiation!
       |  +--rw enable?   boolean
       +--rw duplex?             duplex-type
       +--rw speed?              eth-if-speed-type
       +--ro statistics
          +--ro frame
             +--ro in-total-octets?                yang:counter64
             +--ro in-frames?                      yang:counter64
             +--ro in-multicast-frames?            yang:counter64
             +--ro in-broadcast-frames?            yang:counter64
             +--ro in-error-fcs-frames?            yang:counter64
             +--ro in-error-undersize-frames?      yang:counter64
             +--ro in-error-oversize-frames?       yang:counter64
             +--ro in-error-mac-internal-frames?   yang:counter64
             +--ro out-frames?                     yang:counter64
             +--ro out-multicast-frames?           yang:counter64
             +--ro out-broadcast-frames?           yang:counter64
             +--ro infix-eth:out-good-octets?      yang:counter64
             +--ro infix-eth:in-good-octets?       yang:counter64
PC:~/repos/infix/src/confd/yang $ 

The page https://github.com/kernelkit/infix/blob/main/doc/eth-counters.md describes how Infix maps these yang leafs to Linux/Ethtool counters, however, some of the supported counters lack mapping descriptions.

            +--ro in-error-oversize-frames?       yang:counter64
            +--ro in-error-mac-internal-frames?   yang:counter64
            +--ro infix-eth:out-good-octets?      yang:counter64
            +--ro infix-eth:in-good-octets?       yang:counter64
@jovatn jovatn added documentation Improvements or additions to documentation triage Pending investigation & classification (CCB) labels Oct 28, 2024
@jovatn jovatn changed the title Some Ethernet counters lack mapping documenation (YANG to Linux/Ethtool) Some Ethernet counters lack mapping documentation (YANG to Linux/Ethtool) Oct 28, 2024
@troglobit troglobit removed the triage Pending investigation & classification (CCB) label Oct 31, 2024
@troglobit troglobit added this to the Infix v24.11 milestone Oct 31, 2024
@troglobit troglobit moved this to Todo in Infix & C:o Oct 31, 2024
@troglobit troglobit changed the title Some Ethernet counters lack mapping documentation (YANG to Linux/Ethtool) ieee802-eth-if: missing documentation for Ethernet counters Nov 6, 2024
@troglobit troglobit modified the milestones: Infix v24.11, Infix v24.12 Nov 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Todo
Development

No branches or pull requests

3 participants