[Feat]: Optic module telemetry using "ethtool -m"

[vankxr]

Problem

ethtool -m can be used to retrieve telemetry data from a connected optical module, which I cannot seem to find on the netdata dashboard

Description

Telemetry data such as:

• Temperature
• VCC voltage
• Optical RX Power
• Optical TX Power
• Laser bias current

could be logged by netdata.

Importance

nice to have

Value proposition

Troubleshooting/monitoring/logging optical power, mostly, but since the other metrics are just right there, why not include them as well?

Proposed implementation

I don't really have a suggestion on the implementation, but I assume it could be fetched the same way the already existing interface metrics are right now (?)

[ilyam8]

ethtool -m can be used to retrieve telemetry data

Can you provide data sample?

[vankxr]

Sure!
Here you go:

# ethtool -m enp1s0f0np0

    Identifier                                : 0x03 (SFP)
    Extended identifier                       : 0x04 (GBIC/SFP defined by 2-wire interface ID)
    Connector                                 : 0x01 (SC)
    Transceiver codes                         : 0x20 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00
    Transceiver type                          : 10G Ethernet: 10G Base-LR
    Encoding                                  : 0x03 (NRZ)
    BR, Nominal                               : 10000MBd
    Rate identifier                           : 0x00 (unspecified)
    Length (SMF,km)                           : 20km
    Length (SMF)                              : 20000m
    Length (50um)                             : 0m
    Length (62.5um)                           : 0m
    Length (Copper)                           : 0m
    Length (OM3)                              : 0m
    Laser wavelength                          : 1270nm
    Vendor name                               : FS
    Vendor OUI                                : XXXXXXXX
    Vendor PN                                 : XXXXXXXXXXXXXXX
    Vendor rev                                : XXXX
    Option values                             : 0x00 0x1a
    Option                                    : RX_LOS implemented
    Option                                    : TX_FAULT implemented
    Option                                    : TX_DISABLE implemented
    BR margin, max                            : 0%
    BR margin, min                            : 0%
    Vendor SN                                 : XXXXXXXXXXX
    Date code                                 : XXXXXX
    Optical diagnostics support               : Yes
    Laser bias current                        : 13.088 mA
    Laser output power                        : 3.6119 mW / 5.58 dBm
    Receiver signal average optical power     : 0.0044 mW / -23.57 dBm
    Module temperature                        : 38.00 degrees C / 100.40 degrees F
    Module voltage                            : 3.4844 V
    Alarm/warning flags implemented           : Yes
    Laser bias current high alarm             : Off
    Laser bias current low alarm              : Off
    Laser bias current high warning           : Off
    Laser bias current low warning            : Off
    Laser output power high alarm             : Off
    Laser output power low alarm              : Off
    Laser output power high warning           : Off
    Laser output power low warning            : Off
    Module temperature high alarm             : Off
    Module temperature low alarm              : Off
    Module temperature high warning           : Off
    Module temperature low warning            : Off
    Module voltage high alarm                 : Off
    Module voltage low alarm                  : Off
    Module voltage high warning               : Off
    Module voltage low warning                : Off
    Laser rx power high alarm                 : Off
    Laser rx power low alarm                  : Off
    Laser rx power high warning               : Off
    Laser rx power low warning                : Off
    Laser bias current high alarm threshold   : 95.000 mA
    Laser bias current low alarm threshold    : 1.000 mA
    Laser bias current high warning threshold : 85.000 mA
    Laser bias current low warning threshold  : 2.000 mA
    Laser output power high alarm threshold   : 6.4566 mW / 8.10 dBm
    Laser output power low alarm threshold    : 1.9953 mW / 3.00 dBm
    Laser output power high warning threshold : 6.4566 mW / 8.10 dBm
    Laser output power low warning threshold  : 2.5119 mW / 4.00 dBm
    Module temperature high alarm threshold   : 100.00 degrees C / 212.00 degrees F
    Module temperature low alarm threshold    : -40.00 degrees C / -40.00 degrees F
    Module temperature high warning threshold : 90.00 degrees C / 194.00 degrees F
    Module temperature low warning threshold  : -30.00 degrees C / -22.00 degrees F
    Module voltage high alarm threshold       : 3.7000 V
    Module voltage low alarm threshold        : 2.8999 V
    Module voltage high warning threshold     : 3.5000 V
    Module voltage low warning threshold      : 3.1000 V
    Laser rx power high alarm threshold       : 0.1995 mW / -7.00 dBm
    Laser rx power low alarm threshold        : 0.0010 mW / -30.00 dBm
    Laser rx power high warning threshold     : 0.1584 mW / -8.00 dBm
    Laser rx power low warning threshold      : 0.0012 mW / -29.21 dBm

