]> arthur.barton.de Git - netdata.git/commitdiff
Merge pull request #1902 from 383c57/nsd_plugin
authorCosta Tsaousis <costa@tsaousis.gr>
Thu, 9 Mar 2017 17:50:09 +0000 (19:50 +0200)
committerGitHub <noreply@github.com>
Thu, 9 Mar 2017 17:50:09 +0000 (19:50 +0200)
nsd plugin

conf.d/Makefile.am
conf.d/python.d/nsd.conf [new file with mode: 0644]
netdata-installer.sh
python.d/Makefile.am
python.d/README.md
python.d/nsd.chart.py [new file with mode: 0644]

index 47f6573c79632d36e7a10c530438db80ee5840f6..efe1f2a6e34d0af98c2153340d809b37f9859543 100644 (file)
@@ -43,6 +43,7 @@ dist_pythonconfig_DATA = \
     python.d/mongodb.conf \
     python.d/mysql.conf \
     python.d/nginx.conf \
+    python.d/nsd.conf \
     python.d/ovpn_status_log.conf \
     python.d/phpfpm.conf \
     python.d/postfix.conf \
diff --git a/conf.d/python.d/nsd.conf b/conf.d/python.d/nsd.conf
new file mode 100644 (file)
index 0000000..7566fe8
--- /dev/null
@@ -0,0 +1,86 @@
+# netdata python.d.plugin configuration for nsd
+#
+# This file is in YaML format. Generally the format is:
+#
+# name: value
+#
+# There are 2 sections:
+#  - global variables
+#  - one or more JOBS
+#
+# JOBS allow you to collect values from multiple sources.
+# Each source will have its own set of charts.
+#
+# JOB parameters have to be indented (using spaces only, example below).
+
+# ----------------------------------------------------------------------
+# Global Variables
+# These variables set the defaults for all JOBs, however each JOB
+# may define its own, overriding the defaults.
+
+# update_every sets the default data collection frequency.
+# If unset, the python.d.plugin default is used.
+# nsd-control is slow, so once every 30 seconds
+# update_every: 30
+
+# priority controls the order of charts at the netdata dashboard.
+# Lower numbers move the charts towards the top of the page.
+# If unset, the default for python.d.plugin is used.
+# priority: 60000
+
+# retries sets the number of retries to be made in case of failures.
+# If unset, the default for python.d.plugin is used.
+# Attempts to restore the service are made once every update_every
+# and only if the module has collected values in the past.
+# retries: 5
+
+# ----------------------------------------------------------------------
+# JOBS (data collection sources)
+#
+# The default JOBS share the same *name*. 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.
+#
+# Any number of jobs is supported.
+#
+# All python.d.plugin JOBS (for all its modules) support a set of
+# predefined parameters. These are:
+#
+# job_name:
+#     name: myname     # the JOB's name as it will appear at the
+#                      # dashboard (by default is the job_name)
+#                      # JOBs sharing a name are mutually exclusive
+#     update_every: 1  # the JOB's data collection frequency
+#     priority: 60000  # the JOB's order on the dashboard
+#     retries: 5       # the JOB's number of restoration attempts
+#
+# Additionally to the above, nsd also supports the following:
+#
+#     command: 'nsd-control stats_noreset' # the command to run
+#
+
+# ----------------------------------------------------------------------
+# IMPORTANT Information
+#
+# Netdata must have permissions to run `nsd-control stats_noreset` command
+#
+# - Example-1 (use "sudo")
+# 1. sudoers (e.g. visudo -f /etc/sudoers.d/netdata)
+#       Defaults:netdata   !requiretty
+#       netdata ALL=(ALL)  NOPASSWD: /usr/sbin/nsd-control stats_noreset
+# 2. etc/netdata/python.d/nsd.conf
+#       local:
+#         update_every: 30
+#         command: 'sudo /usr/sbin/nsd-control stats_noreset'
+#
+# - Example-2 (add "netdata" user to "nsd" group)
+# usermod -aG nsd netdata
+#
+
+# ----------------------------------------------------------------------
+# AUTO-DETECTION JOBS
+
+local:
+  update_every: 30
+  command: 'nsd-control stats_noreset'
index 9957e95b59003343f34947ef49b62f5a57cfbd85..ee2aded15f327ee36f0d1de1da5867f9d31f2927 100755 (executable)
@@ -577,6 +577,7 @@ NETDATA_ADDED_TO_NGINX=0
 NETDATA_ADDED_TO_VARNISH=0
 NETDATA_ADDED_TO_HAPROXY=0
 NETDATA_ADDED_TO_ADM=0
