| 1 | plugin_name: go.d.plugin |
| 2 | modules: |
| 3 | - meta: |
| 4 | id: collector-go.d.plugin-sensors |
| 5 | plugin_name: go.d.plugin |
| 6 | module_name: sensors |
| 7 | monitored_instance: |
| 8 | name: Linux Sensors |
| 9 | link: https://hwmon.wiki.kernel.org/lm_sensors |
| 10 | icon_filename: "microchip.svg" |
| 11 | categories: |
| 12 | - data-collection.hardware-and-sensors |
| 13 | keywords: |
| 14 | - sensors |
| 15 | - temperature |
| 16 | - voltage |
| 17 | - current |
| 18 | - power |
| 19 | - fan |
| 20 | - energy |
| 21 | - humidity |
| 22 | - intrusion |
| 23 | related_resources: |
| 24 | integrations: |
| 25 | list: [] |
| 26 | info_provided_to_referring_integrations: |
| 27 | description: "" |
| 28 | overview: |
| 29 | data_collection: |
| 30 | metrics_description: | |
| 31 | This collector gathers real-time system sensor statistics using the [sysfs](https://www.kernel.org/doc/Documentation/hwmon/sysfs-interface) interface. |
| 32 | |
| 33 | Supported sensors: |
| 34 | |
| 35 | - Temperature |
| 36 | - Voltage |
| 37 | - Fan |
| 38 | - Current |
| 39 | - Power |
| 40 | - Energy |
| 41 | - Humidity |
| 42 | - Intrusion |
| 43 | method_description: "" |
| 44 | supported_platforms: |
| 45 | include: [Linux] |
| 46 | exclude: [] |
| 47 | multi_instance: false |
| 48 | additional_permissions: |
| 49 | description: "" |
| 50 | default_behavior: |
| 51 | auto_detection: |
| 52 | description: | |
| 53 | Automatically discovers and exposes all available sensors on the system through the [sysfs](https://www.kernel.org/doc/Documentation/hwmon/sysfs-interface) interface. |
| 54 | limits: |
| 55 | description: "" |
| 56 | performance_impact: |
| 57 | description: "" |
| 58 | setup: |
| 59 | prerequisites: |
| 60 | list: [] |
| 61 | configuration: |
| 62 | file: |
| 63 | name: go.d/sensors.conf |
| 64 | options: |
| 65 | description: | |
| 66 | The following options can be defined globally: update_every. |
| 67 | folding: |
| 68 | title: Config options |
| 69 | enabled: true |
| 70 | list: |
| 71 | - name: update_every |
| 72 | description: Data collection frequency. |
| 73 | default_value: 10 |
| 74 | required: false |
| 75 | - name: relabel |
| 76 | description: A list used to update existing sensor labels or add labels to sensors that don't have them. |
| 77 | default_value: "[]" |
| 78 | required: false |
| 79 | - name: relabel[].chip |
| 80 | description: "[Pattern](/src/libnetdata/simple_pattern/README.md#simple-patterns) to match the `chip_id` label value." |
| 81 | default_value: "" |
| 82 | required: false |
| 83 | - name: relabel[].sensors |
| 84 | description: A list of sensors to be relabeled for the specified chip. |
| 85 | default_value: "[]" |
| 86 | required: false |
| 87 | - name: relabel[].sensors[].name |
| 88 | description: The exact sensor name (e.g., `'temp1'`, `'in1'`, `'voltage1'`). |
| 89 | default_value: "" |
| 90 | required: false |
| 91 | - name: relabel[].sensors[].label |
| 92 | description: The new label value for the sensor. |
| 93 | default_value: "" |
| 94 | required: false |
| 95 | examples: |
| 96 | folding: |
| 97 | title: Config |
| 98 | enabled: true |
| 99 | list: |
| 100 | - name: Custom update_every |
| 101 | description: Allows you to override the default data collection interval. |
| 102 | config: | |
| 103 | jobs: |
| 104 | - name: sensors |
| 105 | update_every: 5 # Collect sensors statistics every 5 seconds |
| 106 | - name: Renaming labels |
| 107 | description: Allows you to override/add labels. |
| 108 | config: | |
| 109 | jobs: |
| 110 | - name: sensors |
| 111 | relabel: |
| 112 | - chip: as99127f-* |
| 113 | sensors: |
| 114 | - name: temp1 |
| 115 | label: Mobo Temp |
| 116 | - name: temp2 |
| 117 | label: CPU0 Temp |
| 118 | troubleshooting: |
| 119 | problems: |
| 120 | list: [] |
| 121 | alerts: [] |
| 122 | metrics: |
| 123 | folding: |
| 124 | title: Metrics |
| 125 | enabled: false |
| 126 | description: "" |
| 127 | availability: [] |
| 128 | scopes: |
| 129 | - name: sensor |
| 130 | description: These metrics refer to the system sensor. |
| 131 | labels: |
| 132 | - name: chip |
| 133 | description: The path to the sensor's chip device, excluding the /sys/devices prefix. This provides a unique identifier for the physical hardware component. |
| 134 | - name: chip_id |
| 135 | description: A unique identifier for the sensor's chip, formatted as `chipName-busType-hash`. |
| 136 | - name: sensor |
| 137 | description: The name of the specific sensor within the chip device. This provides a direct identifier for the individual measurement point. |
| 138 | - name: label |
| 139 | description: A label provided by the kernel driver to indicate the intended use or purpose of the sensor. |
| 140 | metrics: |
| 141 | - name: sensors.chip_sensor_temperature |
| 142 | description: Sensor Temperature |
| 143 | unit: Celsius |
| 144 | chart_type: line |
| 145 | dimensions: |
| 146 | - name: input |
| 147 | - name: sensors.chip_sensor_temperature_alarm |
| 148 | description: Temperature Sensor Alarm |
| 149 | unit: status |
| 150 | chart_type: line |
| 151 | dimensions: |
| 152 | - name: clear |
| 153 | - name: triggered |
| 154 | - name: sensors.chip_sensor_voltage |
| 155 | description: Sensor Voltage |
| 156 | unit: Volts |
| 157 | chart_type: line |
| 158 | dimensions: |
| 159 | - name: input |
| 160 | - name: sensors.chip_sensor_voltage_average |
| 161 | description: Sensor Voltage Average |
| 162 | unit: Volts |
| 163 | chart_type: line |
| 164 | dimensions: |
| 165 | - name: average |
| 166 | - name: sensors.chip_sensor_voltage_alarm |
| 167 | description: Voltage Sensor Alarm |
| 168 | unit: status |
| 169 | chart_type: line |
| 170 | dimensions: |
| 171 | - name: clear |
| 172 | - name: triggered |
| 173 | - name: sensors.chip_sensor_fan |
| 174 | description: Sensor Fan |
| 175 | unit: RPM |
| 176 | chart_type: line |
| 177 | dimensions: |
| 178 | - name: input |
| 179 | - name: sensors.chip_sensor_fan_alarm |
| 180 | description: Fan Sensor Alarm |
| 181 | unit: status |
| 182 | chart_type: line |
| 183 | dimensions: |
| 184 | - name: clear |
| 185 | - name: triggered |
| 186 | - name: sensors.chip_sensor_current |
| 187 | description: Sensor Current |
| 188 | unit: Amperes |
| 189 | chart_type: line |
| 190 | dimensions: |
| 191 | - name: input |
| 192 | - name: sensors.chip_sensor_current_average |
| 193 | description: Sensor Current Average |
| 194 | unit: Amperes |
| 195 | chart_type: line |
| 196 | dimensions: |
| 197 | - name: average |
| 198 | - name: sensors.chip_sensor_current_alarm |
| 199 | description: Current Sensor Alarm |
| 200 | unit: status |
| 201 | chart_type: line |
| 202 | dimensions: |
| 203 | - name: clear |
| 204 | - name: triggered |
| 205 | - name: sensors.chip_sensor_power |
| 206 | description: Sensor Power |
| 207 | unit: Watts |
| 208 | chart_type: line |
| 209 | dimensions: |
| 210 | - name: input |
| 211 | - name: sensors.chip_sensor_power_average |
| 212 | description: Sensor Power Average |
| 213 | unit: Watts |
| 214 | chart_type: line |
| 215 | dimensions: |
| 216 | - name: average |
| 217 | - name: sensors.chip_sensor_power_alarm |
| 218 | description: Power Sensor Alarm |
| 219 | unit: status |
| 220 | chart_type: line |
| 221 | dimensions: |
| 222 | - name: clear |
| 223 | - name: triggered |
| 224 | - name: sensors.chip_sensor_energy |
| 225 | description: Sensor Energy |
| 226 | unit: Joules |
| 227 | chart_type: line |
| 228 | dimensions: |
| 229 | - name: input |
| 230 | - name: sensors.chip_sensor_humidity |
| 231 | description: Sensor Humidity |
| 232 | unit: percent |
| 233 | chart_type: line |
| 234 | dimensions: |
| 235 | - name: input |
| 236 | - name: sensors.chip_sensor_intrusion_alarm |
| 237 | description: Intrusion Sensor Alarm |
| 238 | unit: status |
| 239 | chart_type: line |
| 240 | dimensions: |
| 241 | - name: clear |
| 242 | - name: triggered |