[ilyam8]

@vankxr Can you tell what values ​​from the output data you propose to collect? I saw your "Telemetry data such as" but I want exact lines from the output.

[vankxr]

For me, the most important (changing) values are

Laser bias current                        : 13.088 mA
Laser output power                        : 3.6119 mW / 5.58 dBm
Receiver signal average optical power     : 0.0044 mW / -23.57 dBm
Module temperature                        : 38.00 degrees C / 100.40 degrees F
Module voltage                            : 3.4844 V

The remaining seem to be just static information and thresholds for warnings/shutdown.

[ilyam8]

@vankxr can you share the output if the interface is down?

[vankxr]

Do you mean if the transceievr is plugged in but with the fiber unplugged, or when no transceiver is plugged into the port?

[ilyam8]

Probably both. I need to see what output it will be:

1. No output or
2. The same lines but with all values set to 0, or
3. The same lines with N/A values

[vankxr]

Well, here's a couple of cases.

Same transceiver as above, but with fiber unplugged:
It report as usual, but with RX power at the minimum value (-40 dBm)

Identifier                                : 0x03 (SFP)
Extended identifier                       : 0x04 (GBIC/SFP defined by 2-wire interface ID)
Connector                                 : 0x01 (SC)
Transceiver codes                         : 0x20 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00
Transceiver type                          : 10G Ethernet: 10G Base-LR
Encoding                                  : 0x03 (NRZ)
BR, Nominal                               : 10000MBd
Rate identifier                           : 0x00 (unspecified)
Length (SMF,km)                           : 20km
Length (SMF)                              : 20000m
Length (50um)                             : 0m
Length (62.5um)                           : 0m
Length (Copper)                           : 0m
Length (OM3)                              : 0m
Laser wavelength                          : 1270nm
Vendor name                               : FS
Vendor OUI                                : XXXXXXXX
Vendor PN                                 : XXXXXXXXXXXXXXX
Vendor rev                                : XXXX
Option values                             : 0x00 0x1a
Option                                    : RX_LOS implemented
Option                                    : TX_FAULT implemented
Option                                    : TX_DISABLE implemented
BR margin, max                            : 0%
BR margin, min                            : 0%
Vendor SN                                 : XXXXXXXXXXX
Date code                                 : XXXXXX
Optical diagnostics support               : Yes
Laser bias current                        : 12.768 mA
Laser output power                        : 3.0487 mW / 4.84 dBm
Receiver signal average optical power     : 0.0001 mW / -40.00 dBm
Module temperature                        : 36.75 degrees C / 98.15 degrees F
Module voltage                            : 3.4860 V
Alarm/warning flags implemented           : Yes
Laser bias current high alarm             : Off
Laser bias current low alarm              : Off
Laser bias current high warning           : Off
Laser bias current low warning            : Off
Laser output power high alarm             : Off
Laser output power low alarm              : Off
Laser output power high warning           : Off
Laser output power low warning            : Off
Module temperature high alarm             : Off
Module temperature low alarm              : Off
Module temperature high warning           : Off
Module temperature low warning            : Off
Module voltage high alarm                 : Off
Module voltage low alarm                  : Off
Module voltage high warning               : Off
Module voltage low warning                : Off
Laser rx power high alarm                 : Off
Laser rx power low alarm                  : On
Laser rx power high warning               : Off
Laser rx power low warning                : On
Laser bias current high alarm threshold   : 95.000 mA
Laser bias current low alarm threshold    : 1.000 mA
Laser bias current high warning threshold : 85.000 mA
Laser bias current low warning threshold  : 2.000 mA
Laser output power high alarm threshold   : 6.4566 mW / 8.10 dBm
Laser output power low alarm threshold    : 1.9953 mW / 3.00 dBm
Laser output power high warning threshold : 6.4566 mW / 8.10 dBm
Laser output power low warning threshold  : 2.5119 mW / 4.00 dBm
Module temperature high alarm threshold   : 100.00 degrees C / 212.00 degrees F
Module temperature low alarm threshold    : -40.00 degrees C / -40.00 degrees F
Module temperature high warning threshold : 90.00 degrees C / 194.00 degrees F
Module temperature low warning threshold  : -30.00 degrees C / -22.00 degrees F
Module voltage high alarm threshold       : 3.7000 V
Module voltage low alarm threshold        : 2.8999 V
Module voltage high warning threshold     : 3.5000 V
Module voltage low warning threshold      : 3.1000 V
Laser rx power high alarm threshold       : 0.1995 mW / -7.00 dBm
Laser rx power low alarm threshold        : 0.0010 mW / -30.00 dBm
Laser rx power high warning threshold     : 0.1584 mW / -8.00 dBm
Laser rx power low warning threshold      : 0.0012 mW / -29.21 dBm

