| 1 | plugin_name: go.d.plugin |
| 2 | modules: |
| 3 | - meta: |
| 4 | id: collector-go.d.plugin-ethtool |
| 5 | plugin_name: go.d.plugin |
| 6 | module_name: ethtool |
| 7 | monitored_instance: |
| 8 | name: Optical modules |
| 9 | link: "" |
| 10 | icon_filename: network-wired.svg |
| 11 | categories: |
| 12 | - data-collection.networking |
| 13 | keywords: |
| 14 | - sfp |
| 15 | - ddm |
| 16 | - optic |
| 17 | related_resources: |
| 18 | integrations: |
| 19 | list: [] |
| 20 | info_provided_to_referring_integrations: |
| 21 | description: "" |
| 22 | overview: |
| 23 | data_collection: |
| 24 | metrics_description: > |
| 25 | This collector monitors optical transceiver modules' diagnostic parameters |
| 26 | (temperature, voltage, laser bias current, transmit/receive power levels) from network interfaces |
| 27 | equipped with modules that support Digital Diagnostic Monitoring (DDM). |
| 28 | It relies on the [`ethtool`](https://man7.org/linux/man-pages/man8/ethtool.8.html) CLI tool but avoids directly executing the binary. |
| 29 | Instead, it utilizes `ndsudo`, a Netdata helper specifically designed to run privileged commands securely within the Netdata environment. |
| 30 | This approach eliminates the need to use `sudo`, improving security and potentially simplifying permission management. |
| 31 | method_description: "" |
| 32 | supported_platforms: |
| 33 | include: [Linux] |
| 34 | exclude: [] |
| 35 | multi_instance: false |
| 36 | additional_permissions: |
| 37 | description: "" |
| 38 | default_behavior: |
| 39 | auto_detection: |
| 40 | description: "" |
| 41 | limits: |
| 42 | description: "" |
| 43 | performance_impact: |
| 44 | description: "" |
| 45 | setup: |
| 46 | prerequisites: |
| 47 | list: [] |
| 48 | configuration: |
| 49 | file: |
| 50 | name: go.d/ethtool.conf |
| 51 | options: |
| 52 | description: | |
| 53 | The following options can be defined globally: update_every. |
| 54 | folding: |
| 55 | title: Config options |
| 56 | enabled: true |
| 57 | list: |
| 58 | - name: update_every |
| 59 | description: Data collection frequency. |
| 60 | default_value: 10 |
| 61 | required: false |
| 62 | - name: timeout |
| 63 | description: Timeout for executing the binary, specified in seconds. |
| 64 | default_value: 2 |
| 65 | required: false |
| 66 | - name: optical_interfaces |
| 67 | description: Space-separated list of optical interface names which must have optical transceiver modules with [DDM](https://en.wikipedia.org/wiki/Small_Form-factor_Pluggable#Digital_diagnostics_monitoring). |
| 68 | default_value: "" |
| 69 | required: true |
| 70 | examples: |
| 71 | folding: |
| 72 | title: Config |
| 73 | enabled: true |
| 74 | list: |
| 75 | - name: Custom binary path |
| 76 | description: The executable is not in the directories specified in the PATH environment variable. |
| 77 | config: | |
| 78 | jobs: |
| 79 | - name: ethtool |
| 80 | binary_path: /usr/local/sbin/ethtool |
| 81 | optical_interfaces: "enp1s0 enp1s1 enp2s0" |
| 82 | troubleshooting: |
| 83 | problems: |
| 84 | list: [] |
| 85 | alerts: [] |
| 86 | metrics: |
| 87 | folding: |
| 88 | title: Metrics |
| 89 | enabled: false |
| 90 | description: "" |
| 91 | availability: [] |
| 92 | scopes: |
| 93 | - name: Optical Transceiver Module |
| 94 | description: Metrics collected from optical transceiver modules that support Digital Diagnostic Monitoring (DDM). |
| 95 | labels: |
| 96 | - name: iface |
| 97 | description: Network interface name where the optical transceiver module is installed. |
| 98 | metrics: |
| 99 | - name: ethtool.optical_module_receiver_signal_power |
| 100 | description: Module Receiver Signal Average Optical Power |
| 101 | unit: 'dBm' |
| 102 | chart_type: line |
| 103 | dimensions: |
| 104 | - name: rx_power |
| 105 | - name: ethtool.optical_module_laser_output_power |
| 106 | description: Module Laser Output Power |
| 107 | unit: 'dBm' |
| 108 | chart_type: line |
| 109 | dimensions: |
| 110 | - name: tx_power |
| 111 | - name: ethtool.optical_module_laser_bias_current |
| 112 | description: Module Laser Bias Current |
| 113 | unit: 'mA' |
| 114 | chart_type: line |
| 115 | dimensions: |
| 116 | - name: bias_current |
| 117 | - name: ethtool.optical_module_temperature |
| 118 | description: Module Temperature |
| 119 | unit: 'Celsius' |
| 120 | chart_type: line |
| 121 | dimensions: |
| 122 | - name: temperature |
| 123 | - name: ethtool.optical_module_voltage |
| 124 | description: Module Voltage |
| 125 | unit: 'Volts' |
| 126 | chart_type: line |
| 127 | dimensions: |
| 128 | - name: voltage |