summaryrefslogtreecommitdiffstats
path: root/collectors/python.d.plugin/sensors/metadata.yaml
blob: 95e4c0a78ca5ff66fe673b7fa82d1b976ea9c9a0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
# yamllint disable rule:line-length
---
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: []
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