No transceiver/DAC plugged in:
netlink error: Input/output error

DAC plugged in:

Identifier                                : 0x03 (SFP)
Extended identifier                       : 0x04 (GBIC/SFP defined by 2-wire interface ID)
Connector                                 : 0x21 (Copper pigtail)
Transceiver codes                         : 0x01 0x00 0x00 0x04 0x00 0x04 0x80 0xd5 0x00
Transceiver type                          : Infiniband: 1X Copper Passive
Transceiver type                          : Ethernet: 1000BASE-CX
Transceiver type                          : Passive Cable
Transceiver type                          : FC: Twin Axial Pair (TW)
Transceiver type                          : FC: 1200 MBytes/sec
Transceiver type                          : FC: 800 MBytes/sec
Transceiver type                          : FC: 400 MBytes/sec
Transceiver type                          : FC: 200 MBytes/sec
Transceiver type                          : FC: 100 MBytes/sec
Encoding                                  : 0x00 (unspecified)
BR, Nominal                               : 10300MBd
Rate identifier                           : 0x00 (unspecified)
Length (SMF,km)                           : 0km
Length (SMF)                              : 0m
Length (50um)                             : 0m
Length (62.5um)                           : 0m
Length (Copper)                           : 1m
Length (OM3)                              : 0m
Passive Cu cmplnce.                       : 0x01 (SFF-8431 appendix E) [SFF-8472 rev10.4 only]
Vendor name                               : XXXXXXXXXXXXXXXXXXX
Vendor OUI                                : XX:XX:XX
Vendor PN                                 : XXXXXXXXXXX
Vendor rev                                : F
Option values                             : 0x00 0x00
BR margin, max                            : 0%
BR margin, min                            : 0%
Vendor SN                                 : XXXXXXXXX
Date code                                 : XXXXXXXX

Optical transceiver which does not support diagnostic metrics plugged in:

Identifier                                : 0x03 (SFP)
Extended identifier                       : 0x04 (GBIC/SFP defined by 2-wire interface ID)
Connector                                 : 0x07 (LC)
Transceiver codes                         : 0x10 0x00 0x00 0x01 0x00 0x00 0x00 0x00 0x00
Transceiver type                          : 10G Ethernet: 10G Base-SR
Transceiver type                          : Ethernet: 1000BASE-SX
Encoding                                  : 0x06 (64B/66B)
BR, Nominal                               : 10300MBd
Rate identifier                           : 0x02 (8/4/2G Rx Rate_Select only)
Length (SMF,km)                           : 0km
Length (SMF)                              : 0m
Length (50um)                             : 80m
Length (62.5um)                           : 30m
Length (Copper)                           : 0m
Length (OM3)                              : 300m
Laser wavelength                          : 850nm
Vendor name                               : Intel Corp
Vendor OUI                                : 00:XX:XX
Vendor PN                                 : FTXXXXXXXXXXX
Vendor rev                                : A
Option values                             : 0x00 0x3a
Option                                    : RX_LOS implemented
Option                                    : TX_FAULT implemented
Option                                    : TX_DISABLE implemented
Option                                    : RATE_SELECT implemented
BR margin, max                            : 0%
BR margin, min                            : 0%
Vendor SN                                 : XXXXXXXX
Date code                                 : XXXXXX

[k0ste]

To use ethtool, is better to start from #14803, like for me as kernel interface

[Ferroin]

I would tend to agree with @k0ste on this, we’re getting to the point where we need to just bite the bullet and start querying netlink directly. It will give better performance for this type of thing since there will be no need to fork a process on each collection cycle, and open up a whole lot of additional metrics we can query.