netdata/collectors/python.d.plugin/sensors/metadata.yaml

plugin_name: python.d.plugin
modules:
  - meta:
      plugin_name: python.d.plugin
      module_name: sensors
      monitored_instance:
        name: Linux Sensors (lm-sensors)
        link: https://hwmon.wiki.kernel.org/lm_sensors
        categories:
          - data-collection.hardware-devices-and-sensors
        icon_filename: "microchip.svg"
      related_resources:
        integrations:
          list: []
      info_provided_to_referring_integrations:
        description: ""
      keywords:
        - sensors
        - temperature
        - voltage
        - current
        - power
        - fan
        - energy
        - humidity
      most_popular: false
    overview:
      data_collection:
        metrics_description: |
          Examine Linux Sensors metrics with Netdata for insights into hardware health and performance.
          
          Enhance your system's reliability with real-time hardware health insights.
        method_description: >
          Reads system sensors information (temperature, voltage, electric current, power, etc.) via [lm-sensors](https://hwmon.wiki.kernel.org/lm_sensors).
      supported_platforms:
        include: []
        exclude: []
      multi_instance: true
      additional_permissions:
        description: ""
      default_behavior:
        auto_detection:
          description: >
            The following type of sensors are auto-detected:
            
            - temperature
            - fan
            - voltage
            - current
            - power
            - energy
            - humidity
        limits:
          description: ""
        performance_impact:
          description: ""
    setup:
      prerequisites:
        list: []
      configuration:
        file:
          name: python.d/sensors.conf
          description: ""
        options:
          description: |
            There are 2 sections:
            
            * Global variables
            * One or more JOBS that can define multiple different instances to monitor.
            
            The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
            
            Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
            
            Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
          folding:
            title: Config options
            enabled: true
          list:
            - name: types
              description: The types of sensors to collect.
              default_value: "temperature, fan, voltage, current, power, energy, humidity"
              required: true
            - name: update_every
              description: Sets the default data collection frequency.
              default_value: 1
              required: false
            - name: priority
              description: Controls the order of charts at the netdata dashboard.
              default_value: 60000
              required: false
            - name: autodetection_retry
              description: Sets the job re-check interval in seconds.
              default_value: 0
              required: false
            - name: penalty
              description: Indicates whether to apply penalty to update_every in case of failures.
              default_value: yes
              required: false
        examples:
          folding:
            enabled: true
            title: Config
          list:
            - name: Default
              folding:
                enabled: false
              description: Default configuration.
              config: |
                types:
                  - temperature
                  - fan
                  - voltage
                  - current
                  - power
                  - energy
                  - humidity
    troubleshooting:
      problems:
        list:
          - name: lm-sensors doesn't work on your device
            description: |
              When `lm-sensors` doesn't work on your device (e.g. for RPi temperatures),
              use [the legacy bash collector](https://github.com/netdata/netdata/blob/master/collectors/charts.d.plugin/sensors/README.md)
          - name: ACPI ring buffer errors are printed
            description: |
              There have been reports from users that on certain servers, ACPI ring buffer errors are printed by the kernel (`dmesg`)
              when ACPI sensors are being accessed. We are tracking such cases in issue [#827](https://github.com/netdata/netdata/issues/827).
              Please join this discussion for help.
    alerts: []
    metrics:
      folding:
        title: Metrics
        enabled: false
      description: ""
      availability: []
      scopes:
        - name: chip
          description: >
            Metrics related to chips. Each chip provides a set of the following metrics, each having the chip name in the metric name as reported by `sensors -u`.
          labels: []
          metrics:
            - name: sensors.temperature
              description: Temperature
              unit: "Celsius"
              chart_type: line
              dimensions:
                - name: a dimension per sensor
            - name: sensors.voltage
              description: Voltage
              unit: "Volts"
              chart_type: line
              dimensions:
                - name: a dimension per sensor
            - name: sensors.current
              description: Current
              unit: "Ampere"
              chart_type: line
              dimensions:
                - name: a dimension per sensor
            - name: sensors.power
              description: Power
              unit: "Watt"
              chart_type: line
              dimensions:
                - name: a dimension per sensor
            - name: sensors.fan
              description: Fans speed
              unit: "Rotations/min"
              chart_type: line
              dimensions:
                - name: a dimension per sensor
            - name: sensors.energy
              description: Energy
              unit: "Joule"
              chart_type: line
              dimensions:
                - name: a dimension per sensor
            - name: sensors.humidity
              description: Humidity
              unit: "Percent"
              chart_type: line
              dimensions:
                - name: a dimension per sensor