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
|
<!--startmeta
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/bind_rndc/README.md"
meta_yaml: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/bind_rndc/metadata.yaml"
sidebar_label: "ISC Bind (RNDC)"
learn_status: "Published"
learn_rel_path: "Data Collection/DNS and DHCP Servers"
most_popular: False
message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
endmeta-->
# ISC Bind (RNDC)
<img src="https://netdata.cloud/img/isc.png" width="150"/>
Plugin: python.d.plugin
Module: bind_rndc
<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
## Overview
Monitor ISCBind (RNDC) performance for optimal DNS server operations. Monitor query rates, response times, and error rates to ensure reliable DNS service delivery.
This collector uses the `rndc` tool to dump (named.stats) statistics then read them to gather Bind Name Server summary performance metrics.
This collector is supported on all platforms.
This collector only supports collecting metrics from a single instance of this integration.
### Default Behavior
#### Auto-Detection
If no configuration is given, the collector will attempt to read named.stats file at `/var/log/bind/named.stats`
#### Limits
The default configuration for this integration does not impose any limits on data collection.
#### Performance Impact
The default configuration for this integration is not expected to impose a significant performance impact on the system.
## Metrics
Metrics grouped by *scope*.
The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
### Per ISC Bind (RNDC) instance
These metrics refer to the entire monitored application.
This scope has no labels.
Metrics:
| Metric | Dimensions | Unit |
|:------|:----------|:----|
| bind_rndc.name_server_statistics | requests, rejected_queries, success, failure, responses, duplicate, recursion, nxrrset, nxdomain, non_auth_answer, auth_answer, dropped_queries | stats |
| bind_rndc.incoming_queries | a dimension per incoming query type | queries |
| bind_rndc.outgoing_queries | a dimension per outgoing query type | queries |
| bind_rndc.stats_size | stats_size | MiB |
## Alerts
The following alerts are available:
| Alert name | On metric | Description |
|:------------|:----------|:------------|
| [ bind_rndc_stats_file_size ](https://github.com/netdata/netdata/blob/master/health/health.d/bind_rndc.conf) | bind_rndc.stats_size | BIND statistics-file size |
## Setup
### Prerequisites
#### Minimum bind version and permissions
Version of bind must be >=9.6 and the Netdata user must have permissions to run `rndc stats`
#### Setup log rotate for bind stats
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
The configuration file name for this integration is `python.d/bind_rndc.conf`.
You can edit the configuration file using the `edit-config` script from the
Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#the-netdata-config-directory).
```bash
cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config python.d/bind_rndc.conf
```
#### Options
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.
<details><summary>Config options</summary>
| Name | Description | Default | Required |
|:----|:-----------|:-------|:--------:|
| update_every | Sets the default data collection frequency. | 5 | no |
| priority | Controls the order of charts at the netdata dashboard. | 60000 | no |
| autodetection_retry | Sets the job re-check interval in seconds. | 0 | no |
| penalty | Indicates whether to apply penalty to update_every in case of failures. | yes | no |
| name | 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. | | no |
| named_stats_path | Path to the named stats, after being dumped by `nrdc` | /var/log/bind/named.stats | no |
</details>
#### Examples
##### Local bind stats
Define a local path to bind stats file
```yaml
local:
named_stats_path: '/var/log/bind/named.stats'
```
## Troubleshooting
### Debug Mode
To troubleshoot issues with the `bind_rndc` collector, run the `python.d.plugin` with the debug option enabled. The output
should give you clues as to why the collector isn't working.
- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
```bash
cd /usr/libexec/netdata/plugins.d/
```
- Switch to the `netdata` user.
```bash
sudo -u netdata -s
```
- Run the `python.d.plugin` to debug the collector:
```bash
./python.d.plugin bind_rndc debug trace
```
|
