python.d/bind_rndc.chart.py

   1 # -*- coding: utf-8 -*-
   2 # Description: bind rndc netdata python.d module
   3 # Author: l2isbad
   4
   5 from base import SimpleService
   6 from re import compile, findall
   7 from os.path import getsize, split
   8 from os import access as is_accessible, R_OK
   9 from subprocess import Popen
  10
  11 priority = 60000
  12 retries = 60
  13 update_every = 30
  14
  15 NMS = ['requests', 'responses', 'success', 'auth_answer', 'nonauth_answer', 'nxrrset', 'failure',
  16        'nxdomain', 'recursion', 'duplicate', 'rejections']
  17 QUERIES = ['RESERVED0', 'A', 'NS', 'CNAME', 'SOA', 'PTR', 'MX', 'TXT', 'X25', 'AAAA', 'SRV', 'NAPTR',
  18            'A6', 'DS', 'RRSIG', 'DNSKEY', 'SPF', 'ANY', 'DLV']
  19
  20
  21 class Service(SimpleService):
  22     def __init__(self, configuration=None, name=None):
  23         SimpleService.__init__(self, configuration=configuration, name=name)
  24         self.named_stats_path = self.configuration.get('named_stats_path', '/var/log/bind/named.stats')
  25         self.regex_values = compile(r'([0-9]+) ([^\n]+)')
  26         # self.options = ['Incoming Requests', 'Incoming Queries', 'Outgoing Queries',
  27         # 'Name Server Statistics', 'Zone Maintenance Statistics', 'Resolver Statistics',
  28         # 'Cache DB RRsets', 'Socket I/O Statistics']
  29         self.options = ['Name Server Statistics', 'Incoming Queries', 'Outgoing Queries']
  30         self.regex_options = [r'(%s(?= \+\+)) \+\+([^\+]+)' % option for option in self.options]
  31         self.rndc = self.find_binary('rndc')
  32
  33     def check(self):
  34         # We cant start without 'rndc' command
  35         if not self.rndc:
  36             self.error('Can\'t locate \'rndc\' binary or binary is not executable by netdata')
  37             return False
  38
  39         # We cant start if stats file is not exist or not readable by netdata user
  40         if not is_accessible(self.named_stats_path, R_OK):
  41             self.error('Cannot access file %s' % self.named_stats_path)
  42             return False
  43
  44         size_before = getsize(self.named_stats_path)
  45         run_rndc = Popen([self.rndc, 'stats'], shell=False)
  46         run_rndc.wait()
  47         size_after = getsize(self.named_stats_path)
  48
  49         # We cant start if netdata user has no permissions to run 'rndc stats'
  50         if not run_rndc.returncode:
  51             # 'rndc' was found, stats file is exist and readable and we can run 'rndc stats'. Lets go!
  52             self.create_charts()
  53
  54             # BIND APPEND dump on every run 'rndc stats'
  55             # that is why stats file size can be VERY large if update_interval too small
  56             dump_size_24hr = round(86400 / self.update_every * (int(size_after) - int(size_before)) / 1048576, 3)
  57
  58             # If update_every too small we should WARN user
  59             if self.update_every < 30:
  60                 self.info('Update_every %s is NOT recommended for use. Increase the value to > 30' % self.update_every)
  61
  62             self.info('With current update_interval it will be + %s MB every 24hr. '
  63                       'Don\'t forget to create logrotate conf file for %s' % (dump_size_24hr, self.named_stats_path))
  64
  65             self.info('Plugin was started successfully.')
  66
  67             return True
  68         else:
  69             self.error('Not enough permissions to run "%s stats"' % self.rndc)
  70             return False
  71
  72     def _get_raw_data(self):
  73         """
  74         Run 'rndc stats' and read last dump from named.stats
  75         :return: tuple(
  76                        file.read() obj,
  77                        named.stats file size
  78                       )
  79         """
  80         try:
  81             current_size = getsize(self.named_stats_path)
  82         except OSError:
  83             return None, None
  84
  85         run_rndc = Popen([self.rndc, 'stats'], shell=False)
  86         run_rndc.wait()
  87
  88         if run_rndc.returncode:
  89             return None, None
  90
  91         try:
  92             with open(self.named_stats_path) as bind_rndc:
  93                 bind_rndc.seek(current_size)
  94                 result = bind_rndc.read()
  95         except OSError:
  96             return None, None
  97         else:
  98             return result, current_size
  99
 100     def _get_data(self):
 101         """
 102         Parse data from _get_raw_data()
 103         :return: dict
 104         """
 105
 106         raw_data, size = self._get_raw_data()
 107
 108         if raw_data is None:
 109             return None
 110
 111         rndc_stats = dict()
 112
 113         # Result: dict.
 114         # topic = Cache DB RRsets; body = A 178303 NS 86790 ... ; desc = A; value = 178303
 115         # {'Cache DB RRsets': [('A', 178303), ('NS', 286790), ...],
 116         # {Incoming Queries': [('RESERVED0', 8), ('A', 4557317680), ...],
 117         # ......
 118         for regex in self.regex_options:
 119             rndc_stats.update(dict([(topic, [(desc, int(value)) for value, desc in self.regex_values.findall(body)])
 120                                for topic, body in findall(regex, raw_data)]))
 121
 122         nms = dict(rndc_stats.get('Name Server Statistics', []))
 123
 124         inc_queries = dict([('i' + k, 0) for k in QUERIES])
 125         inc_queries.update(dict([('i' + k, v) for k, v in rndc_stats.get('Incoming Queries', [])]))
 126         out_queries = dict([('o' + k, 0) for k in QUERIES])
 127         out_queries.update(dict([('o' + k, v) for k, v in rndc_stats.get('Outgoing Queries', [])]))
 128
 129         to_netdata = dict()
 130         to_netdata['requests'] = sum([v for k, v in nms.items() if 'request' in k and 'received' in k])
 131         to_netdata['responses'] = sum([v for k, v in nms.items() if 'responses' in k and 'sent' in k])
 132         to_netdata['success'] = nms.get('queries resulted in successful answer', 0)
 133         to_netdata['auth_answer'] = nms.get('queries resulted in authoritative answer', 0)
 134         to_netdata['nonauth_answer'] = nms.get('queries resulted in non authoritative answer', 0)
 135         to_netdata['nxrrset'] = nms.get('queries resulted in nxrrset', 0)
 136         to_netdata['failure'] = sum([nms.get('queries resulted in SERVFAIL', 0), nms.get('other query failures', 0)])
 137         to_netdata['nxdomain'] = nms.get('queries resulted in NXDOMAIN', 0)
 138         to_netdata['recursion'] = nms.get('queries caused recursion', 0)
 139         to_netdata['duplicate'] = nms.get('duplicate queries received', 0)
 140         to_netdata['rejections'] = nms.get('recursive queries rejected', 0)
 141         to_netdata['stats_size'] = size
 142
 143         to_netdata.update(inc_queries)
 144         to_netdata.update(out_queries)
 145         return to_netdata
 146
 147     def create_charts(self):
 148         self.order = ['stats_size', 'bind_stats', 'incoming_q', 'outgoing_q']
 149         self.definitions = {
 150             'bind_stats': {
 151                 'options': [None, 'Name Server Statistics', 'stats', 'name server statistics', 'bind_rndc.stats', 'line'],
 152                 'lines': [
 153                          ]},
 154             'incoming_q': {
 155                 'options': [None, 'Incoming queries', 'queries','incoming queries', 'bind_rndc.incq', 'line'],
 156                 'lines': [
 157                         ]},
 158             'outgoing_q': {
 159                 'options': [None, 'Outgoing queries', 'queries','outgoing queries', 'bind_rndc.outq', 'line'],
 160                 'lines': [
 161                         ]},
 162             'stats_size': {
 163                 'options': [None, '%s file size' % split(self.named_stats_path)[1].capitalize(), 'megabytes',
 164                             '%s size' % split(self.named_stats_path)[1], 'bind_rndc.size', 'line'],
 165                 'lines': [
 166                          ["stats_size", None, "absolute", 1, 1048576]
 167                         ]}
 168                      }
 169         for elem in QUERIES:
 170             self.definitions['incoming_q']['lines'].append(['i' + elem, elem, 'incremental'])
 171             self.definitions['outgoing_q']['lines'].append(['o' + elem, elem, 'incremental'])
 172
 173         for elem in NMS:
 174             self.definitions['bind_stats']['lines'].append([elem, None, 'incremental'])