+NETDATA_ADDED_TO_NSD=0
 if [ ${UID} -eq 0 ]
     then
     portable_add_group netdata
@@ -586,6 +587,7 @@ if [ ${UID} -eq 0 ]
     portable_add_user_to_group varnish  netdata && NETDATA_ADDED_TO_VARNISH=1
     portable_add_user_to_group haproxy  netdata && NETDATA_ADDED_TO_HAPROXY=1
     portable_add_user_to_group adm      netdata && NETDATA_ADDED_TO_ADM=1
+    portable_add_user_to_group nsd      netdata && NETDATA_ADDED_TO_NSD=1
     run_ok
 else
     run_failed "The installer does not run as root."
@@ -1238,6 +1240,15 @@ if [ $? -eq 0 -a "${NETDATA_ADDED_TO_ADM}" = "1" ]
     echo "   gpasswd -d netdata adm"
 fi
 
+getent group nsd > /dev/null
+if [ $? -eq 0 -a "${NETDATA_ADDED_TO_NSD}" = "1" ]
+    then
+    echo
+    echo "You may also want to remove the netdata user from the nsd group"
+    echo "by running:"
+    echo "   gpasswd -d netdata nsd"
+fi
+
 
 UNINSTALL
 chmod 750 netdata-uninstaller.sh
index 588b924ae30a3c1c2343dd2b77bd1a98a162c170..bfe28ff2803bf5526cd09d3d8999fef55917e91b 100644 (file)
@@ -33,6 +33,7 @@ dist_python_DATA = \
     mongodb.chart.py \
     mysql.chart.py \
     nginx.chart.py \
+    nsd.chart.py \
     ovpn_status_log.chart.py \
     phpfpm.chart.py \
     postfix.chart.py \
