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
|
plugin_name: python.d.plugin
modules:
- meta:
plugin_name: python.d.plugin
module_name: bind_rndc
monitored_instance:
name: ISCBind (RNDC)
link: "https://www.isc.org/bind/"
categories:
- data-collection.dns-and-dhcp-servers
icon_filename: "isc.png"
related_resources:
integrations:
list: []
info_provided_to_referring_integrations:
description: ""
keywords:
- dns
- bind
- server
most_popular: false
overview:
data_collection:
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."
method_description: "This collector uses the `rndc` tool to dump (named.stats) statistics then read them to gather Bind Name Server summary performance metrics."
supported_platforms:
include: []
exclude: []
multi_instance: false
additional_permissions:
description: ""
default_behavior:
auto_detection:
description: "If no configuration is given, the collector will attempt to read named.stats file at `/var/log/bind/named.stats`"
limits:
description: ""
performance_impact:
description: ""
setup:
prerequisites:
list:
- title: "Minimum bind version and permissions"
description: "Version of bind must be >=9.6 and the Netdata user must have permissions to run `rndc stats`"
- title: "Setup log rotate for bind stats"
description: |
BIND appends logs at EVERY RUN. It is NOT RECOMMENDED to set `update_every` below 30 sec.
It is STRONGLY RECOMMENDED to create a `bind-rndc.conf` file for logrotate.
To set up BIND to dump stats do the following:
1. Add to 'named.conf.options' options {}:
`statistics-file "/var/log/bind/named.stats";`
2. Create bind/ directory in /var/log:
`cd /var/log/ && mkdir bind`
3. Change owner of directory to 'bind' user:
`chown bind bind/`
4. RELOAD (NOT restart) BIND:
`systemctl reload bind9.service`
5. Run as a root 'rndc stats' to dump (BIND will create named.stats in new directory)
To allow Netdata to run 'rndc stats' change '/etc/bind/rndc.key' group to netdata:
`chown :netdata rndc.key`
Last, BUT NOT least, is to create bind-rndc.conf in logrotate.d/:
```
/var/log/bind/named.stats {
daily
rotate 4
compress
delaycompress
create 0644 bind bind
missingok
postrotate
rndc reload > /dev/null
endscript
}
```
To test your logrotate conf file run as root:
`logrotate /etc/logrotate.d/bind-rndc -d (debug dry-run mode)`
configuration:
file:
name: python.d/bind_rndc.conf
options:
description: |
There are 2 sections:
* Global variables
* One or more JOBS that can define multiple different instances to monitor.
The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
folding:
title: "Config options"
enabled: true
list:
- name: update_every
description: Sets the default data collection frequency.
default_value: 5
required: false
- name: priority
description: Controls the order of charts at the netdata dashboard.
default_value: 60000
required: false
- name: autodetection_retry
description: Sets the job re-check interval in seconds.
default_value: 0
required: false
- name: penalty
description: Indicates whether to apply penalty to update_every in case of failures.
default_value: yes
required: false
- name: name
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.
default_value: ""
required: false
- name: named_stats_path
description: Path to the named stats, after being dumped by `nrdc`
default_value: "/var/log/bind/named.stats"
required: false
examples:
folding:
enabled: false
title: "Config"
list:
- name: Local bind stats
description: Define a local path to bind stats file
config: |
local:
named_stats_path: '/var/log/bind/named.stats'
troubleshooting:
problems:
list: []
alerts:
- name: bind_rndc_stats_file_size
link: https://github.com/netdata/netdata/blob/master/health/health.d/bind_rndc.conf
metric: bind_rndc.stats_size
info: BIND statistics-file size
metrics:
folding:
title: Metrics
enabled: false
description: ""
availability: []
scopes:
- name: global
description: "These metrics refer to the entire monitored application."
labels: []
metrics:
- name: bind_rndc.name_server_statistics
description: Name Server Statistics
unit: "stats"
chart_type: line
dimensions:
- name: requests
- name: rejected_queries
- name: success
- name: failure
- name: responses
- name: duplicate
- name: recursion
- name: nxrrset
- name: nxdomain
- name: non_auth_answer
- name: auth_answer
- name: dropped_queries
- name: bind_rndc.incoming_queries
description: Incoming queries
unit: "queries"
chart_type: line
dimensions:
- name: a dimension per incoming query type
- name: bind_rndc.outgoing_queries
description: Outgoing queries
unit: "queries"
chart_type: line
dimensions:
- name: a dimension per outgoing query type
- name: bind_rndc.stats_size
description: Named Stats File Size
unit: "MiB"
chart_type: line
dimensions:
- name: stats_size
|
