<!--startmeta
custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/debugfs.plugin/integrations/linux_hardware_sensors_libsensors.md"
meta_yaml: "https://github.com/netdata/netdata/edit/master/src/collectors/debugfs.plugin/metadata.yaml"
sidebar_label: "Linux Hardware Sensors (libsensors)"
learn_status: "Published"
learn_rel_path: "Collecting Metrics/Collectors/Hardware and Sensors"
keywords: ['sensors', 'temperature', 'voltage', 'fan', 'current', 'power', 'energy', 'humidity', 'hwmon', 'lm-sensors']
message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
endmeta-->

# Linux Hardware Sensors (libsensors)


<img src="https://netdata.cloud/img/microchip.svg" width="150"/>


Plugin: debugfs.plugin
Module: libsensors

<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />

## Overview

Collects hardware sensor readings (temperature, voltage, fan speed, current, power, energy, humidity and intrusion state) from all hardware monitoring chips exposed by the Linux hwmon subsystem. Every sensor gets its own chart, a cross-platform temperature histogram summarizes all temperature sensors in fixed bands, and a live `sensors` function lists every discovered sensor with its current reading and state.


Uses a bundled copy of the libsensors library (the same library behind the `sensors` command) to enumerate and read the hardware monitoring chips exposed under `/sys/class/hwmon`.


This collector is only supported on the following platforms:

- Linux

This collector only supports collecting metrics from a single instance of this integration.

The hwmon sysfs attributes are generally world-readable, so no additional permissions beyond the ones the debugfs plugin already has are required.


### Default Behavior

#### Auto-Detection

All hardware monitoring chips exposed by the hwmon subsystem are detected and collected automatically. The collection interval is automatically raised above the configured update every when reading the sensors is slow.


#### Limits

The default configuration for this integration does not impose any limits on data collection.

#### Performance Impact

The default configuration for this integration is not expected to impose a significant performance impact on the system.

## Setup


### Prerequisites

No action required.

### Configuration

#### Options



<details open><summary>Config options</summary>



| Option | Description | Default | Required |
|:-----|:------------|:--------|:---------:|
| update every | Data collection frequency. | 1 | no |
| command options | Additional parameters for collector |  | no |


</details>



#### via File

The configuration file name for this integration is `netdata.conf`.
Configuration for this specific integration is located in the `[plugin:debugfs]` section within that file.

The file format is a modified INI syntax. The general structure is:

```ini
[section1]
    option1 = some value
    option2 = some other value

[section2]
    option3 = some third value
```
You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).

```bash
cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config netdata.conf
```

##### Examples
There are no configuration examples.



## Alerts

There are no alerts configured by default for this integration.



## Metrics

Metrics grouped by *scope*.

The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.

Per-sensor charts are created for every supported reading of every discovered sensor; the alarm charts expose only the states each sensor driver actually supports. The temperature histogram is a single host-wide chart with the same fixed bands on every operating system: each dimension is a DISJOINT band named after its EXCLUSIVE upper bound in degrees Celsius, and every temperature sensor is counted in exactly one band.



### Per sensor

These metrics refer to a hardware sensor chip feature.

Labels:

| Label      | Description     |
|:-----------|:----------------|
| feature | Stable sensor feature identifier |
| label | Human-readable sensor label |
| chip_id | Sensor chip identifier |
| path | The hwmon sysfs path of the sensor chip |
| subsystem | Hardware subsystem the sensor chip belongs to |
| driver | Kernel driver providing the sensor |

Metrics:

| Metric | Description | Dimensions | Unit |
|:------|:------------|:----------|:----|
| system.hw.sensor.temperature.input | Sensor Temperature | input | degrees Celsius |
| system.hw.sensor.temperature.alarm | Sensor Temperature Alarm Status | clear, warning, cap, alarm, critical, emergency, fault | status |
| system.hw.sensor.voltage.input | Sensor Voltage | input | Volts |
| system.hw.sensor.voltage.average | Sensor Voltage Average | average | Volts |
| system.hw.sensor.voltage.alarm | Sensor Voltage Alarm Status | clear, warning, cap, alarm, critical, emergency, fault | status |
| system.hw.sensor.fan.input | Sensor Fan Speed | input | rotations per minute |
| system.hw.sensor.fan.alarm | Sensor Fan Alarm Status | clear, warning, cap, alarm, critical, emergency, fault | status |
| system.hw.sensor.current.input | Sensor Current | input | Amperes |
| system.hw.sensor.current.average | Sensor Current Average | average | Amperes |
| system.hw.sensor.current.alarm | Sensor Current Alarm Status | clear, warning, cap, alarm, critical, emergency, fault | status |
| system.hw.sensor.power.input | Sensor Power | input | Watts |
| system.hw.sensor.power.average | Sensor Power Average | average | Watts |
| system.hw.sensor.power.alarm | Sensor Power Alarm Status | clear, warning, cap, alarm, critical, emergency, fault | status |
| system.hw.sensor.energy.input | Sensor Energy | input | Joules |
| system.hw.sensor.energy.alarm | Sensor Energy Alarm Status | clear, warning, cap, alarm, critical, emergency, fault | status |
| system.hw.sensor.humidity.input | Sensor Humidity | input | percentage |
| system.hw.sensor.humidity.alarm | Sensor Humidity Alarm Status | clear, warning, cap, alarm, critical, emergency, fault | status |
| system.hw.sensor.intrusion.alarm | Sensor Intrusion Alarm Status | clear, warning, cap, alarm, critical, emergency, fault | status |


### Per Linux Hardware Sensors (libsensors) instance

Host-wide summary of all temperature sensors.

This scope has no labels.

Metrics:

| Metric | Description | Dimensions | Unit |
|:------|:------------|:----------|:----|
| system.hw.sensor.temperature.histogram | Distribution of all temperature sensors in fixed bands | 40, 50, 60, 70, 80, 85, 90, 95, 100, +Inf | sensors |
