Adding upstream version 1.12.0.upstream/1.12.0upstream

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

4 files changed, 439 insertions, 0 deletions

diff --git a/collectors/python.d.plugin/bind_rndc/Makefile.inc b/collectors/python.d.plugin/bind_rndc/Makefile.inc
new file mode 100644
index 0000000..72f3914
--- /dev/null
+++ b/collectors/python.d.plugin/bind_rndc/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       += bind_rndc/bind_rndc.chart.py
+dist_pythonconfig_DATA += bind_rndc/bind_rndc.conf
+
+# do not install these files, but include them in the distribution
+dist_noinst_DATA       += bind_rndc/README.md bind_rndc/Makefile.inc
+
diff --git a/collectors/python.d.plugin/bind_rndc/README.md b/collectors/python.d.plugin/bind_rndc/README.md
new file mode 100644
index 0000000..fefe749
--- /dev/null
+++ b/collectors/python.d.plugin/bind_rndc/README.md
@@ -0,0 +1,62 @@
+# bind_rndc
+
+Module parses bind dump file to collect real-time performance metrics
+
+**Requirements:**
+ * Version of bind must be 9.6 +
+ * Netdata must have permissions to run `rndc stats`
+
+It produces:
+
+1. **Name server statistics**
+ * requests
+ * responses
+ * success
+ * auth_answer
+ * nonauth_answer
+ * nxrrset
+ * failure
+ * nxdomain
+ * recursion
+ * duplicate
+ * rejections
+
+2. **Incoming queries**
+ * RESERVED0
+ * A
+ * NS
+ * CNAME
+ * SOA
+ * PTR
+ * MX
+ * TXT
+ * X25
+ * AAAA
+ * SRV
+ * NAPTR
+ * A6
+ * DS
+ * RSIG
+ * DNSKEY
+ * SPF
+ * ANY
+ * DLV
+
+3. **Outgoing queries**
+ * Same as Incoming queries
+
+
+### configuration
+
+Sample:
+
+```yaml
+local:
+  named_stats_path       : '/var/log/bind/named.stats'
+```
+
+If no configuration is given, module will attempt to read named.stats file  at `/var/log/bind/named.stats`
+
+---
+
+[![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Fcollectors%2Fpython.d.plugin%2Fbind_rndc%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)]()
diff --git a/collectors/python.d.plugin/bind_rndc/bind_rndc.chart.py b/collectors/python.d.plugin/bind_rndc/bind_rndc.chart.py
new file mode 100644
index 0000000..7ac1bc3
--- /dev/null
+++ b/collectors/python.d.plugin/bind_rndc/bind_rndc.chart.py
@@ -0,0 +1,254 @@
+# -*- coding: utf-8 -*-
+# Description: bind rndc netdata python.d module
+# Author: l2isbad
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+import os
+
+from collections import defaultdict
+from subprocess import Popen
+
+from bases.collection import find_binary
+from bases.FrameworkServices.SimpleService import SimpleService
+
+
+update_every = 30
+
+ORDER = [
+    'name_server_statistics',
+    'incoming_queries',
+    'outgoing_queries',
+    'named_stats_size',
+]
+
+CHARTS = {
+    'name_server_statistics': {
+        'options': [None, 'Name Server Statistics', 'stats', 'name server statistics',
+                    'bind_rndc.name_server_statistics', 'line'],
+        'lines': [
+            ['nms_requests', 'requests', 'incremental'],
+            ['nms_rejected_queries', 'rejected_queries', 'incremental'],
+            ['nms_success', 'success', 'incremental'],
+            ['nms_failure', 'failure', 'incremental'],
+            ['nms_responses', 'responses', 'incremental'],
+            ['nms_duplicate', 'duplicate', 'incremental'],
+            ['nms_recursion', 'recursion', 'incremental'],
+            ['nms_nxrrset', 'nxrrset', 'incremental'],
+            ['nms_nxdomain', 'nxdomain', 'incremental'],
+            ['nms_non_auth_answer', 'non_auth_answer', 'incremental'],
+            ['nms_auth_answer', 'auth_answer', 'incremental'],
+            ['nms_dropped_queries', 'dropped_queries', 'incremental'],
+        ]},
+    'incoming_queries': {
+        'options': [None, 'Incoming Queries', 'queries', 'incoming queries', 'bind_rndc.incoming_queries', 'line'],
+        'lines': [
+        ]},
+    'outgoing_queries': {
+        'options': [None, 'Outgoing Queries', 'queries', 'outgoing queries', 'bind_rndc.outgoing_queries', 'line'],
+        'lines': [
+        ]},
+    'named_stats_size': {
+        'options': [None, 'Named Stats File Size', 'MiB', 'file size', 'bind_rndc.stats_size', 'line'],
+        'lines': [
+            ['stats_size', None, 'absolute', 1, 1 << 20]
+        ]
+    }
+}
+
+NMS = {
+    'nms_requests': [
+        'IPv4 requests received',
+        'IPv6 requests received',
+        'TCP requests received',
+        'requests with EDNS(0) receive'
+    ],
+    'nms_responses': [
+        'responses sent',
+        'truncated responses sent',
+        'responses with EDNS(0) sent',
+        'requests with unsupported EDNS version received'
+    ],
+    'nms_failure': [
+        'other query failures',
+        'queries resulted in SERVFAIL'
+    ],
+    'nms_auth_answer': ['queries resulted in authoritative answer'],
+    'nms_non_auth_answer': ['queries resulted in non authoritative answer'],
+    'nms_nxrrset': ['queries resulted in nxrrset'],
+    'nms_success': ['queries resulted in successful answer'],
+    'nms_nxdomain': ['queries resulted in NXDOMAIN'],
+    'nms_recursion': ['queries caused recursion'],
+    'nms_duplicate': ['duplicate queries received'],
+    'nms_rejected_queries': [
+        'auth queries rejected',
+        'recursive queries rejected'
+    ],
+    'nms_dropped_queries': ['queries dropped']
+}
+
+STATS = ['Name Server Statistics', 'Incoming Queries', 'Outgoing Queries']
+
+
+class Service(SimpleService):
+    def __init__(self, configuration=None, name=None):
+        SimpleService.__init__(self, configuration=configuration, name=name)
+        self.order = ORDER
+        self.definitions = CHARTS
+        self.named_stats_path = self.configuration.get('named_stats_path', '/var/log/bind/named.stats')
+        self.rndc = find_binary('rndc')
+        self.data = dict(
+            nms_requests=0,
+            nms_responses=0,
+            nms_failure=0,
+            nms_auth=0,
+            nms_non_auth=0,
+            nms_nxrrset=0,
+            nms_success=0,
+            nms_nxdomain=0,
+            nms_recursion=0,
+            nms_duplicate=0,
+            nms_rejected_queries=0,
+            nms_dropped_queries=0,
+        )
+
+    def check(self):
+        if not self.rndc:
+            self.error('Can\'t locate "rndc" binary or binary is not executable by netdata')
+            return False
+
+        if not (os.path.isfile(self.named_stats_path) and os.access(self.named_stats_path, os.R_OK)):
+            self.error('Cannot access file %s' % self.named_stats_path)
+            return False
+
+        run_rndc = Popen([self.rndc, 'stats'], shell=False)
+        run_rndc.wait()
+
+        if not run_rndc.returncode:
+            return True
+        self.error('Not enough permissions to run "%s stats"' % self.rndc)
+        return False
+
+    def _get_raw_data(self):
+        """
+        Run 'rndc stats' and read last dump from named.stats
+        :return: dict
+        """
+        result = dict()
+        try:
+            current_size = os.path.getsize(self.named_stats_path)
+            run_rndc = Popen([self.rndc, 'stats'], shell=False)
+            run_rndc.wait()
+
+            if run_rndc.returncode:
+                return None
+            with open(self.named_stats_path) as named_stats:
+                named_stats.seek(current_size)
+                result['stats'] = named_stats.readlines()
+                result['size'] = current_size
+                return result
+        except (OSError, IOError):
+            return None
+
+    def _get_data(self):
+        """
+        Parse data from _get_raw_data()
+        :return: dict
+        """
+
+        raw_data = self._get_raw_data()
+
+        if raw_data is None:
+            return None
+        parsed = dict()
+        for stat in STATS:
+            parsed[stat] = parse_stats(field=stat,
+                                       named_stats=raw_data['stats'])
+
+        self.data.update(nms_mapper(data=parsed['Name Server Statistics']))
+
+        for elem in zip(['Incoming Queries', 'Outgoing Queries'], ['incoming_queries', 'outgoing_queries']):
+            parsed_key, chart_name = elem[0], elem[1]
+            for dimension_id, value in queries_mapper(data=parsed[parsed_key],
+                                                      add=chart_name[:9]).items():
+
+                if dimension_id not in self.data:
+                    dimension = dimension_id.replace(chart_name[:9], '')
+                    if dimension_id not in self.charts[chart_name]:
+                        self.charts[chart_name].add_dimension([dimension_id, dimension, 'incremental'])
+
+                self.data[dimension_id] = value
+
+        self.data['stats_size'] = raw_data['size']
+        return self.data
+
+
+def parse_stats(field, named_stats):
+    """
+    :param field: str:
+    :param named_stats: list:
+    :return: dict
+
+    Example:
+    filed: 'Incoming Queries'
+    names_stats (list of lines):
+    ++ Incoming Requests ++
+             1405660 QUERY
+                   3 NOTIFY
+    ++ Incoming Queries ++
+             1214961 A
+                  75 NS
+                   2 CNAME
+                2897 SOA
+               35544 PTR
+                  14 MX
+                5822 TXT
+              145974 AAAA
+                 371 SRV
+    ++ Outgoing Queries ++
+    ...
+
+    result:
+    {'A', 1214961, 'NS': 75, 'CNAME': 2, 'SOA': 2897, ...}
+    """
+    data = dict()
+    ns = iter(named_stats)
+    for line in ns:
+        if field not in line:
+            continue
+        while True:
+            try:
+                line = next(ns)
+            except StopIteration:
+                break
+            if '++' not in line:
+                if '[' in line:
+                    continue
+                v, k = line.strip().split(' ', 1)
+                if k not in data:
+                    data[k] = 0
+                data[k] += int(v)
+                continue
+            break
+        break
+    return data
+
+
+def nms_mapper(data):
+    """
+    :param data: dict
+    :return: dict(defaultdict)
+    """
+    result = defaultdict(int)
+    for k, v in NMS.items():
+        for elem in v:
+            result[k] += data.get(elem, 0)
+    return result
+
+
+def queries_mapper(data, add):
+    """
+    :param data: dict
+    :param add: str
+    :return: dict
+    """
+    return dict([(add + k, v) for k, v in data.items()])
diff --git a/collectors/python.d.plugin/bind_rndc/bind_rndc.conf b/collectors/python.d.plugin/bind_rndc/bind_rndc.conf
new file mode 100644
index 0000000..3b7e9a2
--- /dev/null
+++ b/collectors/python.d.plugin/bind_rndc/bind_rndc.conf
@@ -0,0 +1,110 @@
+# netdata python.d.plugin configuration for bind_rndc
+#
+# 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.
+# update_every: 1
+
+# 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
+
+# penalty indicates whether to apply penalty to update_every in case of failures.
+# Penalty will increase every 5 failed updates in a row. Maximum penalty is 10 minutes.
+# penalty: yes
+
+# 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
+#     penalty: yes            # the JOB's penalty
+#     autodetection_retry: 0  # the JOB's re-check interval in seconds
+#
+# Additionally to the above, bind_rndc also supports the following:
+#
+#     named_stats_path: 'path to named.stats'		# Default: '/var/log/bind/named.stats'
+#------------------------------------------------------------------------------------------------------------------
+# IMPORTANT Information
+#
+# BIND APPEND logs at EVERY RUN. Its NOT RECOMMENDED to set update_every below 30 sec.
+# STRONGLY RECOMMENDED to create a bind-rndc conf file for logrotate
+#
+# To set up your 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
+#
+# The last BUT NOT least is to create bind-rndc.conf in logrotate.d/
+# The working one
+#  /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)
+#
+# ----------------------------------------------------------------------