Project: Netdata (Observability and Analysis / Observability)
File: linux_sensors_lm-sensors.md

<!--startmeta customediturl: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/sensors/README.md" meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/sensors/metadata.yaml" sidebar_label: "Linux Sensors (lm-sensors)" learn_status: "Published" learnrelpath: "Collecting Metrics/Hardware Devices and Sensors" most_popular: False message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE" endmeta--> <img src="https://netdata.cloud/img/microchip.svg" width="150"/> Plugin: go.d.plugin Module: sensors <img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" /> This collector gathers real-time system sensor statistics, including temperature, voltage, current, power, fan speed, energy consumption, and humidity, utilizing the binary. This collector is supported on all platforms. This collector only supports collecting metrics from a single instance of this integration. The following type of sensors are auto-detected: temperature fan voltage current power energy humidity The default configuration for this integration does not impose any limits on data collection. The default configuration for this integration is not expected to impose a significant performance impact on the system. Metrics grouped by scope. The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels. These metrics refer to the sensor. Labels: | Label | Description | |:--|:-| | chip | The hardware component responsible for the sensor monitoring. | | feature | The specific sensor or monitoring point provided by the chip. | Metrics: | Metric | Dimensions | Unit | |:|:-|:-| | sensors.sensor_temperature | temperature | Celsius | | sensors.sensor_voltage | voltage | Volts | | sensors.sensor_current | current | Amperes | | sensors.sensor_power | power | Watts | | sensors.sensorfanspeed | fan | RPM | | sensors.sensor_energy | energy | Joules | | sensors.sensor_humidity | humidity | percent | There are no alerts configured by default for this integration. Install `lm-sensors` using your distribution's package manager. Run `sensors-detect` to detect hardware monitoring chips. The configuration file name for this integration is `go.d/sensors.conf`. You can edit the configuration file using the `edit-config` script from the Netdata . ```bash cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata sudo ./edit-config go.d/sensors.conf ``` The following options can be defined globally: update_every. <details><summary>Config options</summary> | Name | Description | Default | Required | |:-|:--|:-|:--:| | update_every | Data collection frequency. | 10 | no | | binary_path | Path to the `sensors` binary. If an absolute path is provided, the collector will use it directly; otherwise, it will search for the binary in directories specified in the PATH environment variable. | /usr/bin/sensors | yes | | timeout | Timeout for executing the binary, specified in seconds. | 2 | no | </details> The executable is not in the directories specified in the PATH environment variable. <details><summary>Config</summary> ```yaml jobs: name: sensors binary_path: /usr/local/sbin/sensors ``` </details> To troubleshoot issues with the `sensors` collector, run the `go.d.plugin` with the debug option enabled. The output should give you clues as to why the collector isn't working. Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`. ```bash cd /usr/libexec/netdata/plugins.d/ ``` Switch to the `netdata` user. ```bash sudo -u netdata -s ``` Run the `go.d.plugin` to debug the collector: ```bash ./go.d.plugin -d -m sensors ```