New upstream version 1.11.0+dfsgupstream/1.11.0+dfsg

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

4 files changed, 260 insertions, 0 deletions

diff --git a/collectors/python.d.plugin/nsd/Makefile.inc b/collectors/python.d.plugin/nsd/Makefile.inc
new file mode 100644
index 000000000..58e9fd67d
--- /dev/null
+++ b/collectors/python.d.plugin/nsd/Makefile.inc
@@ -0,0 +1,13 @@
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+# THIS IS NOT A COMPLETE Makefile
+# IT IS INCLUDED BY ITS PARENT'S Makefile.am
+# IT IS REQUIRED TO REFERENCE ALL FILES RELATIVE TO THE PARENT
+
+# install these files
+dist_python_DATA       += nsd/nsd.chart.py
+dist_pythonconfig_DATA += nsd/nsd.conf
+
+# do not install these files, but include them in the distribution
+dist_noinst_DATA       += nsd/README.md nsd/Makefile.inc
+
diff --git a/collectors/python.d.plugin/nsd/README.md b/collectors/python.d.plugin/nsd/README.md
new file mode 100644
index 000000000..02c302f41
--- /dev/null
+++ b/collectors/python.d.plugin/nsd/README.md
@@ -0,0 +1,54 @@
+# 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.
+
+---
diff --git a/collectors/python.d.plugin/nsd/nsd.chart.py b/collectors/python.d.plugin/nsd/nsd.chart.py
new file mode 100644
index 000000000..d713f46bd
--- /dev/null
+++ b/collectors/python.d.plugin/nsd/nsd.chart.py
@@ -0,0 +1,100 @@
+# -*- coding: utf-8 -*-
+# Description: NSD `nsd-control stats_noreset` netdata python.d module
+# Author: <383c57 at gmail.com>
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+import re
+
+from bases.FrameworkServices.ExecutableService import ExecutableService
+
+# 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
diff --git a/collectors/python.d.plugin/nsd/nsd.conf b/collectors/python.d.plugin/nsd/nsd.conf
new file mode 100644
index 000000000..078e97216
--- /dev/null
+++ b/collectors/python.d.plugin/nsd/nsd.conf
@@ -0,0 +1,93 @@
+# 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: 60
+
+# autodetection_retry sets the job re-check interval in seconds.
+# The job is not deleted if check fails.
+# Attempts to start the job are made once every autodetection_retry.
+# This feature is disabled by default.
+# autodetection_retry: 0
+
+# ----------------------------------------------------------------------
+# 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: 60             # the JOB's number of restoration attempts
+#     autodetection_retry: 0  # the JOB's re-check interval in seconds
+#
+# 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'