Update python sensors metadata yaml (#15548)
* format and yamllint * update sensors metadata * fix yamlint * fix yamlint * Update collectors/python.d.plugin/sensors/metadata.yaml Co-authored-by: Fotis Voutsas <fotis@netdata.cloud> * Update collectors/python.d.plugin/sensors/metadata.yaml Co-authored-by: Fotis Voutsas <fotis@netdata.cloud> * Update collectors/python.d.plugin/sensors/metadata.yaml Co-authored-by: Fotis Voutsas <fotis@netdata.cloud> --------- Co-authored-by: Fotis Voutsas <fotis@netdata.cloud>
Andrew Maguire committed
Jul 28, 2023 at 08:45 UTC
dcf021a11644dfb806ce7ccf5f2cc955359e4447
1 file changed
+131
-64
collectors/python.d.plugin/sensors/metadata.yaml
+131
-64
@@ -1,54 +1,120 @@
1
+# yamllint disable rule:line-length
2
+---
3
meta:
4
plugin_name: python.d.plugin
5
module_name: sensors
6
monitored_instance:
7
name: Linux Sensors (lm-sensors)
6
- link: ''
8
+ link: https://hwmon.wiki.kernel.org/lm_sensors
9
categories:
8
- - data-collection.hardware-devices-and-sensors
9
- icon_filename: 'microchip.svg'
10
+ - data-collection.hardware-devices-and-sensors
11
+ icon_filename: "microchip.svg"
12
related_resources:
13
integrations:
14
list: []
15
info_provided_to_referring_integrations:
14
- description: ''
15
- keywords: []
16
+ description: ""
17
+ keywords:
18
+ - sensors
19
+ - temperature
20
+ - voltage
21
+ - current
22
+ - power
23
+ - fan
24
+ - energy
25
+ - humidity
26
most_popular: false
27
overview:
28
data_collection:
19
- 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.'
20
- method_description: ''
29
+ metrics_description: |
30
+ Examine Linux Sensors metrics with Netdata for insights into hardware health and performance.
31
+
32
+ Enhance your system's reliability with real-time hardware health insights.
33
+ method_description: >
34
+ Reads system sensors information (temperature, voltage, electric current, power, etc.) via [lm-sensors](https://hwmon.wiki.kernel.org/lm_sensors).
35
supported_platforms:
36
include: []
37
exclude: []
38
multi_instance: true
39
additional_permissions:
26
- description: ''
40
+ description: ""
41
default_behavior:
42
auto_detection:
29
- description: ''
43
+ description: >
44
+ The following type of sensors are auto-detected:
45
+
46
+ - temperature
47
+ - fan
48
+ - voltage
49
+ - current
50
+ - power
51
+ - energy
52
+ - humidity
53
limits:
31
- description: ''
54
+ description: ""
55
performance_impact:
33
- description: ''
56
+ description: ""
57
setup:
58
prerequisites:
59
list: []
60
configuration:
61
file:
39
- name: ''
40
- description: ''
62
+ name: python.d/sensors.conf
63
+ description: ""
64
options:
42
- description: ''
65
+ description: |
66
+ There are 2 sections:
67
+
68
+ * Global variables
69
+ * One or more JOBS that can define multiple different instances to monitor.
70
+
71
+ 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.
72
+
73
+ Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
74
+
75
+ Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
76
folding:
44
- title: ''
77
+ title: Config options
78
enabled: true
46
- list: []
79
+ list:
80
+ - name: types
81
+ description: The types of sensors to collect.
82
+ default_value: "temperature, fan, voltage, current, power, energy, humidity"
83
+ required: true
84
+ - name: update_every
85
+ description: Sets the default data collection frequency.
86
+ default_value: 1
87
+ required: false
88
+ - name: priority
89
+ description: Controls the order of charts at the netdata dashboard.
90
+ default_value: 60000
91
+ required: false
92
+ - name: autodetection_retry
93
+ description: Sets the job re-check interval in seconds.
94
+ default_value: 0
95
+ required: false
96
+ - name: penalty
97
+ description: Indicates whether to apply penalty to update_every in case of failures.
98
+ default_value: yes
99
+ required: false
100
examples:
101
folding:
102
enabled: true
50
- title: ''
51
- list: []
103
+ title: Config
104
+ list:
105
+ - name: Default
106
+ folding:
107
+ enabled: false
108
+ description: Default configuration.
109
+ config: |
110
+ types:
111
+ - temperature
112
+ - fan
113
+ - voltage
114
+ - current
115
+ - power
116
+ - energy
117
+ - humidity
118
troubleshooting:
119
problems:
120
list: []
@@ -60,49 +126,50 @@ metrics:
126
description: ""
127
availability: []
128
scopes:
63
- - name: chip
64
- description: ""
65
- labels: []
66
- metrics:
67
- - name: sensors.temperature
68
- description: Temperature
69
- unit: "Celsius"
70
- chart_type: line
71
- dimensions:
72
- - name: a dimension per sensor
73
- - name: sensors.voltage
74
- description: Voltage
75
- unit: "Volts"
76
- chart_type: line
77
- dimensions:
78
- - name: a dimension per sensor
79
- - name: sensors.current
80
- description: Current
81
- unit: "Ampere"
82
- chart_type: line
83
- dimensions:
84
- - name: a dimension per sensor
85
- - name: sensors.power
86
- description: Power
87
- unit: "Watt"
88
- chart_type: line
89
- dimensions:
90
- - name: a dimension per sensor
91
- - name: sensors.fan
92
- description: Fans speed
93
- unit: "Rotations/min"
94
- chart_type: line
95
- dimensions:
96
- - name: a dimension per sensor
97
- - name: sensors.energy
98
- description: Energy
99
- unit: "Joule"
100
- chart_type: line
101
- dimensions:
102
- - name: a dimension per sensor
103
- - name: sensors.humidity
104
- description: Humidity
105
- unit: "Percent"
106
- chart_type: line
107
- dimensions:
108
- - name: a dimension per sensor
129
+ - name: chip
130
+ description: >
131
+ 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`.
132
+ labels: []
133
+ metrics:
134
+ - name: sensors.temperature
135
+ description: Temperature
136
+ unit: "Celsius"
137
+ chart_type: line
138
+ dimensions:
139
+ - name: a dimension per sensor
140
+ - name: sensors.voltage
141
+ description: Voltage
142
+ unit: "Volts"
143
+ chart_type: line
144
+ dimensions:
145
+ - name: a dimension per sensor
146
+ - name: sensors.current
147
+ description: Current
148
+ unit: "Ampere"
149
+ chart_type: line
150
+ dimensions:
151
+ - name: a dimension per sensor
152
+ - name: sensors.power
153
+ description: Power
154
+ unit: "Watt"
155
+ chart_type: line
156
+ dimensions:
157
+ - name: a dimension per sensor
158
+ - name: sensors.fan
159
+ description: Fans speed
160
+ unit: "Rotations/min"
161
+ chart_type: line
162
+ dimensions:
163
+ - name: a dimension per sensor
164
+ - name: sensors.energy
165
+ description: Energy
166
+ unit: "Joule"
167
+ chart_type: line
168
+ dimensions:
169
+ - name: a dimension per sensor
170
+ - name: sensors.humidity
171
+ description: Humidity
172
+ unit: "Percent"
173
+ chart_type: line
174
+ dimensions:
175
+ - name: a dimension per sensor