index d21d2d83ecea730d71aca1e0798b68cf670b1d58..cee2078f2f0c0607dab5aa30e8efe3c0b75307da 100644 (file)
@@ -1017,6 +1017,61 @@ When no configuration file is found, module tries to parse `/var/log/nginx/acces
 
 ---
 
+# nsd
+
+Module uses the `nsd-control stats_noreset` command to provide `nsd` statistics.
+
+**Requirements:**
+ * Version of `nsd` must be 4.0+
+ * Netdata must have permissions to run `nsd-control stats_noreset`
+
+It produces:
+
+1. **Queries**
+ * queries
+
+2. **Zones**
+ * master
+ * slave
+
+3. **Protocol**
+ * udp
+ * udp6
+ * tcp
+ * tcp6
+
+4. **Query Type**
+ * A
+ * NS
+ * CNAME
+ * SOA
+ * PTR
+ * HINFO
+ * MX
+ * NAPTR
+ * TXT
+ * AAAA
+ * SRV
+ * ANY
+
+5. **Transfer**
+ * NOTIFY
+ * AXFR
+
+6. **Return Code**
+ * NOERROR
+ * FORMERR
+ * SERVFAIL
+ * NXDOMAIN
+ * NOTIMP
+ * REFUSED
+ * YXDOMAIN
+
+
+Configuration is not needed.
+
+---
+
 # ovpn_status_log
 
 Module monitor openvpn-status log file. 
diff --git a/python.d/nsd.chart.py b/python.d/nsd.chart.py
new file mode 100644 (file)
index 0000000..68bb4f2
--- /dev/null
@@ -0,0 +1,93 @@
+# -*- coding: utf-8 -*-
+# Description: NSD `nsd-control stats_noreset` netdata python.d module
+# Author: <383c57 at gmail.com>
+
+
+from base import ExecutableService
+import re
+
+# default module values (can be overridden per job in `config`)
+priority = 60000
+retries = 5
+update_every = 30
+
+# charts order (can be overridden if you want less charts, or different order)
+ORDER = ['queries', 'zones', 'protocol', 'type', 'transfer', 'rcode']
+
+CHARTS = {
+    'queries': {
+        'options': [
+            None, "queries", 'queries/s', 'queries', 'nsd.queries', 'line'],
+        'lines': [
+            ['num_queries', 'queries', 'incremental'],]},
+    'zones': {
+        'options': [
+            None, "zones", 'zones', 'zones', 'nsd.zones', 'stacked'],
+        'lines': [
+            ['zone_master', 'master', 'absolute'],
+            ['zone_slave', 'slave', 'absolute'],]},
+    'protocol': {
+        'options': [
+            None, "protocol", 'queries/s', 'protocol', 'nsd.protocols', 'stacked'],
+        'lines': [
+            ['num_udp', 'udp', 'incremental'],
+            ['num_udp6', 'udp6', 'incremental'],
+            ['num_tcp', 'tcp', 'incremental'],
+            ['num_tcp6', 'tcp6', 'incremental'],]},
+    'type': {
+        'options': [
+            None, "query type", 'queries/s', 'query type', 'nsd.type', 'stacked'],
+        'lines': [
+            ['num_type_A', 'A', 'incremental'],
+            ['num_type_NS', 'NS', 'incremental'],
+            ['num_type_CNAME', 'CNAME', 'incremental'],
+            ['num_type_SOA', 'SOA', 'incremental'],
+            ['num_type_PTR', 'PTR', 'incremental'],
+            ['num_type_HINFO', 'HINFO', 'incremental'],
+            ['num_type_MX', 'MX', 'incremental'],
+            ['num_type_NAPTR', 'NAPTR', 'incremental'],
+            ['num_type_TXT', 'TXT', 'incremental'],
+            ['num_type_AAAA', 'AAAA', 'incremental'],
+            ['num_type_SRV', 'SRV', 'incremental'],
+            ['num_type_TYPE255', 'ANY', 'incremental'],]},
+    'transfer': {
+        'options': [
+            None, "transfer", 'queries/s', 'transfer', 'nsd.transfer', 'stacked'],
+        'lines': [
+            ['num_opcode_NOTIFY', 'NOTIFY', 'incremental'],
+            ['num_type_TYPE252', 'AXFR', 'incremental'],]},
+    'rcode': {
+        'options': [
+            None, "return code", 'queries/s', 'return code', 'nsd.rcode', 'stacked'],
+        'lines': [
+            ['num_rcode_NOERROR', 'NOERROR', 'incremental'],
+            ['num_rcode_FORMERR', 'FORMERR', 'incremental'],
+            ['num_rcode_SERVFAIL', 'SERVFAIL', 'incremental'],
+            ['num_rcode_NXDOMAIN', 'NXDOMAIN', 'incremental'],
+            ['num_rcode_NOTIMP', 'NOTIMP', 'incremental'],
+            ['num_rcode_REFUSED', 'REFUSED', 'incremental'],
+            ['num_rcode_YXDOMAIN', 'YXDOMAIN', 'incremental'],]}
+}
+
+
+class Service(ExecutableService):
+    def __init__(self, configuration=None, name=None):
+        ExecutableService.__init__(
+            self, configuration=configuration, name=name)
+        self.command = "nsd-control stats_noreset"
+        self.order = ORDER
+        self.definitions = CHARTS
+        self.regex = re.compile(r'([A-Za-z0-9.]+)=(\d+)')
+
+    def _get_data(self):
+        lines = self._get_raw_data()
+        if not lines:
+            return None
+
+        r = self.regex
+        stats = dict((k.replace('.', '_'), int(v))
+                     for k, v in r.findall(''.join(lines)))
+        stats.setdefault('num_opcode_NOTIFY', 0)
+        stats.setdefault('num_type_TYPE252', 0)
+        stats.setdefault('num_type_TYPE255', 0)
+        return stats