blob: ec6e6538d6cefd3f6cd5d029c44b20456e2d50b4 (
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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
|
plugin_name: go.d.plugin
modules:
- meta:
id: collector-go.d.plugin-unbound
plugin_name: go.d.plugin
module_name: unbound
monitored_instance:
name: Unbound
link: https://nlnetlabs.nl/projects/unbound/about/
icon_filename: unbound.png
categories:
- data-collection.dns-and-dhcp-servers
keywords:
- unbound
- dns
related_resources:
integrations:
list: []
info_provided_to_referring_integrations:
description: ""
most_popular: false
overview:
data_collection:
metrics_description: |
This collector monitors Unbound servers.
method_description: ""
supported_platforms:
include: []
exclude: []
multi_instance: true
additional_permissions:
description: ""
default_behavior:
auto_detection:
description: ""
limits:
description: ""
performance_impact:
description: ""
setup:
prerequisites:
list:
- title: Enable remote control interface
description: |
Set `control-enable` to yes in [unbound.conf](https://nlnetlabs.nl/documentation/unbound/unbound.conf).
- title: Check permissions and adjust if necessary
description: |
If using unix socket:
- socket should be readable and writeable by `netdata` user
If using ip socket and TLS is disabled:
- socket should be accessible via network
If TLS is enabled, in addition:
- `control-key-file` should be readable by `netdata` user
- `control-cert-file` should be readable by `netdata` user
For auto-detection parameters from `unbound.conf`:
- `unbound.conf` should be readable by `netdata` user
- if you have several configuration files (include feature) all of them should be readable by `netdata` user
configuration:
file:
name: go.d/unbound.conf
options:
description: |
The following options can be defined globally: update_every, autodetection_retry.
folding:
title: Config options
enabled: true
list:
- name: update_every
description: Data collection frequency.
default_value: 5
required: false
- name: autodetection_retry
description: Recheck interval in seconds. Zero means no recheck will be scheduled.
default_value: 0
required: false
- name: address
description: Server address in IP:PORT format.
default_value: 127.0.0.1:8953
required: true
- name: timeout
description: Connection/read/write/ssl handshake timeout.
default_value: 1
required: false
- name: conf_path
description: Absolute path to the unbound configuration file.
default_value: /etc/unbound/unbound.conf
required: false
- name: cumulative_stats
description: Statistics collection mode. Should have the same value as the `statistics-cumulative` parameter in the unbound configuration file.
default_value: false
required: false
- name: use_tls
description: Whether to use TLS or not.
default_value: true
required: false
- name: tls_skip_verify
description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
default_value: true
required: false
- name: tls_ca
description: Certificate authority that client use when verifying server certificates.
default_value: ""
required: false
- name: tls_cert
description: Client tls certificate.
default_value: /etc/unbound/unbound_control.pem
required: false
- name: tls_key
description: Client tls key.
default_value: /etc/unbound/unbound_control.key
required: false
examples:
folding:
title: Config
enabled: true
list:
- name: Basic
description: An example configuration.
config: |
jobs:
- name: local
address: 127.0.0.1:8953
- name: Unix socket
description: Connecting through Unix socket.
config: |
jobs:
- name: socket
address: /var/run/unbound.sock
- name: Multi-instance
description: |
> **Note**: When you define multiple jobs, their names must be unique.
Local and remote instances.
config: |
jobs:
- name: local
address: 127.0.0.1:8953
- name: remote
address: 203.0.113.11:8953
troubleshooting:
problems:
list: []
alerts: []
metrics:
folding:
title: Metrics
enabled: false
description: ""
availability: []
scopes:
- name: global
description: These metrics refer to the entire monitored application.
labels: []
metrics:
- name: unbound.queries
description: Received Queries
unit: queries
chart_type: line
dimensions:
- name: queries
- name: unbound.queries_ip_ratelimited
description: Rate Limited Queries
unit: queries
chart_type: line
dimensions:
- name: ratelimited
- name: unbound.dnscrypt_queries
description: DNSCrypt Queries
unit: queries
chart_type: line
dimensions:
- name: crypted
- name: cert
- name: cleartext
- name: malformed
- name: unbound.cache
description: Cache Statistics
unit: events
chart_type: stacked
dimensions:
- name: hits
- name: miss
- name: unbound.cache_percentage
description: Cache Statistics Percentage
unit: percentage
chart_type: stacked
dimensions:
- name: hits
- name: miss
- name: unbound.prefetch
description: Cache Prefetches
unit: prefetches
chart_type: line
dimensions:
- name: prefetches
- name: unbound.expired
description: Replies Served From Expired Cache
unit: replies
chart_type: line
dimensions:
- name: expired
- name: unbound.zero_ttl_replies
description: Replies Served From Expired Cache
unit: replies
chart_type: line
dimensions:
- name: zero_ttl
- name: unbound.recursive_replies
description: Replies That Needed Recursive Processing
unit: replies
chart_type: line
dimensions:
- name: recursive
- name: unbound.recursion_time
description: Time Spent On Recursive Processing
unit: milliseconds
chart_type: line
dimensions:
- name: avg
- name: median
- name: unbound.request_list_usage
description: Request List Usage
unit: queries
chart_type: line
dimensions:
- name: avg
- name: max
- name: unbound.current_request_list_usage
description: Current Request List Usage
unit: queries
chart_type: area
dimensions:
- name: all
- name: users
- name: unbound.request_list_jostle_list
description: Request List Jostle List Events
unit: queries
chart_type: line
dimensions:
- name: overwritten
- name: dropped
- name: unbound.tcpusage
description: TCP Handler Buffers
unit: buffers
chart_type: line
dimensions:
- name: usage
- name: unbound.uptime
description: Uptime
unit: seconds
chart_type: line
dimensions:
- name: time
- name: unbound.cache_memory
description: Cache Memory
unit: KB
chart_type: stacked
dimensions:
- name: message
- name: rrset
- name: dnscrypt_nonce
- name: dnscrypt_shared_secret
- name: unbound.mod_memory
description: Module Memory
unit: KB
chart_type: stacked
dimensions:
- name: iterator
- name: respip
- name: validator
- name: subnet
- name: ipsec
- name: unbound.mem_streamwait
description: TCP and TLS Stream Waif Buffer Memory
unit: KB
chart_type: line
dimensions:
- name: streamwait
- name: unbound.cache_count
description: Cache Items Count
unit: items
chart_type: stacked
dimensions:
- name: infra
- name: key
- name: msg
- name: rrset
- name: dnscrypt_nonce
- name: shared_secret
- name: unbound.type_queries
description: Queries By Type
unit: queries
chart_type: stacked
dimensions:
- name: a dimension per query type
- name: unbound.class_queries
description: Queries By Class
unit: queries
chart_type: stacked
dimensions:
- name: a dimension per query class
- name: unbound.opcode_queries
description: Queries By OpCode
unit: queries
chart_type: stacked
dimensions:
- name: a dimension per query opcode
- name: unbound.flag_queries
description: Queries By Flag
unit: queries
chart_type: stacked
dimensions:
- name: qr
- name: aa
- name: tc
- name: rd
- name: ra
- name: z
- name: ad
- name: cd
- name: unbound.rcode_answers
description: Replies By RCode
unit: replies
chart_type: stacked
dimensions:
- name: a dimension per reply rcode
- name: thread
description: These metrics refer to threads.
labels: []
metrics:
- name: unbound.thread_queries
description: Thread Received Queries
unit: queries
chart_type: line
dimensions:
- name: queries
- name: unbound.thread_queries_ip_ratelimited
description: Thread Rate Limited Queries
unit: queries
chart_type: line
dimensions:
- name: ratelimited
- name: unbound.thread_dnscrypt_queries
description: Thread DNSCrypt Queries
unit: queries
chart_type: line
dimensions:
- name: crypted
- name: cert
- name: cleartext
- name: malformed
- name: unbound.thread_cache
description: Cache Statistics
unit: events
chart_type: line
dimensions:
- name: hits
- name: miss
- name: unbound.thread_cache_percentage
description: Cache Statistics Percentage
unit: percentage
chart_type: line
dimensions:
- name: hits
- name: miss
- name: unbound.thread_prefetch
description: Cache Prefetches
unit: prefetches
chart_type: line
dimensions:
- name: prefetches
- name: unbound.thread_expired
description: Replies Served From Expired Cache
unit: replies
chart_type: line
dimensions:
- name: expired
- name: unbound.thread_zero_ttl_replies
description: Replies Served From Expired Cache
unit: replies
chart_type: line
dimensions:
- name: zero_ttl
- name: unbound.thread_recursive_replies
description: Replies That Needed Recursive Processing
unit: replies
chart_type: line
dimensions:
- name: recursive
- name: unbound.thread_recursion_time
description: Time Spent On Recursive Processing
unit: milliseconds
chart_type: line
dimensions:
- name: avg
- name: median
- name: unbound.thread_request_list_usage
description: Time Spent On Recursive Processing
unit: queries
chart_type: line
dimensions:
- name: avg
- name: max
- name: unbound.thread_current_request_list_usage
description: Current Request List Usage
unit: queries
chart_type: line
dimensions:
- name: all
- name: users
- name: unbound.thread_request_list_jostle_list
description: Request List Jostle List Events
unit: queries
chart_type: line
dimensions:
- name: overwritten
- name: dropped
- name: unbound.thread_tcpusage
description: TCP Handler Buffers
unit: buffers
chart_type: line
dimensions:
- name: usage
|
