python.d/isc_dhcpd.chart.py

   1 # -*- coding: utf-8 -*-
   2 # Description: isc dhcpd lease netdata python.d module
   3 # Author: l2isbad
   4
   5 from base import SimpleService
   6 from time import mktime, strptime, gmtime, time
   7 from os import stat
   8 try:
   9     from ipaddress import IPv4Address as ipaddress
  10     from ipaddress import ip_network
  11     have_ipaddress = True
  12 except ImportError:
  13     have_ipaddress = False
  14 try:
  15     from itertools import filterfalse as filterfalse
  16 except ImportError:
  17     from itertools import ifilterfalse as filterfalse
  18
  19
  20 priority = 60000
  21 retries = 60
  22 update_every = 60
  23
  24 class Service(SimpleService):
  25     def __init__(self, configuration=None, name=None):
  26         SimpleService.__init__(self, configuration=configuration, name=name)
  27         self.leases_path = self.configuration.get('leases_path', '/var/lib/dhcp/dhcpd.leases')
  28         self.pools = self.configuration.get('pools')
  29
  30         # Will work only with 'default' db-time-format (weekday year/month/day hour:minute:second)
  31         # TODO: update algorithm to parse correctly 'local' db-time-format
  32         # (epoch <seconds-since-epoch>; # <day-name> <month-name> <day-number> <hours>:<minutes>:<seconds> <year>)
  33         # TODO: use threading to iter through file
  34         # Also only ipv4 supported
  35
  36     def check(self):
  37         if not self._get_raw_data():
  38             self.error('Make sure leases_path is correct and leases log file is readable by netdata')
  39             return False
  40         elif not have_ipaddress:
  41             self.error('No ipaddress module. Please install (py2-ipaddress in case of python2)')
  42             return False
  43         else:
  44             try:
  45                 self.pools = self.pools.split()
  46                 if not [ip_network(pool) for pool in self.pools]:
  47                     self.error('Pools list is empty')
  48                     return False
  49             except (ValueError, IndexError, AttributeError, SyntaxError):
  50                 self.error('Pools configurations is incorrect')
  51                 return False
  52
  53             # Creating dynamic charts
  54             self.order = ['parse_time', 'leases_size', 'utilization']
  55             self.definitions = {'utilization':
  56                                     {'options':
  57                                          [None, 'Pools utilization', 'used %', 'Utulization', 'isc_dhcpd.util', 'line'],
  58                                      'lines': []},
  59                                'parse_time':
  60                                    {'options':
  61                                         [None, 'Parse time', 'ms', 'Parse statistics', 'isc_dhcpd.parse', 'line'],
  62                                     'lines': [['ptime', 'time', 'absolute']]},
  63                                'leases_size':
  64                                    {'options':
  65                                         [None, 'dhcpd.leases file size', 'kilobytes', 'Parse statistics', 'isc_dhcpd.lsize', 'line'],
  66                                     'lines': [['lsize', 'size', 'absolute']]}}
  67             for pool in self.pools:
  68                 self.definitions['utilization']['lines'].append([''.join(['ut_', pool]), pool, 'absolute'])
  69                 self.order.append(''.join(['leases_', pool]))
  70                 self.definitions[''.join(['leases_', pool])] = \
  71                     {'options': [None, 'Active leases', 'leases', 'Leases', 'isc_dhcpd.lease', 'area'],
  72                      'lines': [[''.join(['le_', pool]), pool, 'absolute']]}
  73
  74             self.info('Plugin was started succesfully')
  75             return True
  76
  77     def _get_raw_data(self):
  78         """
  79         Parses log file
  80         :return: tuple(
  81                        [ipaddress, lease end time, ...],
  82                        time to parse leases file
  83                       )
  84         """
  85         try:
  86             with open(self.leases_path, 'rt') as dhcp_leases:
  87                 time_start = time()
  88                 part1 = filterfalse(find_lease, dhcp_leases)
  89                 part2 = filterfalse(find_ends, dhcp_leases)
  90                 raw_result = dict(zip(part1, part2))
  91                 time_end = time()
  92
  93                 file_parse_time = round((time_end - time_start) * 1000)
  94
  95         except Exception:
  96             return None
  97
  98         else:
  99             result = (raw_result, file_parse_time)
 100             return result
 101
 102     def _get_data(self):
 103         """
 104         :return: dict
 105         """
 106         raw_leases = self._get_raw_data()
 107
 108         if not raw_leases:
 109             return None
 110
 111         # Result: {ipaddress: end lease time, ...}
 112         all_leases = {k[6:len(k)-3]:v[7:len(v)-2] for k, v in raw_leases[0].items()}
 113
 114         # Result: [active binding, active binding....]. (Expire time (ends date;) - current time > 0)
 115         active_leases = [k for k, v in all_leases.items() if is_bind_active(all_leases[k])]
 116
 117         # Result: {pool: number of active bindings in pool, ...}
 118         pools_count = {pool: len([lease for lease in active_leases if is_address_in(lease, pool)])
 119                        for pool in self.pools}
 120
 121         # Result: {pool: number of host ip addresses in pool, ...}
 122         pools_max = {pool: (2 ** (32 - int(pool.split('/')[1])) - 2)
 123                      for pool in self.pools}
 124
 125         # Result: {pool: % utilization, ....} (percent)
 126         pools_util = {pool:int(round(float(pools_count[pool]) / pools_max[pool] * 100, 0))
 127                       for pool in self.pools}
 128
 129         # Bulding dicts to send to netdata
 130         final_count = {''.join(['le_', k]): v for k, v in pools_count.items()}
 131         final_util = {''.join(['ut_', k]): v for k, v in pools_util.items()}
 132
 133         to_netdata = {'lsize': int(stat(self.leases_path)[6] / 1024)}
 134         to_netdata.update({'ptime': int(raw_leases[1])})
 135         to_netdata.update(final_util)
 136         to_netdata.update(final_count)
 137
 138         return to_netdata
 139
 140
 141 def is_bind_active(binding):
 142     return mktime(strptime(binding, '%w %Y/%m/%d %H:%M:%S')) - mktime(gmtime()) > 0
 143
 144
 145 def is_address_in(address, pool):
 146     return ipaddress(address) in ip_network(pool)
 147
 148
 149 def find_lease(value):
 150     return value[0:3] != 'lea'
 151
 152
 153 def find_ends(value):
 154     return value[2:6] != 'ends'