Update metadata.yaml for some python collectors - 2 (#15537)
* add exim metadata * add retroshare metadata * add litespeed metadata * add beanstalk metadata * add bind_rndc metadata * add gearman metadata and small edit to default conf * small changes to bind_rndc and its conf file * disable yaml lint line length check * add w1sensor metadata * add boinc metadata * add go_expvar metadata * fix format * fix small yamllint trailing whitespace error * add scope description to beanstalk * add a description and multi instance example to gearman/metadata.yaml * add multi example, and format the file * Update metadata.yaml * format the file and add multi example metadata.yaml * format the file * format the file * update folding in examples * format the file * format the file --------- Co-authored-by: Andrew Maguire <andrewm4894@gmail.com> Co-authored-by: Fotis Voutsas <fotis@netdata.cloud>
Emmanuel Vasilakis committed
Jul 27, 2023 at 10:39 UTC
cca354a3ca575cc0e17f83153a5cde7382cba591
12 files changed
+1325
-613
collectors/python.d.plugin/beanstalk/metadata.yaml
+218
-151
@@ -1,62 +1,129 @@
1
+# yamllint disable rule:line-length
2
meta:
3
plugin_name: python.d.plugin
4
module_name: beanstalk
5
monitored_instance:
6
name: Beanstalk
6
- link: ''
7
+ link: "https://beanstalkd.github.io/"
8
categories:
8
- - data-collection.message-brokers
9
- icon_filename: 'beanstalk.png'
9
+ - data-collection.message-brokers
10
+ icon_filename: "beanstalk.png"
11
related_resources:
12
integrations:
13
list: []
14
info_provided_to_referring_integrations:
14
- description: ''
15
- keywords: []
15
+ description: ""
16
+ keywords:
17
+ - beanstalk
18
+ - beanstalkd
19
+ - message
20
most_popular: false
21
overview:
22
data_collection:
19
- metrics_description: 'Monitor Beanstalk metrics to enhance job queueing and processing efficiency. Track job rates, processing times, and queue lengths for better task management.'
20
- method_description: ''
23
+ metrics_description: "Monitor Beanstalk metrics to enhance job queueing and processing efficiency. Track job rates, processing times, and queue lengths for better task management."
24
+ method_description: "The collector uses the `beanstalkc` python module to connect to a `beanstalkd` service and gather metrics."
25
supported_platforms:
26
include: []
27
exclude: []
28
multi_instance: true
29
additional_permissions:
26
- description: ''
30
+ description: ""
31
default_behavior:
32
auto_detection:
29
- description: ''
33
+ description: "If no configuration is given, module will attempt to connect to beanstalkd on 127.0.0.1:11300 address."
34
limits:
31
- description: ''
35
+ description: ""
36
performance_impact:
33
- description: ''
37
+ description: ""
38
setup:
39
prerequisites:
36
- list: []
40
+ list:
41
+ - title: "beanstalkc python module"
42
+ description: The collector requires the `beanstalkc` python module to be installed.
43
configuration:
44
file:
39
- name: ''
40
- description: ''
45
+ name: python.d/beanstalk.conf
46
options:
42
- description: ''
47
+ description: |
48
+ There are 2 sections:
49
+
50
+ * Global variables
51
+ * One or more JOBS that can define multiple different instances to monitor.
52
+
53
+ 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.
54
+
55
+ Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
56
+
57
+ Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
58
folding:
44
- title: ''
59
+ title: "Config options"
60
enabled: true
46
- list: []
61
+ list:
62
+ - name: update_every
63
+ description: Sets the default data collection frequency.
64
+ default_value: 5
65
+ required: false
66
+ - name: priority
67
+ description: Controls the order of charts at the netdata dashboard.
68
+ default_value: 60000
69
+ required: false
70
+ - name: autodetection_retry
71
+ description: Sets the job re-check interval in seconds.
72
+ default_value: 0
73
+ required: false
74
+ - name: penalty
75
+ description: Indicates whether to apply penalty to update_every in case of failures.
76
+ default_value: yes
77
+ required: false
78
+ - name: name
79
+ description: Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
80
+ default_value: ""
81
+ required: false
82
+ - name: host
83
+ description: IP or URL to a beanstalk service.
84
+ default_value: "127.0.0.1"
85
+ required: false
86
+ - name: port
87
+ description: Port to the IP or URL to a beanstalk service.
88
+ default_value: "11300"
89
+ required: false
90
examples:
91
folding:
92
enabled: true
50
- title: ''
51
- list: []
93
+ title: "Config"
94
+ list:
95
+ - name: Remote beanstalk server
96
+ description: A basic remote beanstalk server
97
+ folding:
98
+ enabled: false
99
+ config: |
100
+ remote:
101
+ name: 'beanstalk'
102
+ host: '1.2.3.4'
103
+ port: 11300
104
+ - name: Multi-instance
105
+ description: |
106
+ > **Note**: When you define multiple jobs, their names must be unique.
107
+
108
+ Collecting metrics from local and remote instances.
109
+ config: |
110
+ localhost:
111
+ name: 'local_beanstalk'
112
+ host: '127.0.0.1'
113
+ port: 11300
114
+
115
+ remote_job:
116
+ name: 'remote_beanstalk'
117
+ host: '192.0.2.1'
118
+ port: 113000
119
troubleshooting:
120
problems:
121
list: []
122
alerts:
56
-- name: beanstalk_server_buried_jobs
57
- link: https://github.com/netdata/netdata/blob/master/health/health.d/beanstalkd.conf
58
- metric: beanstalk.current_jobs
59
- info: number of buried jobs across all tubes. You need to manually kick them so they can be processed. Presence of buried jobs in a tube does not affect new jobs.
123
+ - name: beanstalk_server_buried_jobs
124
+ link: https://github.com/netdata/netdata/blob/master/health/health.d/beanstalkd.conf
125
+ metric: beanstalk.current_jobs
126
+ info: number of buried jobs across all tubes. You need to manually kick them so they can be processed. Presence of buried jobs in a tube does not affect new jobs.
127
metrics:
128
folding:
129
title: Metrics
@@ -64,131 +131,131 @@ metrics:
131
description: ""
132
availability: []
133
scopes:
67
- - name: global
68
- description: ""
69
- labels: []
70
- metrics:
71
- - name: beanstalk.cpu_usage
72
- description: Cpu Usage
73
- unit: "cpu time"
74
- chart_type: area
75
- dimensions:
76
- - name: user
77
- - name: system
78
- - name: beanstalk.jobs_rate
79
- description: Jobs Rate
80
- unit: "jobs/s"
81
- chart_type: line
82
- dimensions:
83
- - name: total
84
- - name: timeouts
85
- - name: beanstalk.connections_rate
86
- description: Connections Rate
87
- unit: "connections/s"
88
- chart_type: area
89
- dimensions:
90
- - name: connections
91
- - name: beanstalk.commands_rate
92
- description: Commands Rate
93
- unit: "commands/s"
94
- chart_type: stacked
95
- dimensions:
96
- - name: put
97
- - name: peek
98
- - name: peek-ready
99
- - name: peek-delayed
100
- - name: peek-buried
101
- - name: reserve
102
- - name: use
103
- - name: watch
104
- - name: ignore
105
- - name: delete
106
- - name: bury
107
- - name: kick
108
- - name: stats
109
- - name: stats-job
110
- - name: stats-tube
111
- - name: list-tubes
112
- - name: list-tube-used
113
- - name: list-tubes-watched
114
- - name: pause-tube
115
- - name: beanstalk.connections_rate
116
- description: Current Tubes
117
- unit: "tubes"
118
- chart_type: area
119
- dimensions:
120
- - name: tubes
121
- - name: beanstalk.current_jobs
122
- description: Current Jobs
123
- unit: "jobs"
124
- chart_type: stacked
125
- dimensions:
126
- - name: urgent
127
- - name: ready
128
- - name: reserved
129
- - name: delayed
130
- - name: buried
131
- - name: beanstalk.current_connections
132
- description: Current Connections
133
- unit: "connections"
134
- chart_type: line
135
- dimensions:
136
- - name: written
137
- - name: producers
138
- - name: workers
139
- - name: waiting
140
- - name: beanstalk.binlog
141
- description: Binlog
142
- unit: "records/s"
143
- chart_type: line
144
- dimensions:
145
- - name: written
146
- - name: migrated
147
- - name: beanstalk.uptime
148
- description: seconds
149
- unit: "seconds"
150
- chart_type: line
151
- dimensions:
152
- - name: uptime
153
- - name: tube
154
- description: ""
155
- labels: []
156
- metrics:
157
- - name: beanstalk.jobs_rate
158
- description: Jobs Rate
159
- unit: "jobs/s"
160
- chart_type: area
161
- dimensions:
162
- - name: jobs
163
- - name: beanstalk.jobs
164
- description: Jobs
165
- unit: "jobs"
166
- chart_type: stacked
167
- dimensions:
168
- - name: urgent
169
- - name: ready
170
- - name: reserved
171
- - name: delayed
172
- - name: buried
173
- - name: beanstalk.connections
174
- description: Connections
175
- unit: "connections"
176
- chart_type: stacked
177
- dimensions:
178
- - name: using
179
- - name: waiting
180
- - name: watching
181
- - name: beanstalk.commands
182
- description: Commands
183
- unit: "commands/s"
184
- chart_type: stacked
185
- dimensions:
186
- - name: deletes
187
- - name: pauses
188
- - name: beanstalk.pause
189
- description: Pause
190
- unit: "seconds"
191
- chart_type: stacked
192
- dimensions:
193
- - name: since
194
- - name: left
134
+ - name: global
135
+ description: "These metrics refer to the entire monitored application."
136
+ labels: []
137
+ metrics:
138
+ - name: beanstalk.cpu_usage
139
+ description: Cpu Usage
140
+ unit: "cpu time"
141
+ chart_type: area
142
+ dimensions:
143
+ - name: user
144
+ - name: system
145
+ - name: beanstalk.jobs_rate
146
+ description: Jobs Rate
147
+ unit: "jobs/s"
148
+ chart_type: line
149
+ dimensions:
150
+ - name: total
151
+ - name: timeouts
152
+ - name: beanstalk.connections_rate
153
+ description: Connections Rate
154
+ unit: "connections/s"
155
+ chart_type: area
156
+ dimensions:
157
+ - name: connections
158
+ - name: beanstalk.commands_rate
159
+ description: Commands Rate
160
+ unit: "commands/s"
161
+ chart_type: stacked
162
+ dimensions:
163
+ - name: put
164
+ - name: peek
165
+ - name: peek-ready
166
+ - name: peek-delayed
167
+ - name: peek-buried
168
+ - name: reserve
169
+ - name: use
170
+ - name: watch
171
+ - name: ignore
172
+ - name: delete
173
+ - name: bury
174
+ - name: kick
175
+ - name: stats
176
+ - name: stats-job
177
+ - name: stats-tube
178
+ - name: list-tubes
179
+ - name: list-tube-used
180
+ - name: list-tubes-watched
181
+ - name: pause-tube
182
+ - name: beanstalk.connections_rate
183
+ description: Current Tubes
184
+ unit: "tubes"
185
+ chart_type: area
186
+ dimensions:
187
+ - name: tubes
188
+ - name: beanstalk.current_jobs
189
+ description: Current Jobs
190
+ unit: "jobs"
191
+ chart_type: stacked
192
+ dimensions:
193
+ - name: urgent
194
+ - name: ready
195
+ - name: reserved
196
+ - name: delayed
197
+ - name: buried
198
+ - name: beanstalk.current_connections
199
+ description: Current Connections
200
+ unit: "connections"
201
+ chart_type: line
202
+ dimensions:
203
+ - name: written
204
+ - name: producers
205
+ - name: workers
206
+ - name: waiting
207
+ - name: beanstalk.binlog
208
+ description: Binlog
209
+ unit: "records/s"
210
+ chart_type: line
211
+ dimensions:
212
+ - name: written
213
+ - name: migrated
214
+ - name: beanstalk.uptime
215
+ description: seconds
216
+ unit: "seconds"
217
+ chart_type: line
218
+ dimensions:
219
+ - name: uptime
220
+ - name: tube
221
+ description: "Metrics related to Beanstalk tubes. Each tube produces its own set of the following metrics."
222
+ labels: []
223
+ metrics:
224
+ - name: beanstalk.jobs_rate
225
+ description: Jobs Rate
226
+ unit: "jobs/s"
227
+ chart_type: area
228
+ dimensions:
229
+ - name: jobs
230
+ - name: beanstalk.jobs
231
+ description: Jobs
232
+ unit: "jobs"
233
+ chart_type: stacked
234
+ dimensions:
235
+ - name: urgent
236
+ - name: ready
237
+ - name: reserved
238
+ - name: delayed
239
+ - name: buried
240
+ - name: beanstalk.connections
241
+ description: Connections
242
+ unit: "connections"
243
+ chart_type: stacked
244
+ dimensions:
245
+ - name: using
246
+ - name: waiting
247
+ - name: watching
248
+ - name: beanstalk.commands
249
+ description: Commands
250
+ unit: "commands/s"
251
+ chart_type: stacked
252
+ dimensions:
253
+ - name: deletes
254
+ - name: pauses
255
+ - name: beanstalk.pause
256
+ description: Pause
257
+ unit: "seconds"
258
+ chart_type: stacked
259
+ dimensions:
260
+ - name: since
261
+ - name: left
collectors/python.d.plugin/bind_rndc/bind_rndc.conf
+7
-9
@@ -63,14 +63,14 @@
63
#
64
# named_stats_path: 'path to named.stats' # Default: '/var/log/bind/named.stats'
65
#------------------------------------------------------------------------------------------------------------------
66
-# IMPORTANT Information
66
+# Important Information
67
#
68
-# BIND APPEND logs at EVERY RUN. Its NOT RECOMMENDED to set update_every below 30 sec.
69
-# STRONGLY RECOMMENDED to create a bind-rndc conf file for logrotate
68
+# BIND appends logs at EVERY RUN. It is NOT RECOMMENDED to set update_every below 30 sec.
69
+# It is STRONGLY RECOMMENDED to create a bind-rndc.conf file for logrotate.
70
#
71
# To set up your BIND to dump stats do the following:
72
#
73
-# 1. add to 'named.conf.options' options {}:
73
+# 1. Add to 'named.conf.options' options {}:
74
# statistics-file "/var/log/bind/named.stats";
75
#
76
# 2. Create bind/ directory in /var/log
@@ -83,13 +83,12 @@
83
# systemctl reload bind9.service
84
#
85
# 5. Run as a root 'rndc stats' to dump (BIND will create named.stats in new directory)
86
-#
86
#
88
-# To ALLOW NETDATA TO RUN 'rndc stats' change '/etc/bind/rndc.key' group to netdata
87
+# To allow Netdata to run 'rndc stats' change '/etc/bind/rndc.key' group to netdata
88
# chown :netdata rndc.key
89
#
91
-# The last BUT NOT least is to create bind-rndc.conf in logrotate.d/
92
-# The working one
90
+# Last, BUT NOT least, is to create bind-rndc.conf in logrotate.d/:
91
+#
92
# /var/log/bind/named.stats {
93
#
94
# daily
@@ -104,7 +103,6 @@
103
# }
104
#
105
# To test your logrotate conf file run as root:
107
-#
106
# logrotate /etc/logrotate.d/bind-rndc -d (debug dry-run mode)
107
#
108
# ----------------------------------------------------------------------
collectors/python.d.plugin/bind_rndc/metadata.yaml
+149
-64
@@ -1,62 +1,147 @@
1
+# yamllint disable rule:line-length
2
meta:
3
plugin_name: python.d.plugin
4
module_name: bind_rndc
5
monitored_instance:
6
name: ISCBind (RNDC)
6
- link: ''
7
+ link: "https://www.isc.org/bind/"
8
categories:
8
- - data-collection.dns-and-dhcp-servers
9
- icon_filename: 'isc.png'
9
+ - data-collection.dns-and-dhcp-servers
10
+ icon_filename: "isc.png"
11
related_resources:
12
integrations:
13
list: []
14
info_provided_to_referring_integrations:
14
- description: ''
15
- keywords: []
15
+ description: ""
16
+ keywords:
17
+ - dns
18
+ - bind
19
+ - server
20
most_popular: false
21
overview:
22
data_collection:
19
- metrics_description: 'Monitor ISCBind (RNDC) performance for optimal DNS server operations. Monitor query rates, response times, and error rates to ensure reliable DNS service delivery.'
20
- method_description: ''
23
+ metrics_description: "Monitor ISCBind (RNDC) performance for optimal DNS server operations. Monitor query rates, response times, and error rates to ensure reliable DNS service delivery."
24
+ method_description: "This collector uses the `rndc` tool to dump (named.stats) statistics then read them to gather Bind Name Server summary performance metrics."
25
supported_platforms:
26
include: []
27
exclude: []
24
- multi_instance: true
28
+ multi_instance: false
29
additional_permissions:
26
- description: ''
30
+ description: ""
31
default_behavior:
32
auto_detection:
29
- description: ''
33
+ description: "If no configuration is given, the collector will attempt to read named.stats file at `/var/log/bind/named.stats`"
34
limits:
31
- description: ''
35
+ description: ""
36
performance_impact:
33
- description: ''
37
+ description: ""
38
setup:
39
prerequisites:
36
- list: []
40
+ list:
41
+ - title: "Minimum bind version and permissions"
42
+ description: "Version of bind must be >=9.6 and the Netdata user must have permissions to run `rndc stats`"
43
+ - title: "Setup log rotate for bind stats"
44
+ description: |
45
+ BIND appends logs at EVERY RUN. It is NOT RECOMMENDED to set `update_every` below 30 sec.
46
+ It is STRONGLY RECOMMENDED to create a `bind-rndc.conf` file for logrotate.
47
+
48
+ To set up BIND to dump stats do the following:
49
+
50
+ 1. Add to 'named.conf.options' options {}:
51
+ `statistics-file "/var/log/bind/named.stats";`
52
+
53
+ 2. Create bind/ directory in /var/log:
54
+ `cd /var/log/ && mkdir bind`
55
+
56
+ 3. Change owner of directory to 'bind' user:
57
+ `chown bind bind/`
58
+
59
+ 4. RELOAD (NOT restart) BIND:
60
+ `systemctl reload bind9.service`
61
+
62
+ 5. Run as a root 'rndc stats' to dump (BIND will create named.stats in new directory)
63
+
64
+ To allow Netdata to run 'rndc stats' change '/etc/bind/rndc.key' group to netdata:
65
+ `chown :netdata rndc.key`
66
+
67
+ Last, BUT NOT least, is to create bind-rndc.conf in logrotate.d/:
68
+ ```
69
+ /var/log/bind/named.stats {
70
+
71
+ daily
72
+ rotate 4
73
+ compress
74
+ delaycompress
75
+ create 0644 bind bind
76
+ missingok
77
+ postrotate
78
+ rndc reload > /dev/null
79
+ endscript
80
+ }
81
+ ```
82
+ To test your logrotate conf file run as root:
83
+ `logrotate /etc/logrotate.d/bind-rndc -d (debug dry-run mode)`
84
configuration:
85
file:
39
- name: ''
40
- description: ''
86
+ name: python.d/bind_rndc.conf
87
options:
42
- description: ''
88
+ description: |
89
+ There are 2 sections:
90
+
91
+ * Global variables
92
+ * One or more JOBS that can define multiple different instances to monitor.
93
+
94
+ 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.
95
+
96
+ Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
97
+
98
+ Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
99
folding:
44
- title: ''
100
+ title: "Config options"
101
enabled: true
46
- list: []
102
+ list:
103
+ - name: update_every
104
+ description: Sets the default data collection frequency.
105
+ default_value: 5
106
+ required: false
107
+ - name: priority
108
+ description: Controls the order of charts at the netdata dashboard.
109
+ default_value: 60000
110
+ required: false
111
+ - name: autodetection_retry
112
+ description: Sets the job re-check interval in seconds.
113
+ default_value: 0
114
+ required: false
115
+ - name: penalty
116
+ description: Indicates whether to apply penalty to update_every in case of failures.
117
+ default_value: yes
118
+ required: false
119
+ - name: name
120
+ description: Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
121
+ default_value: ""
122
+ required: false
123
+ - name: named_stats_path
124
+ description: Path to the named stats, after being dumped by `nrdc`
125
+ default_value: "/var/log/bind/named.stats"
126
+ required: false
127
examples:
128
folding:
49
- enabled: true
50
- title: ''
51
- list: []
129
+ enabled: false
130
+ title: "Config"
131
+ list:
132
+ - name: Local bind stats
133
+ description: Define a local path to bind stats file
134
+ config: |
135
+ local:
136
+ named_stats_path: '/var/log/bind/named.stats'
137
troubleshooting:
138
problems:
139
list: []
140
alerts:
56
-- name: bind_rndc_stats_file_size
57
- link: https://github.com/netdata/netdata/blob/master/health/health.d/bind_rndc.conf
58
- metric: bind_rndc.stats_size
59
- info: BIND statistics-file size
141
+ - name: bind_rndc_stats_file_size
142
+ link: https://github.com/netdata/netdata/blob/master/health/health.d/bind_rndc.conf
143
+ metric: bind_rndc.stats_size
144
+ info: BIND statistics-file size
145
metrics:
146
folding:
147
title: Metrics
@@ -64,42 +149,42 @@ metrics:
149
description: ""
150
availability: []
151
scopes:
67
- - name: global
68
- description: ""
69
- labels: []
70
- metrics:
71
- - name: bind_rndc.name_server_statistics
72
- description: Name Server Statistics
73
- unit: "stats"
74
- chart_type: line
75
- dimensions:
76
- - name: requests
77
- - name: rejected_queries
78
- - name: success
79
- - name: failure
80
- - name: responses
81
- - name: duplicate
82
- - name: recursion
83
- - name: nxrrset
84
- - name: nxdomain
85
- - name: non_auth_answer
86
- - name: auth_answer
87
- - name: dropped_queries
88
- - name: bind_rndc.incoming_queries
89
- description: Incoming queries
90
- unit: "queries"
91
- chart_type: line
92
- dimensions:
93
- - name: a dimension per incoming query type
94
- - name: bind_rndc.outgoing_queries
95
- description: Outgoing queries
96
- unit: "queries"
97
- chart_type: line
98
- dimensions:
99
- - name: a dimension per outgoing query type
100
- - name: bind_rndc.stats_size
101
- description: Named Stats File Size
102
- unit: "MiB"
103
- chart_type: line
104
- dimensions:
105
- - name: stats_size
152
+ - name: global
153
+ description: "These metrics refer to the entire monitored application."
154
+ labels: []
155
+ metrics:
156
+ - name: bind_rndc.name_server_statistics
157
+ description: Name Server Statistics
158
+ unit: "stats"
159
+ chart_type: line
160
+ dimensions:
161
+ - name: requests
162
+ - name: rejected_queries
163
+ - name: success
164
+ - name: failure
165
+ - name: responses
166
+ - name: duplicate
167
+ - name: recursion
168
+ - name: nxrrset
169
+ - name: nxdomain
170
+ - name: non_auth_answer
171
+ - name: auth_answer
172
+ - name: dropped_queries
173
+ - name: bind_rndc.incoming_queries
174
+ description: Incoming queries
175
+ unit: "queries"
176
+ chart_type: line
177
+ dimensions:
178
+ - name: a dimension per incoming query type
179
+ - name: bind_rndc.outgoing_queries
180
+ description: Outgoing queries
181
+ unit: "queries"
182
+ chart_type: line
183
+ dimensions:
184
+ - name: a dimension per outgoing query type
185
+ - name: bind_rndc.stats_size
186
+ description: Named Stats File Size
187
+ unit: "MiB"
188
+ chart_type: line
189
+ dimensions:
190
+ - name: stats_size
collectors/python.d.plugin/boinc/metadata.yaml
+154
-82
@@ -1,78 +1,150 @@
1
+# yamllint disable rule:line-length
2
meta:
3
plugin_name: python.d.plugin
4
module_name: boinc
5
monitored_instance:
6
name: BOINC
6
- link: ''
7
+ link: "https://boinc.berkeley.edu/"
8
categories:
8
- - data-collection.distributed-computing-systems
9
- icon_filename: 'bolt.svg'
9
+ - data-collection.distributed-computing-systems
10
+ icon_filename: "bolt.svg"
11
related_resources:
12
integrations:
13
list: []
14
info_provided_to_referring_integrations:
14
- description: ''
15
- keywords: []
15
+ description: ""
16
+ keywords:
17
+ - boinc
18
+ - distributed
19
most_popular: false
20
overview:
21
data_collection:
19
- metrics_description: 'Study BOINC metrics to gain insights into volunteer computing projects. Examine computation times, task completion rates, and project statuses to enhance volunteer computing efforts.'
20
- method_description: ''
22
+ metrics_description: "This collector monitors task counts for the Berkeley Open Infrastructure Networking Computing (BOINC) distributed computing client."
23
+ method_description: "It uses the same RPC interface that the BOINC monitoring GUI does."
24
supported_platforms:
25
include: []
26
exclude: []
27
multi_instance: true
28
additional_permissions:
26
- description: ''
29
+ description: ""
30
default_behavior:
31
auto_detection:
29
- description: ''
32
+ description: "By default, the module will try to auto-detect the password to the RPC interface by looking in `/var/lib/boinc` for this file (this is the location most Linux distributions use for a system-wide BOINC installation), so things may just work without needing configuration for a local system."
33
limits:
31
- description: ''
34
+ description: ""
35
performance_impact:
33
- description: ''
36
+ description: ""
37
setup:
38
prerequisites:
36
- list: []
39
+ list:
40
+ - title: "Boinc RPC interface"
41
+ description: BOINC requires use of a password to access it's RPC interface. You can find this password in the `gui_rpc_auth.cfg` file in your BOINC directory.
42
configuration:
43
file:
39
- name: ''
40
- description: ''
44
+ name: python.d/boinc.conf
45
options:
42
- description: ''
46
+ description: |
47
+ There are 2 sections:
48
+
49
+ * Global variables
50
+ * One or more JOBS that can define multiple different instances to monitor.
51
+
52
+ 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.
53
+
54
+ Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
55
+
56
+ Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
57
folding:
44
- title: ''
58
+ title: "Config options"
59
enabled: true
46
- list: []
60
+ list:
61
+ - name: update_every
62
+ description: Sets the default data collection frequency.
63
+ default_value: 5
64
+ required: false
65
+ - name: priority
66
+ description: Controls the order of charts at the netdata dashboard.
67
+ default_value: 60000
68
+ required: false
69
+ - name: autodetection_retry
70
+ description: Sets the job re-check interval in seconds.
71
+ default_value: 0
72
+ required: false
73
+ - name: penalty
74
+ description: Indicates whether to apply penalty to update_every in case of failures.
75
+ default_value: yes
76
+ required: false
77
+ - name: name
78
+ description: Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
79
+ default_value: ""
80
+ required: false
81
+ - name: hostname
82
+ description: Define a hostname where boinc is running.
83
+ default_value: "localhost"
84
+ required: false
85
+ - name: port
86
+ description: The port of boinc RPC interface.
87
+ default_value: ""
88
+ required: false
89
+ - name: password
90
+ description: Provide a password to connect to a boinc RPC interface.
91
+ default_value: ""
92
+ required: false
93
examples:
94
folding:
95
enabled: true
50
- title: ''
51
- list: []
96
+ title: "Config"
97
+ list:
98
+ - name: Configuration of a remote boinc instance
99
+ description: A basic JOB configuration for a remote boinc instance
100
+ folding:
101
+ enabled: false
102
+ config: |
103
+ remote:
104
+ hostname: '1.2.3.4'
105
+ port: 1234
106
+ password: 'some-password'
107
+ - name: Multi-instance
108
+ description: |
109
+ > **Note**: When you define multiple jobs, their names must be unique.
110
+
111
+ Collecting metrics from local and remote instances.
112
+ config: |
113
+ localhost:
114
+ name: 'local'
115
+ host: '127.0.0.1'
116
+ port: 1234
117
+ password: 'some-password'
118
+
119
+ remote_job:
120
+ name: 'remote'
121
+ host: '192.0.2.1'
122
+ port: 1234
123
+ password: some-other-password
124
troubleshooting:
125
problems:
126
list: []
127
alerts:
56
-- name: boinc_total_tasks
57
- link: https://github.com/netdata/netdata/blob/master/health/health.d/boinc.conf
58
- metric: boinc.tasks
59
- info: average number of total tasks over the last 10 minutes
60
- os: "*"
61
-- name: boinc_active_tasks
62
- link: https://github.com/netdata/netdata/blob/master/health/health.d/boinc.conf
63
- metric: boinc.tasks
64
- info: average number of active tasks over the last 10 minutes
65
- os: "*"
66
-- name: boinc_compute_errors
67
- link: https://github.com/netdata/netdata/blob/master/health/health.d/boinc.conf
68
- metric: boinc.states
69
- info: average number of compute errors over the last 10 minutes
70
- os: "*"
71
-- name: boinc_upload_errors
72
- link: https://github.com/netdata/netdata/blob/master/health/health.d/boinc.conf
73
- metric: boinc.states
74
- info: average number of failed uploads over the last 10 minutes
75
- os: "*"
128
+ - name: boinc_total_tasks
129
+ link: https://github.com/netdata/netdata/blob/master/health/health.d/boinc.conf
130
+ metric: boinc.tasks
131
+ info: average number of total tasks over the last 10 minutes
132
+ os: "*"
133
+ - name: boinc_active_tasks
134
+ link: https://github.com/netdata/netdata/blob/master/health/health.d/boinc.conf
135
+ metric: boinc.tasks
136
+ info: average number of active tasks over the last 10 minutes
137
+ os: "*"
138
+ - name: boinc_compute_errors
139
+ link: https://github.com/netdata/netdata/blob/master/health/health.d/boinc.conf
140
+ metric: boinc.states
141
+ info: average number of compute errors over the last 10 minutes
142
+ os: "*"
143
+ - name: boinc_upload_errors
144
+ link: https://github.com/netdata/netdata/blob/master/health/health.d/boinc.conf
145
+ metric: boinc.states
146
+ info: average number of failed uploads over the last 10 minutes
147
+ os: "*"
148
metrics:
149
folding:
150
title: Metrics
@@ -80,46 +152,46 @@ metrics:
152
description: ""
153
availability: []
154
scopes:
83
- - name: global
84
- description: ""
85
- labels: []
86
- metrics:
87
- - name: boinc.tasks
88
- description: Overall Tasks
89
- unit: "tasks"
90
- chart_type: line
91
- dimensions:
92
- - name: Total
93
- - name: Active
94
- - name: boinc.states
95
- description: Tasks per State
96
- unit: "tasks"
97
- chart_type: line
98
- dimensions:
99
- - name: New
100
- - name: Downloading
101
- - name: Ready to Run
102
- - name: Compute Errors
103
- - name: Uploading
104
- - name: Uploaded
105
- - name: Aborted
106
- - name: Failed Uploads
107
- - name: boinc.sched
108
- description: Tasks per Scheduler State
109
- unit: "tasks"
110
- chart_type: line
111
- dimensions:
112
- - name: Uninitialized
113
- - name: Preempted
114
- - name: Scheduled
115
- - name: boinc.process
116
- description: Tasks per Process State
117
- unit: "tasks"
118
- chart_type: line
119
- dimensions:
120
- - name: Uninitialized
121
- - name: Executing
122
- - name: Suspended
123
- - name: Aborted
124
- - name: Quit
125
- - name: Copy Pending
155
+ - name: global
156
+ description: "These metrics refer to the entire monitored application."
157
+ labels: []
158
+ metrics:
159
+ - name: boinc.tasks
160
+ description: Overall Tasks
161
+ unit: "tasks"
162
+ chart_type: line
163
+ dimensions:
164
+ - name: Total
165
+ - name: Active
166
+ - name: boinc.states
167
+ description: Tasks per State
168
+ unit: "tasks"
169
+ chart_type: line
170
+ dimensions:
171
+ - name: New
172
+ - name: Downloading
173
+ - name: Ready to Run
174
+ - name: Compute Errors
175
+ - name: Uploading
176
+ - name: Uploaded
177
+ - name: Aborted
178
+ - name: Failed Uploads
179
+ - name: boinc.sched
180
+ description: Tasks per Scheduler State
181
+ unit: "tasks"
182
+ chart_type: line
183
+ dimensions:
184
+ - name: Uninitialized
185
+ - name: Preempted
186
+ - name: Scheduled
187
+ - name: boinc.process
188
+ description: Tasks per Process State
189
+ unit: "tasks"
190
+ chart_type: line
191
+ dimensions:
192
+ - name: Uninitialized
193
+ - name: Executing
194
+ - name: Suspended
195
+ - name: Aborted
196
+ - name: Quit
197
+ - name: Copy Pending
collectors/python.d.plugin/exim/metadata.yaml
+90
-31
@@ -1,54 +1,113 @@
1
+# yamllint disable rule:line-length
2
meta:
3
plugin_name: python.d.plugin
4
module_name: exim
5
monitored_instance:
6
name: Exim
6
- link: ''
7
+ link: "https://www.exim.org/"
8
categories:
8
- - data-collection.mail-servers
9
- icon_filename: 'exim.jpg'
9
+ - data-collection.mail-servers
10
+ icon_filename: "exim.jpg"
11
related_resources:
12
integrations:
13
list: []
14
info_provided_to_referring_integrations:
14
- description: ''
15
- keywords: []
15
+ description: ""
16
+ keywords:
17
+ - exim
18
+ - mail
19
+ - server
20
most_popular: false
21
overview:
22
data_collection:
19
- metrics_description: 'Monitor Exim metrics for efficient mail transfer'
20
- method_description: ''
23
+ metrics_description: "This collector monitors Exim mail queue."
24
+ method_description: "It uses the `exim` command line binary to get the statistics."
25
supported_platforms:
26
include: []
27
exclude: []
24
- multi_instance: true
28
+ multi_instance: false
29
additional_permissions:
26
- description: ''
30
+ description: ""
31
default_behavior:
32
auto_detection:
29
- description: ''
33
+ description: "Assuming setup prerequisites are met, the collector will try to gather statistics using the method described above, even without any configuration."
34
limits:
31
- description: ''
35
+ description: ""
36
performance_impact:
33
- description: ''
37
+ description: ""
38
setup:
39
prerequisites:
36
- list: []
40
+ list:
41
+ - title: "Exim configuration - local installation"
42
+ description: |
43
+ The module uses the `exim` binary, which can only be executed as root by default. We need to allow other users to `exim` binary. We solve that adding `queue_list_requires_admin` statement in exim configuration and set to `false`, because it is `true` by default. On many Linux distributions, the default location of `exim` configuration is in `/etc/exim.conf`.
44
+
45
+ 1. Edit the `exim` configuration with your preferred editor and add:
46
+ `queue_list_requires_admin = false`
47
+ 2. Restart `exim` and Netdata
48
+ - title: "Exim configuration - WHM (CPanel) server"
49
+ description: |
50
+ On a WHM server, you can reconfigure `exim` over the WHM interface with the following steps.
51
+
52
+ 1. Login to WHM
53
+ 2. Navigate to Service Configuration --> Exim Configuration Manager --> tab Advanced Editor
54
+ 3. Scroll down to the button **Add additional configuration setting** and click on it.
55
+ 4. In the new dropdown which will appear above we need to find and choose:
56
+ `queue_list_requires_admin` and set to `false`
57
+ 5. Scroll to the end and click the **Save** button.
58
configuration:
59
file:
39
- name: ''
40
- description: ''
60
+ name: python.d/exim.conf
61
options:
42
- description: ''
62
+ description: |
63
+ There are 2 sections:
64
+
65
+ * Global variables
66
+ * One or more JOBS that can define multiple different instances to monitor.
67
+
68
+ 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.
69
+
70
+ Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
71
+
72
+ Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
73
folding:
44
- title: ''
74
+ title: "Config options"
75
enabled: true
46
- list: []
76
+ list:
77
+ - name: update_every
78
+ description: Sets the default data collection frequency.
79
+ default_value: 5
80
+ required: false
81
+ - name: priority
82
+ description: Controls the order of charts at the netdata dashboard.
83
+ default_value: 60000
84
+ required: false
85
+ - name: autodetection_retry
86
+ description: Sets the job re-check interval in seconds.
87
+ default_value: 0
88
+ required: false
89
+ - name: penalty
90
+ description: Indicates whether to apply penalty to update_every in case of failures.
91
+ default_value: yes
92
+ required: false
93
+ - name: name
94
+ description: Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
95
+ default_value: ""
96
+ required: false
97
+ - name: command
98
+ description: Path and command to the `exim` binary
99
+ default_value: "exim -bpc"
100
+ required: false
101
examples:
102
folding:
49
- enabled: true
50
- title: ''
51
- list: []
103
+ enabled: false
104
+ title: "Config"
105
+ list:
106
+ - name: Local exim install
107
+ description: A basic local exim install
108
+ config: |
109
+ local:
110
+ command: 'exim -bpc'
111
troubleshooting:
112
problems:
113
list: []
@@ -60,13 +119,13 @@ metrics:
119
description: ""
120
availability: []
121
scopes:
63
- - name: global
64
- description: ""
65
- labels: []
66
- metrics:
67
- - name: exim.qemails
68
- description: Exim Queue Emails
69
- unit: "emails"
70
- chart_type: line
71
- dimensions:
72
- - name: emails
122
+ - name: global
123
+ description: "These metrics refer to the entire monitored application."
124
+ labels: []
125
+ metrics:
126
+ - name: exim.qemails
127
+ description: Exim Queue Emails
128
+ unit: "emails"
129
+ chart_type: line
130
+ dimensions:
131
+ - name: emails
collectors/python.d.plugin/gearman/gearman.conf
+4
-1
@@ -61,8 +61,11 @@
61
#
62
# Additionally to the above, gearman also supports the following:
63
#
64
-# hostname: localhost # The host running the Gearman server
64
+# host: localhost # The host running the Gearman server
65
# port: 4730 # Port of the Gearman server
66
+# tls: no # Whether to use TLS or not
67
+# cert: /path/to/cert # Path to cert if using TLS
68
+# key: /path/to/key # Path to key if using TLS
69
# ----------------------------------------------------------------------
70
# AUTO-DETECTION JOB
71
collectors/python.d.plugin/gearman/metadata.yaml
+124
-46
@@ -1,62 +1,140 @@
1
+# yamllint disable rule:line-length
2
meta:
3
plugin_name: python.d.plugin
4
module_name: gearman
5
monitored_instance:
6
name: Gearman
6
- link: ''
7
+ link: "http://gearman.org/"
8
categories:
8
- - data-collection.distributed-computing-systems
9
- icon_filename: 'gearman.png'
9
+ - data-collection.distributed-computing-systems
10
+ icon_filename: "gearman.png"
11
related_resources:
12
integrations:
13
list: []
14
info_provided_to_referring_integrations:
14
- description: ''
15
- keywords: []
15
+ description: ""
16
+ keywords:
17
+ - gearman
18
+ - gearman job server
19
most_popular: false
20
overview:
21
data_collection:
19
- metrics_description: 'Monitor Gearman metrics for proficient system task distribution. Track job counts, worker statuses, and queue lengths for effective distributed task management.'
20
- method_description: ''
22
+ metrics_description: "Monitor Gearman metrics for proficient system task distribution. Track job counts, worker statuses, and queue lengths for effective distributed task management."
23
+ method_description: "This collector connects to a Gearman instance via either TCP or unix socket."
24
supported_platforms:
25
include: []
26
exclude: []
27
multi_instance: true
28
additional_permissions:
26
- description: ''
29
+ description: ""
30
default_behavior:
31
auto_detection:
29
- description: ''
32
+ description: "When no configuration file is found, the collector tries to connect to TCP/IP socket: localhost:4730."
33
limits:
31
- description: ''
34
+ description: ""
35
performance_impact:
33
- description: ''
36
+ description: ""
37
setup:
38
prerequisites:
36
- list: []
39
+ list:
40
+ - title: "Socket permissions"
41
+ description: The gearman UNIX socket should have read permission for user netdata.
42
configuration:
43
file:
39
- name: ''
40
- description: ''
44
+ name: python.d/gearman.conf
45
options:
42
- description: ''
46
+ description: |
47
+ There are 2 sections:
48
+
49
+ * Global variables
50
+ * One or more JOBS that can define multiple different instances to monitor.
51
+
52
+ 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.
53
+
54
+ Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
55
+
56
+ Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
57
folding:
44
- title: ''
58
+ title: "Config options"
59
enabled: true
46
- list: []
60
+ list:
61
+ - name: update_every
62
+ description: Sets the default data collection frequency.
63
+ default_value: 5
64
+ required: false
65
+ - name: priority
66
+ description: Controls the order of charts at the netdata dashboard.
67
+ default_value: 60000
68
+ required: false
69
+ - name: autodetection_retry
70
+ description: Sets the job re-check interval in seconds.
71
+ default_value: 0
72
+ required: false
73
+ - name: penalty
74
+ description: Indicates whether to apply penalty to update_every in case of failures.
75
+ default_value: yes
76
+ required: false
77
+ - name: name
78
+ description: Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
79
+ default_value: ""
80
+ required: false
81
+ - name: host
82
+ description: URL or IP where gearman is running.
83
+ default_value: "localhost"
84
+ required: false
85
+ - name: port
86
+ description: Port of URL or IP where gearman is running.
87
+ default_value: "4730"
88
+ required: false
89
+ - name: tls
90
+ description: Use tls to connect to gearman.
91
+ default_value: "false"
92
+ required: false
93
+ - name: cert
94
+ description: Provide a certificate file if needed to connect to a TLS gearman instance.
95
+ default_value: ""
96
+ required: false
97
+ - name: key
98
+ description: Provide a key file if needed to connect to a TLS gearman instance.
99
+ default_value: ""
100
+ required: false
101
examples:
102
folding:
103
enabled: true
50
- title: ''
51
- list: []
104
+ title: "Config"
105
+ list:
106
+ - name: Local gearman service
107
+ description: A basic host and port gearman configuration for localhost.
108
+ folding:
109
+ enabled: false
110
+ config: |
111
+ localhost:
112
+ name: 'local'
113
+ host: 'localhost'
114
+ port: 4730
115
+ - name: Multi-instance
116
+ description: |
117
+ > **Note**: When you define multiple jobs, their names must be unique.
118
+
119
+ Collecting metrics from local and remote instances.
120
+ config: |
121
+ localhost:
122
+ name: 'local'
123
+ host: 'localhost'
124
+ port: 4730
125
+
126
+ remote:
127
+ name: 'remote'
128
+ host: '192.0.2.1'
129
+ port: 4730
130
troubleshooting:
131
problems:
132
list: []
133
alerts:
56
-- name: gearman_workers_queued
57
- link: https://github.com/netdata/netdata/blob/master/health/health.d/gearman.conf
58
- metric: gearman.single_job
59
- info: average number of queued jobs over the last 10 minutes
134
+ - name: gearman_workers_queued
135
+ link: https://github.com/netdata/netdata/blob/master/health/health.d/gearman.conf
136
+ metric: gearman.single_job
137
+ info: average number of queued jobs over the last 10 minutes
138
metrics:
139
folding:
140
title: Metrics
@@ -64,26 +142,26 @@ metrics:
142
description: ""
143
availability: []
144
scopes:
67
- - name: global
68
- description: ""
69
- labels: []
70
- metrics:
71
- - name: gearman.total_jobs
72
- description: Total Jobs
73
- unit: "Jobs"
74
- chart_type: line
75
- dimensions:
76
- - name: Pending
77
- - name: Running
78
- - name: gearman job
79
- description: ""
80
- labels: []
81
- metrics:
82
- - name: gearman.single_job
83
- description: '{job_name}'
84
- unit: "Jobs"
85
- chart_type: stacked
86
- dimensions:
87
- - name: Pending
88
- - name: Idle
89
- - name: Runnning
145
+ - name: global
146
+ description: "These metrics refer to the entire monitored application."
147
+ labels: []
148
+ metrics:
149
+ - name: gearman.total_jobs
150
+ description: Total Jobs
151
+ unit: "Jobs"
152
+ chart_type: line
153
+ dimensions:
154
+ - name: Pending
155
+ - name: Running
156
+ - name: gearman job
157
+ description: "Metrics related to Gearman jobs. Each job produces its own set of the following metrics."
158
+ labels: []
159
+ metrics:
160
+ - name: gearman.single_job
161
+ description: "{job_name}"
162
+ unit: "Jobs"
163
+ chart_type: stacked
164
+ dimensions:
165
+ - name: Pending
166
+ - name: Idle
167
+ - name: Runnning
collectors/python.d.plugin/go_expvar/metadata.yaml
+276
-67
@@ -1,54 +1,263 @@
1
+# yamllint disable rule:line-length
2
meta:
3
plugin_name: python.d.plugin
4
module_name: go_expvar
5
monitored_instance:
6
name: Go applications
6
- link: ''
7
+ link: "https://pkg.go.dev/expvar"
8
categories:
8
- - data-collection.apm
9
- icon_filename: 'go.png'
9
+ - data-collection.apm
10
+ icon_filename: "go.png"
11
related_resources:
12
integrations:
13
list: []
14
info_provided_to_referring_integrations:
14
- description: ''
15
- keywords: []
15
+ description: ""
16
+ keywords:
17
+ - go
18
+ - expvar
19
+ - application
20
most_popular: false
21
overview:
22
data_collection:
19
- metrics_description: 'Monitor Go applications performance for optimal Go language software operations. Monitor runtime statistics, garbage collection, and memory usage to enhance Go application performance.'
20
- method_description: ''
23
+ metrics_description: "This collector monitors Go applications that expose their metrics with the use of the `expvar` package from the Go standard library. It produces charts for Go runtime memory statistics and optionally any number of custom charts."
24
+ method_description: "It connects via http to gather the metrics exposed via the `expvar` package."
25
supported_platforms:
26
include: []
27
exclude: []
28
multi_instance: true
29
additional_permissions:
26
- description: ''
30
+ description: ""
31
default_behavior:
32
auto_detection:
29
- description: ''
33
+ description: ""
34
limits:
31
- description: ''
35
+ description: ""
36
performance_impact:
33
- description: ''
37
+ description: ""
38
setup:
39
prerequisites:
36
- list: []
40
+ list:
41
+ - title: "Sample `expvar` usage in a Go application"
42
+ description: |
43
+ The `expvar` package exposes metrics over HTTP and is very easy to use.
44
+ Consider this minimal sample below:
45
+
46
+ ```go
47
+ package main
48
+
49
+ import (
50
+ _ "expvar"
51
+ "net/http"
52
+ )
53
+
54
+ func main() {
55
+ http.ListenAndServe("127.0.0.1:8080", nil)
56
+ }
57
+ ```
58
+
59
+ When imported this way, the `expvar` package registers a HTTP handler at `/debug/vars` that
60
+ exposes Go runtime's memory statistics in JSON format. You can inspect the output by opening
61
+ the URL in your browser (or by using `wget` or `curl`).
62
+
63
+ Sample output:
64
+
65
+ ```json
66
+ {
67
+ "cmdline": ["./expvar-demo-binary"],
68
+ "memstats": {"Alloc":630856,"TotalAlloc":630856,"Sys":3346432,"Lookups":27, <omitted for brevity>}
69
+ }
70
+ ```
71
+
72
+ You can of course expose and monitor your own variables as well.
73
+ Here is a sample Go application that exposes a few custom variables:
74
+
75
+ ```go
76
+ package main
77
+
78
+ import (
79
+ "expvar"
80
+ "net/http"
81
+ "runtime"
82
+ "time"
83
+ )
84
+
85
+ func main() {
86
+
87
+ tick := time.NewTicker(1 * time.Second)
88
+ num_go := expvar.NewInt("runtime.goroutines")
89
+ counters := expvar.NewMap("counters")
90
+ counters.Set("cnt1", new(expvar.Int))
91
+ counters.Set("cnt2", new(expvar.Float))
92
+
93
+ go http.ListenAndServe(":8080", nil)
94
+
95
+ for {
96
+ select {
97
+ case <- tick.C:
98
+ num_go.Set(int64(runtime.NumGoroutine()))
99
+ counters.Add("cnt1", 1)
100
+ counters.AddFloat("cnt2", 1.452)
101
+ }
102
+ }
103
+ }
104
+ ```
105
+
106
+ Apart from the runtime memory stats, this application publishes two counters and the
107
+ number of currently running Goroutines and updates these stats every second.
108
configuration:
109
file:
39
- name: ''
40
- description: ''
110
+ name: python.d/go_expvar.conf
111
options:
42
- description: ''
112
+ description: |
113
+ There are 2 sections:
114
+
115
+ * Global variables
116
+ * One or more JOBS that can define multiple different instances to monitor.
117
+
118
+ 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.
119
+
120
+ Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
121
+
122
+ Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified. Each JOB can be used to monitor a different Go application.
123
folding:
44
- title: ''
124
+ title: "Config options"
125
enabled: true
46
- list: []
126
+ list:
127
+ - name: update_every
128
+ description: Sets the default data collection frequency.
129
+ default_value: 5
130
+ required: false
131
+ - name: priority
132
+ description: Controls the order of charts at the netdata dashboard.
133
+ default_value: 60000
134
+ required: false
135
+ - name: autodetection_retry
136
+ description: Sets the job re-check interval in seconds.
137
+ default_value: 0
138
+ required: false
139
+ - name: penalty
140
+ description: Indicates whether to apply penalty to update_every in case of failures.
141
+ default_value: yes
142
+ required: false
143
+ - name: name
144
+ description: Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
145
+ default_value: ""
146
+ required: false
147
+ - name: url
148
+ description: the URL and port of the expvar endpoint. Please include the whole path of the endpoint, as the expvar handler can be installed in a non-standard location.
149
+ default_value: ""
150
+ required: true
151
+ - name: user
152
+ description: If the URL is password protected, this is the username to use.
153
+ default_value: ""
154
+ required: false
155
+ - name: pass
156
+ description: If the URL is password protected, this is the password to use.
157
+ default_value: ""
158
+ required: false
159
+ - name: collect_memstats
160
+ description: Enables charts for Go runtime's memory statistics.
161
+ default_value: ""
162
+ required: false
163
+ - name: extra_charts
164
+ description: Defines extra data/charts to monitor, please see the example below.
165
+ default_value: ""
166
+ required: false
167
examples:
168
folding:
49
- enabled: true
50
- title: ''
51
- list: []
169
+ enabled: false
170
+ title: "Config"
171
+ list:
172
+ - name: Monitor a Go app1 application
173
+ description: |
174
+ The example below sets a configuration for a Go application, called `app1`. Besides the `memstats`, the application also exposes two counters and the number of currently running Goroutines and updates these stats every second.
175
+
176
+ The `go_expvar` collector can monitor these as well with the use of the `extra_charts` configuration variable.
177
+
178
+ The `extra_charts` variable is a YaML list of Netdata chart definitions.
179
+ Each chart definition has the following keys:
180
+
181
+ ```
182
+ id: Netdata chart ID
183
+ options: a key-value mapping of chart options
184
+ lines: a list of line definitions
185
+ ```
186
+
187
+ **Note: please do not use dots in the chart or line ID field.
188
+ See [this issue](https://github.com/netdata/netdata/pull/1902#issuecomment-284494195) for explanation.**
189
+
190
+ Please see these two links to the official Netdata documentation for more information about the values:
191
+
192
+ - [External plugins - charts](https://github.com/netdata/netdata/blob/master/collectors/plugins.d/README.md#chart)
193
+ - [Chart variables](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/README.md#global-variables-order-and-chart)
194
+
195
+ **Line definitions**
196
+
197
+ Each chart can define multiple lines (dimensions).
198
+ A line definition is a key-value mapping of line options.
199
+ Each line can have the following options:
200
+
201
+ ```
202
+ # mandatory
203
+ expvar_key: the name of the expvar as present in the JSON output of /debug/vars endpoint
204
+ expvar_type: value type; supported are "float" or "int"
205
+ id: the id of this line/dimension in Netdata
206
+
207
+ # optional - Netdata defaults are used if these options are not defined
208
+ name: ''
209
+ algorithm: absolute
210
+ multiplier: 1
211
+ divisor: 100 if expvar_type == float, 1 if expvar_type == int
212
+ hidden: False
213
+ ```
214
+
215
+ Please see the following link for more information about the options and their default values:
216
+ [External plugins - dimensions](https://github.com/netdata/netdata/blob/master/collectors/plugins.d/README.md#dimension)
217
+
218
+ Apart from top-level expvars, this plugin can also parse expvars stored in a multi-level map;
219
+ All dicts in the resulting JSON document are then flattened to one level.
220
+ Expvar names are joined together with '.' when flattening.
221
+
222
+ Example:
223
+
224
+ ```
225
+ {
226
+ "counters": {"cnt1": 1042, "cnt2": 1512.9839999999983},
227
+ "runtime.goroutines": 5
228
+ }
229
+ ```
230
+
231
+ In the above case, the exported variables will be available under `runtime.goroutines`,
232
+ `counters.cnt1` and `counters.cnt2` expvar_keys. If the flattening results in a key collision,
233
+ the first defined key wins and all subsequent keys with the same name are ignored.
234
+ config: |
235
+ app1:
236
+ name : 'app1'
237
+ url : 'http://127.0.0.1:8080/debug/vars'
238
+ collect_memstats: true
239
+ extra_charts:
240
+ - id: "runtime_goroutines"
241
+ options:
242
+ name: num_goroutines
243
+ title: "runtime: number of goroutines"
244
+ units: goroutines
245
+ family: runtime
246
+ context: expvar.runtime.goroutines
247
+ chart_type: line
248
+ lines:
249
+ - {expvar_key: 'runtime.goroutines', expvar_type: int, id: runtime_goroutines}
250
+ - id: "foo_counters"
251
+ options:
252
+ name: counters
253
+ title: "some random counters"
254
+ units: awesomeness
255
+ family: counters
256
+ context: expvar.foo.counters
257
+ chart_type: line
258
+ lines:
259
+ - {expvar_key: 'counters.cnt1', expvar_type: int, id: counters_cnt1}
260
+ - {expvar_key: 'counters.cnt2', expvar_type: float, id: counters_cnt2}
261
troubleshooting:
262
problems:
263
list: []
@@ -60,50 +269,50 @@ metrics:
269
description: ""
270
availability: []
271
scopes:
63
- - name: global
64
- description: ""
65
- labels: []
66
- metrics:
67
- - name: expvar.memstats.heap
68
- description: 'memory: size of heap memory structures'
69
- unit: "KiB"
70
- chart_type: line
71
- dimensions:
72
- - name: alloc
73
- - name: inuse
74
- - name: expvar.memstats.stack
75
- description: 'memory: size of stack memory structures'
76
- unit: "KiB"
77
- chart_type: line
78
- dimensions:
79
- - name: inuse
80
- - name: expvar.memstats.mspan
81
- description: 'memory: size of mspan memory structures'
82
- unit: "KiB"
83
- chart_type: line
84
- dimensions:
85
- - name: inuse
86
- - name: expvar.memstats.mcache
87
- description: 'memory: size of mcache memory structures'
88
- unit: "KiB"
89
- chart_type: line
90
- dimensions:
91
- - name: inuse
92
- - name: expvar.memstats.live_objects
93
- description: 'memory: number of live objects'
94
- unit: "objects"
95
- chart_type: line
96
- dimensions:
97
- - name: live
98
- - name: expvar.memstats.sys
99
- description: 'memory: size of reserved virtual address space'
100
- unit: "KiB"
101
- chart_type: line
102
- dimensions:
103
- - name: sys
104
- - name: expvar.memstats.gc_pauses
105
- description: 'memory: average duration of GC pauses'
106
- unit: "ns"
107
- chart_type: line
108
- dimensions:
109
- - name: avg
272
+ - name: global
273
+ description: "These metrics refer to the entire monitored application."
274
+ labels: []
275
+ metrics:
276
+ - name: expvar.memstats.heap
277
+ description: "memory: size of heap memory structures"
278
+ unit: "KiB"
279
+ chart_type: line
280
+ dimensions:
281
+ - name: alloc
282
+ - name: inuse
283
+ - name: expvar.memstats.stack
284
+ description: "memory: size of stack memory structures"
285
+ unit: "KiB"
286
+ chart_type: line
287
+ dimensions:
288
+ - name: inuse
289
+ - name: expvar.memstats.mspan
290
+ description: "memory: size of mspan memory structures"
291
+ unit: "KiB"
292
+ chart_type: line
293
+ dimensions:
294
+ - name: inuse
295
+ - name: expvar.memstats.mcache
296
+ description: "memory: size of mcache memory structures"
297
+ unit: "KiB"
298
+ chart_type: line
299
+ dimensions:
300
+ - name: inuse
301
+ - name: expvar.memstats.live_objects
302
+ description: "memory: number of live objects"
303
+ unit: "objects"
304
+ chart_type: line
305
+ dimensions:
306
+ - name: live
307
+ - name: expvar.memstats.sys
308
+ description: "memory: size of reserved virtual address space"
309
+ unit: "KiB"
310
+ chart_type: line
311
+ dimensions:
312
+ - name: sys
313
+ - name: expvar.memstats.gc_pauses
314
+ description: "memory: average duration of GC pauses"
315
+ unit: "ns"
316
+ chart_type: line
317
+ dimensions:
318
+ - name: avg
collectors/python.d.plugin/litespeed/metadata.yaml
+125
-82
@@ -1,54 +1,97 @@
1
+# yamllint disable rule:line-length
2
meta:
3
plugin_name: python.d.plugin
4
module_name: litespeed
5
monitored_instance:
6
name: Litespeed
6
- link: ''
7
+ link: "https://www.litespeedtech.com/products/litespeed-web-server"
8
categories:
8
- - data-collection.web-servers-and-web-proxies
9
- icon_filename: 'litespeed.svg'
9
+ - data-collection.web-servers-and-web-proxies
10
+ icon_filename: "litespeed.svg"
11
related_resources:
12
integrations:
13
list: []
14
info_provided_to_referring_integrations:
14
- description: ''
15
- keywords: []
15
+ description: ""
16
+ keywords:
17
+ - litespeed
18
+ - web
19
+ - server
20
most_popular: false
21
overview:
22
data_collection:
19
- metrics_description: 'Examine Litespeed metrics for insights into web server operations. Analyze request rates, response times, and error rates for efficient web service delivery.'
20
- method_description: ''
23
+ metrics_description: "Examine Litespeed metrics for insights into web server operations. Analyze request rates, response times, and error rates for efficient web service delivery."
24
+ method_description: "The collector uses the statistics under /tmp/lshttpd to gather the metrics."
25
supported_platforms:
26
include: []
27
exclude: []
24
- multi_instance: true
28
+ multi_instance: false
29
additional_permissions:
26
- description: ''
30
+ description: ""
31
default_behavior:
32
auto_detection:
29
- description: ''
33
+ description: "If no configuration is present, the collector will attempt to read files under /tmp/lshttpd/."
34
limits:
31
- description: ''
35
+ description: ""
36
performance_impact:
33
- description: ''
37
+ description: ""
38
setup:
39
prerequisites:
40
list: []
41
configuration:
42
file:
39
- name: ''
40
- description: ''
43
+ name: python.d/litespeed.conf
44
options:
42
- description: ''
45
+ description: |
46
+ There are 2 sections:
47
+
48
+ * Global variables
49
+ * One or more JOBS that can define multiple different instances to monitor.
50
+
51
+ 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.
52
+
53
+ Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
54
+
55
+ Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
56
folding:
44
- title: ''
57
+ title: "Config options"
58
enabled: true
46
- list: []
59
+ list:
60
+ - name: update_every
61
+ description: Sets the default data collection frequency.
62
+ default_value: 5
63
+ required: false
64
+ - name: priority
65
+ description: Controls the order of charts at the netdata dashboard.
66
+ default_value: 60000
67
+ required: false
68
+ - name: autodetection_retry
69
+ description: Sets the job re-check interval in seconds.
70
+ default_value: 0
71
+ required: false
72
+ - name: penalty
73
+ description: Indicates whether to apply penalty to update_every in case of failures.
74
+ default_value: yes
75
+ required: false
76
+ - name: name
77
+ description: Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
78
+ default_value: ""
79
+ required: false
80
+ - name: path
81
+ description: Use a different path than the default, where the lightspeed stats files reside.
82
+ default_value: "/tmp/lshttpd/"
83
+ required: false
84
examples:
85
folding:
49
- enabled: true
50
- title: ''
51
- list: []
86
+ enabled: false
87
+ title: "Config"
88
+ list:
89
+ - name: Set the path to statistics
90
+ description: Change the path for the litespeed stats files
91
+ config: |
92
+ localhost:
93
+ name: 'local'
94
+ path: '/tmp/lshttpd'
95
troubleshooting:
96
problems:
97
list: []
@@ -60,65 +103,65 @@ metrics:
103
description: ""
104
availability: []
105
scopes:
63
- - name: global
64
- description: ""
65
- labels: []
66
- metrics:
67
- - name: litespeed.net_throughput
68
- description: Network Throughput HTTP
69
- unit: "kilobits/s"
70
- chart_type: area
71
- dimensions:
72
- - name: in
73
- - name: out
74
- - name: litespeed.net_throughput
75
- description: Network Throughput HTTPS
76
- unit: "kilobits/s"
77
- chart_type: area
78
- dimensions:
79
- - name: in
80
- - name: out
81
- - name: litespeed.connections
82
- description: Connections HTTP
83
- unit: "conns"
84
- chart_type: stacked
85
- dimensions:
86
- - name: free
87
- - name: used
88
- - name: litespeed.connections
89
- description: Connections HTTPS
90
- unit: "conns"
91
- chart_type: stacked
92
- dimensions:
93
- - name: free
94
- - name: used
95
- - name: litespeed.requests
96
- description: Requests
97
- unit: "requests/s"
98
- chart_type: line
99
- dimensions:
100
- - name: requests
101
- - name: litespeed.requests_processing
102
- description: Requests In Processing
103
- unit: "requests"
104
- chart_type: line
105
- dimensions:
106
- - name: processing
107
- - name: litespeed.cache
108
- description: Public Cache Hits
109
- unit: "hits/s"
110
- chart_type: line
111
- dimensions:
112
- - name: hits
113
- - name: litespeed.cache
114
- description: Private Cache Hits
115
- unit: "hits/s"
116
- chart_type: line
117
- dimensions:
118
- - name: hits
119
- - name: litespeed.static
120
- description: Static Hits
121
- unit: "hits/s"
122
- chart_type: line
123
- dimensions:
124
- - name: hits
106
+ - name: global
107
+ description: "These metrics refer to the entire monitored application."
108
+ labels: []
109
+ metrics:
110
+ - name: litespeed.net_throughput
111
+ description: Network Throughput HTTP
112
+ unit: "kilobits/s"
113
+ chart_type: area
114
+ dimensions:
115
+ - name: in
116
+ - name: out
117
+ - name: litespeed.net_throughput
118
+ description: Network Throughput HTTPS
119
+ unit: "kilobits/s"
120
+ chart_type: area
121
+ dimensions:
122
+ - name: in
123
+ - name: out
124
+ - name: litespeed.connections
125
+ description: Connections HTTP
126
+ unit: "conns"
127
+ chart_type: stacked
128
+ dimensions:
129
+ - name: free
130
+ - name: used
131
+ - name: litespeed.connections
132
+ description: Connections HTTPS
133
+ unit: "conns"
134
+ chart_type: stacked
135
+ dimensions:
136
+ - name: free
137
+ - name: used
138
+ - name: litespeed.requests
139
+ description: Requests
140
+ unit: "requests/s"
141
+ chart_type: line
142
+ dimensions:
143
+ - name: requests
144
+ - name: litespeed.requests_processing
145
+ description: Requests In Processing
146
+ unit: "requests"
147
+ chart_type: line
148
+ dimensions:
149
+ - name: processing
150
+ - name: litespeed.cache
151
+ description: Public Cache Hits
152
+ unit: "hits/s"
153
+ chart_type: line
154
+ dimensions:
155
+ - name: hits
156
+ - name: litespeed.cache
157
+ description: Private Cache Hits
158
+ unit: "hits/s"
159
+ chart_type: line
160
+ dimensions:
161
+ - name: hits
162
+ - name: litespeed.static
163
+ description: Static Hits
164
+ unit: "hits/s"
165
+ chart_type: line
166
+ dimensions:
167
+ - name: hits
collectors/python.d.plugin/retroshare/metadata.yaml
+100
-48
@@ -1,62 +1,114 @@
1
+# yamllint disable rule:line-length
2
meta:
3
plugin_name: python.d.plugin
4
module_name: retroshare
5
monitored_instance:
6
name: RetroShare
6
- link: ''
7
+ link: "https://retroshare.cc/"
8
categories:
8
- - data-collection.p2p
9
- icon_filename: 'retroshare.png'
9
+ - data-collection.p2p
10
+ icon_filename: "retroshare.png"
11
related_resources:
12
integrations:
13
list: []
14
info_provided_to_referring_integrations:
14
- description: ''
15
- keywords: []
15
+ description: ""
16
+ keywords:
17
+ - retroshare
18
+ - p2p
19
most_popular: false
20
overview:
21
data_collection:
19
- metrics_description: 'Monitor RetroShare metrics for efficient peer-to-peer communication and file sharing. Enhance your communication and file sharing performance with real-time insights and alerts from Netdata.'
20
- method_description: ''
22
+ metrics_description: "This collector monitors RetroShare statistics such as application bandwidth, peers, and DHT metrics."
23
+ method_description: "It connects to the RetroShare web interface to gather metrics."
24
supported_platforms:
25
include: []
26
exclude: []
27
multi_instance: true
28
additional_permissions:
26
- description: ''
29
+ description: ""
30
default_behavior:
31
auto_detection:
29
- description: ''
32
+ description: "The collector will attempt to connect and detect a RetroShare web interface through http://localhost:9090, even without any configuration."
33
limits:
31
- description: ''
34
+ description: ""
35
performance_impact:
33
- description: ''
36
+ description: ""
37
setup:
38
prerequisites:
36
- list: []
39
+ list:
40
+ - title: "RetroShare web interface"
41
+ description: |
42
+ RetroShare needs to be configured to enable the RetroShare WEB Interface and allow access from the Netdata host.
43
configuration:
44
file:
39
- name: ''
40
- description: ''
45
+ name: python.d/retroshare.conf
46
options:
42
- description: ''
47
+ description: |
48
+ There are 2 sections:
49
+
50
+ * Global variables
51
+ * One or more JOBS that can define multiple different instances to monitor.
52
+
53
+ 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.
54
+
55
+ Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
56
+
57
+ Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
58
folding:
44
- title: ''
59
+ title: "Config options"
60
enabled: true
46
- list: []
61
+ list:
62
+ - name: update_every
63
+ description: Sets the default data collection frequency.
64
+ default_value: 5
65
+ required: false
66
+ - name: priority
67
+ description: Controls the order of charts at the netdata dashboard.
68
+ default_value: 60000
69
+ required: false
70
+ - name: autodetection_retry
71
+ description: Sets the job re-check interval in seconds.
72
+ default_value: 0
73
+ required: false
74
+ - name: penalty
75
+ description: Indicates whether to apply penalty to update_every in case of failures.
76
+ default_value: yes
77
+ required: false
78
+ - name: name
79
+ description: Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
80
+ default_value: ""
81
+ required: false
82
+ - name: url
83
+ description: The URL to the RetroShare Web UI.
84
+ default_value: "http://localhost:9090"
85
+ required: false
86
examples:
87
folding:
88
enabled: true
50
- title: ''
51
- list: []
89
+ title: "Config"
90
+ list:
91
+ - name: Local RetroShare Web UI
92
+ description: A basic configuration for a RetroShare server running on localhost.
93
+ config: |
94
+ localhost:
95
+ name: 'local retroshare'
96
+ url: 'http://localhost:9090'
97
+ - name: Remote RetroShare Web UI
98
+ description: A basic configuration for a remote RetroShare server.
99
+ config: |
100
+ remote:
101
+ name: 'remote retroshare'
102
+ url: 'http://1.2.3.4:9090'
103
+
104
troubleshooting:
105
problems:
106
list: []
107
alerts:
56
-- name: retroshare_dht_working
57
- link: https://github.com/netdata/netdata/blob/master/health/health.d/retroshare.conf
58
- metric: retroshare.dht
59
- info: number of DHT peers
108
+ - name: retroshare_dht_working
109
+ link: https://github.com/netdata/netdata/blob/master/health/health.d/retroshare.conf
110
+ metric: retroshare.dht
111
+ info: number of DHT peers
112
metrics:
113
folding:
114
title: Metrics
@@ -64,28 +116,28 @@ metrics:
116
description: ""
117
availability: []
118
scopes:
67
- - name: global
68
- description: ""
69
- labels: []
70
- metrics:
71
- - name: retroshare.bandwidth
72
- description: RetroShare Bandwidth
73
- unit: "kilobits/s"
74
- chart_type: area
75
- dimensions:
76
- - name: Upload
77
- - name: Download
78
- - name: retroshare.peers
79
- description: RetroShare Peers
80
- unit: "peers"
81
- chart_type: line
82
- dimensions:
83
- - name: All friends
84
- - name: Connected friends
85
- - name: retroshare.dht
86
- description: Retroshare DHT
87
- unit: "peers"
88
- chart_type: line
89
- dimensions:
90
- - name: DHT nodes estimated
91
- - name: RS nodes estimated
119
+ - name: global
120
+ description: "These metrics refer to the entire monitored application."
121
+ labels: []
122
+ metrics:
123
+ - name: retroshare.bandwidth
124
+ description: RetroShare Bandwidth
125
+ unit: "kilobits/s"
126
+ chart_type: area
127
+ dimensions:
128
+ - name: Upload
129
+ - name: Download
130
+ - name: retroshare.peers
131
+ description: RetroShare Peers
132
+ unit: "peers"
133
+ chart_type: line
134
+ dimensions:
135
+ - name: All friends
136
+ - name: Connected friends
137
+ - name: retroshare.dht
138
+ description: Retroshare DHT
139
+ unit: "peers"
140
+ chart_type: line
141
+ dimensions:
142
+ - name: DHT nodes estimated
143
+ - name: RS nodes estimated
collectors/python.d.plugin/w1sensor/metadata.yaml
+77
-31
@@ -1,54 +1,100 @@
1
+# yamllint disable rule:line-length
2
meta:
3
plugin_name: python.d.plugin
4
module_name: w1sensor
5
monitored_instance:
6
name: 1-Wire Sensors
6
- link: ''
7
+ link: "https://www.analog.com/en/product-category/1wire-temperature-sensors.html"
8
categories:
8
- - data-collection.hardware-devices-and-sensors
9
- icon_filename: '1-wire.png'
9
+ - data-collection.hardware-devices-and-sensors
10
+ icon_filename: "1-wire.png"
11
related_resources:
12
integrations:
13
list: []
14
info_provided_to_referring_integrations:
14
- description: ''
15
- keywords: []
15
+ description: ""
16
+ keywords:
17
+ - temperature
18
+ - sensor
19
+ - 1-wire
20
most_popular: false
21
overview:
22
data_collection:
19
- metrics_description: 'Monitor 1-Wire Sensors metrics with Netdata for optimal environmental conditions monitoring. Enhance your environmental monitoring with real-time insights and alerts.'
20
- method_description: ''
23
+ metrics_description: "Monitor 1-Wire Sensors metrics with Netdata for optimal environmental conditions monitoring. Enhance your environmental monitoring with real-time insights and alerts."
24
+ method_description: "The collector uses the wire, w1_gpio, and w1_therm kernel modules. Currently temperature sensors are supported and automatically detected."
25
supported_platforms:
22
- include: []
26
+ include:
27
+ - Linux
28
exclude: []
29
multi_instance: true
30
additional_permissions:
26
- description: ''
31
+ description: ""
32
default_behavior:
33
auto_detection:
29
- description: ''
34
+ description: "The collector will try to auto detect available 1-Wire devices."
35
limits:
31
- description: ''
36
+ description: ""
37
performance_impact:
33
- description: ''
38
+ description: ""
39
setup:
40
prerequisites:
36
- list: []
41
+ list:
42
+ - title: "Required Linux kernel modules"
43
+ description: "Make sure `wire`, `w1_gpio`, and `w1_therm` kernel modules are loaded."
44
configuration:
45
file:
39
- name: ''
40
- description: ''
46
+ name: python.d/w1sensor.conf
47
options:
42
- description: ''
48
+ description: |
49
+ There are 2 sections:
50
+
51
+ * Global variables
52
+ * One or more JOBS that can define multiple different instances to monitor.
53
+
54
+ 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.
55
+
56
+ Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
57
+
58
+ Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
59
folding:
44
- title: ''
60
+ title: "Config options"
61
enabled: true
46
- list: []
62
+ list:
63
+ - name: update_every
64
+ description: Sets the default data collection frequency.
65
+ default_value: 5
66
+ required: false
67
+ - name: priority
68
+ description: Controls the order of charts at the netdata dashboard.
69
+ default_value: 60000
70
+ required: false
71
+ - name: autodetection_retry
72
+ description: Sets the job re-check interval in seconds.
73
+ default_value: 0
74
+ required: false
75
+ - name: penalty
76
+ description: Indicates whether to apply penalty to update_every in case of failures.
77
+ default_value: yes
78
+ required: false
79
+ - name: name
80
+ description: Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
81
+ default_value: ""
82
+ required: false
83
+ - name: name_<1-Wire id>
84
+ description: This allows associating a human readable name with a sensor's 1-Wire identifier.
85
+ default_value: ""
86
+ required: false
87
examples:
88
folding:
49
- enabled: true
50
- title: ''
51
- list: []
89
+ enabled: false
90
+ title: "Config"
91
+ list:
92
+ - name: Provide human readable names
93
+ description: Associate two 1-Wire identifiers with human readable names.
94
+ config: |
95
+ sensors:
96
+ name_00000022276e: 'Machine room'
97
+ name_00000022298f: 'Rack 12'
98
troubleshooting:
99
problems:
100
list: []
@@ -60,13 +106,13 @@ metrics:
106
description: ""
107
availability: []
108
scopes:
63
- - name: global
64
- description: ""
65
- labels: []
66
- metrics:
67
- - name: w1sensor.temp
68
- description: 1-Wire Temperature Sensor
69
- unit: "Celsius"
70
- chart_type: line
71
- dimensions:
72
- - name: a dimension per sensor
109
+ - name: global
110
+ description: "These metrics refer to the entire monitored application."
111
+ labels: []
112
+ metrics:
113
+ - name: w1sensor.temp
114
+ description: 1-Wire Temperature Sensor
115
+ unit: "Celsius"
116
+ chart_type: line
117
+ dimensions:
118
+ - name: a dimension per sensor
collectors/python.d.plugin/w1sensor/w1sensor.conf
+1
-1
@@ -59,7 +59,7 @@
59
# penalty: yes # the JOB's penalty
60
# autodetection_retry: 0 # the JOB's re-check interval in seconds
61
#
62
-# Additionally to the above, example also supports the following:
62
+# Additionally to the above, w1sensor also supports the following:
63
#
64
# name_<1-Wire id>: '<human readable name>'
65
# This allows associating a human readable name with a sensor's 1-Wire