plugin_name: go.d.plugin
modules:
  - meta:
      id: collector-go.d.plugin-sensors
      plugin_name: go.d.plugin
      module_name: sensors
      monitored_instance:
        name: Linux Sensors
        link: https://hwmon.wiki.kernel.org/lm_sensors
        icon_filename: "microchip.svg"
        categories:
          - data-collection.hardware-devices-and-sensors
      keywords:
        - sensors
        - temperature
        - voltage
        - current
        - power
        - fan
        - energy
        - humidity
        - intrusion
      related_resources:
        integrations:
          list: []
      info_provided_to_referring_integrations:
        description: ""
      most_popular: false
    overview:
      data_collection:
        metrics_description: |
          This collector gathers real-time system sensor statistics using the [sysfs](https://www.kernel.org/doc/Documentation/hwmon/sysfs-interface) interface.

          Supported sensors:

          - Temperature
          - Voltage
          - Fan
          - Current
          - Power
          - Energy
          - Humidity
          - Intrusion
        method_description: ""
      supported_platforms:
        include: [Linux]
        exclude: []
      multi_instance: false
      additional_permissions:
        description: ""
      default_behavior:
        auto_detection:
          description: |
            Automatically discovers and exposes all available sensors on the system through the [sysfs](https://www.kernel.org/doc/Documentation/hwmon/sysfs-interface) interface.
        limits:
          description: ""
        performance_impact:
          description: ""
    setup:
      prerequisites:
        list: []
      configuration:
        file:
          name: go.d/sensors.conf
        options:
          description: |
            The following options can be defined globally: update_every.
          folding:
            title: Config options
            enabled: true
          list:
            - name: update_every
              description: Data collection frequency.
              default_value: 10
              required: false
            - name: relabel
              description: A list used to update existing sensor labels or add labels to sensors that don't have them.
              default_value: "[]"
              required: false
            - name: relabel[].chip
              description: "[Pattern](/src/libnetdata/simple_pattern/README.md#simple-patterns) to match the `chip_id` label value."
              default_value: ""
              required: false
            - name: relabel[].sensors
              description: A list of sensors to be relabeled for the specified chip.
              default_value: "[]"
              required: false
            - name: relabel[].sensors[].name
              description: The exact sensor name (e.g., `'temp1'`, `'in1'`, `'voltage1'`).
              default_value: ""
              required: false
            - name: relabel[].sensors[].label
              description: The new label value for the sensor.
              default_value: ""
              required: false
        examples:
          folding:
            title: Config
            enabled: true
          list:
            - name: Custom update_every
              description: Allows you to override the default data collection interval.
              config: |
                jobs:
                  - name: sensors
                    update_every: 5  # Collect sensors statistics every 5 seconds
            - name: Renaming labels
              description: Allows you to override/add labels.
              config: |
                jobs:
                  - name: sensors
                    relabel:
                      - chip: as99127f-*
                        sensors:
                          - name: temp1
                            label: Mobo Temp
                          - name: temp2
                            label: CPU0 Temp
    troubleshooting:
      problems:
        list: []
    alerts: []
    metrics:
      folding:
        title: Metrics
        enabled: false
      description: ""
      availability: []
      scopes:
        - name: sensor
          description: These metrics refer to the system sensor.
          labels:
            - name: chip
              description: The path to the sensor's chip device, excluding the /sys/devices prefix. This provides a unique identifier for the physical hardware component.
            - name: chip_id
              description: A unique identifier for the sensor's chip, formatted as `chipName-busType-hash`.
            - name: sensor
              description: The name of the specific sensor within the chip device. This provides a direct identifier for the individual measurement point.
            - name: label
              description: A label provided by the kernel driver to indicate the intended use or purpose of the sensor.
          metrics:
            - name: sensors.chip_sensor_temperature
              description: Sensor Temperature
              unit: Celsius
              chart_type: line
              dimensions:
                - name: input
            - name: sensors.chip_sensor_temperature_alarm
              description: Temperature Sensor Alarm
              unit: status
              chart_type: line
              dimensions:
                - name: clear
                - name: triggered
            - name: sensors.chip_sensor_voltage
              description: Sensor Voltage
              unit: Volts
              chart_type: line
              dimensions:
                - name: input
            - name: sensors.chip_sensor_voltage_average
              description: Sensor Voltage Average
              unit: Volts
              chart_type: line
              dimensions:
                - name: average
            - name: sensors.chip_sensor_voltage_alarm
              description: Voltage Sensor Alarm
              unit: status
              chart_type: line
              dimensions:
                - name: clear
                - name: triggered
            - name: sensors.chip_sensor_fan
              description: Sensor Fan
              unit: RPM
              chart_type: line
              dimensions:
                - name: input
            - name: sensors.chip_sensor_fan_alarm
              description: Fan Sensor Alarm
              unit: status
              chart_type: line
              dimensions:
                - name: clear
                - name: triggered
            - name: sensors.chip_sensor_current
              description: Sensor Current
              unit: Amperes
              chart_type: line
              dimensions:
                - name: input
            - name: sensors.chip_sensor_current_average
              description: Sensor Current Average
              unit: Amperes
              chart_type: line
              dimensions:
                - name: average
            - name: sensors.chip_sensor_current_alarm
              description: Current Sensor Alarm
              unit: status
              chart_type: line
              dimensions:
                - name: clear
                - name: triggered
            - name: sensors.chip_sensor_power
              description: Sensor Power
              unit: Watts
              chart_type: line
              dimensions:
                - name: input
            - name: sensors.chip_sensor_power_average
              description: Sensor Power Average
              unit: Watts
              chart_type: line
              dimensions:
                - name: average
            - name: sensors.chip_sensor_power_alarm
              description: Power Sensor Alarm
              unit: status
              chart_type: line
              dimensions:
                - name: clear
                - name: triggered
            - name: sensors.chip_sensor_energy
              description: Sensor Energy
              unit: Joules
              chart_type: line
              dimensions:
                - name: input
            - name: sensors.chip_sensor_humidity
              description: Sensor Humidity
              unit: percent
              chart_type: line
              dimensions:
                - name: input
            - name: sensors.chip_sensor_intrusion_alarm
              description: Intrusion Sensor Alarm
              unit: status
              chart_type: line
              dimensions:
                - name: clear
                - name: triggered
