Plugin: python.d.plugin Module: nsd
This collector monitors NSD statistics like queries, zones, protocols, query types and more.
It uses the nsd-control stats_noreset
command to gather metrics.
This collector is supported on all platforms.
This collector only supports collecting metrics from a single instance of this integration.
If permissions are satisfied, the collector will be able to run nsd-control stats_noreset
, thus collecting metrics.
The default configuration for this integration does not impose any limits on data collection.
The default configuration for this integration is not expected to impose a significant performance impact on the system.
The version of nsd
must be 4.0+.
Netdata must have permissions to run the nsd-control stats_noreset
command.
You can:
Add “netdata” user to “nsd” group:
usermod -aG nsd netdata
Add Netdata to sudoers
visudo -f /etc/sudoers.d/netdata
Defaults:netdata !requiretty
netdata ALL=(ALL) NOPASSWD: /usr/sbin/nsd-control stats_noreset
Note that you will need to set the
command
option tosudo /usr/sbin/nsd-control stats_noreset
if you use this method.
The configuration file name for this integration is python.d/nsd.conf
.
You can edit the configuration file using the edit-config
script from the
Netdata config directory.
cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config python.d/nsd.conf
This particular collector does not need further configuration to work if permissions are satisfied, but you can always customize it’s data collection behavior.
There are 2 sections:
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.
Name | Description | Default | Required |
---|---|---|---|
update_every | Sets the default data collection frequency. | 30 | 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 | |
command | The command to run | nsd-control stats_noreset | no |
A basic configuration example.
local:
name: 'nsd_local'
command: 'nsd-control stats_noreset'
Metrics grouped by scope.
The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
These metrics refer to the entire monitored application.
This scope has no labels.
Metrics:
Metric | Dimensions | Unit |
---|---|---|
nsd.queries | queries | queries/s |
nsd.zones | master, slave | zones |
nsd.protocols | udp, udp6, tcp, tcp6 | queries/s |
nsd.type | A, NS, CNAME, SOA, PTR, HINFO, MX, NAPTR, TXT, AAAA, SRV, ANY | queries/s |
nsd.transfer | NOTIFY, AXFR | queries/s |
nsd.rcode | NOERROR, FORMERR, SERVFAIL, NXDOMAIN, NOTIMP, REFUSED, YXDOMAIN | queries/s |
There are no alerts configured by default for this integration.
To troubleshoot issues with the nsd
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]
.
cd /usr/libexec/netdata/plugins.d/
Switch to the netdata
user.
sudo -u netdata -s
Run the python.d.plugin
to debug the collector:
./python.d.plugin nsd debug trace
If you’re encountering problems with the nsd
collector, follow these steps to retrieve logs and identify potential issues:
Use the following command to view logs generated since the last Netdata service restart:
journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep nsd
Locate the collector log file, typically at /var/log/netdata/collector.log
, and use grep
to filter for collector’s name:
grep nsd /var/log/netdata/collector.log
Note: This method shows logs from all restarts. Focus on the latest entries for troubleshooting current issues.
If your Netdata runs in a Docker container named “netdata” (replace if different), use this command:
docker logs netdata 2>&1 | grep nsd