1 # -*- coding: utf-8 -*-
2 # Description: isc dhcpd lease netdata python.d module
5 from base import SimpleService
6 from time import mktime, strptime, gmtime, time
9 from ipaddress import IPv4Address as ipaddress
10 from ipaddress import ip_network
13 have_ipaddress = False
15 from itertools import filterfalse as filterfalse
17 from itertools import ifilterfalse as filterfalse
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')
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 # Also only ipv4 supported
36 if not self._get_raw_data():
37 self.error('Make sure leases_path is correct and leases log file is readable by netdata')
39 elif not have_ipaddress:
40 self.error('No ipaddress module. Please install (py2-ipaddress in case of python2)')
44 self.pools = self.pools.split()
45 if not [ip_network(return_utf(pool)) for pool in self.pools]:
46 self.error('Pools list is empty')
48 except (ValueError, IndexError, AttributeError, SyntaxError) as e:
49 self.error('Pools configurations is incorrect', str(e))
52 # Creating static charts
53 self.order = ['parse_time', 'leases_size', 'utilization', 'total']
54 self.definitions = {'utilization':
56 [None, 'Pools utilization', 'used %', 'Utilization', 'isc_dhcpd.util', 'line'],
60 [None, 'Total all pools', 'leases', 'Utilization', 'isc_dhcpd.total', 'line'],
61 'lines': [['total', 'leases', 'absolute']]},
64 [None, 'Parse time', 'ms', 'Parse stats', 'isc_dhcpd.parse', 'line'],
65 'lines': [['ptime', 'time', 'absolute']]},
68 [None, 'dhcpd.leases file size', 'kilobytes', 'Parse stats', 'isc_dhcpd.lsize', 'line'],
69 'lines': [['lsize', 'size', 'absolute']]}}
70 # Creating dynamic charts
71 for pool in self.pools:
72 self.definitions['utilization']['lines'].append([''.join(['ut_', pool]), pool, 'absolute'])
73 self.order.append(''.join(['leases_', pool]))
74 self.definitions[''.join(['leases_', pool])] = \
75 {'options': [None, 'Active leases', 'leases', 'Pools', 'isc_dhcpd.lease', 'area'],
76 'lines': [[''.join(['le_', pool]), pool, 'absolute']]}
78 self.info('Plugin was started succesfully')
81 def _get_raw_data(self):
85 [ipaddress, lease end time, ...],
86 time to parse leases file
90 with open(self.leases_path, 'rt') as dhcp_leases:
92 part1 = filterfalse(find_lease, dhcp_leases)
93 part2 = filterfalse(find_ends, dhcp_leases)
94 raw_result = dict(zip(part1, part2))
97 file_parse_time = round((time_end - time_start) * 1000)
99 except Exception as e:
100 self.error("Failed to parse leases file:", str(e))
104 result = (raw_result, file_parse_time)
111 raw_leases = self._get_raw_data()
116 # Result: {ipaddress: end lease time, ...}
117 all_leases = {k[6:len(k)-3]:v[7:len(v)-2] for k, v in raw_leases[0].items()}
119 # Result: [active binding, active binding....]. (Expire time (ends date;) - current time > 0)
120 active_leases = [k for k, v in all_leases.items() if is_binding_active(all_leases[k])]
122 # Result: {pool: number of active bindings in pool, ...}
123 pools_count = {pool: len([lease for lease in active_leases if is_address_in(lease, pool)])
124 for pool in self.pools}
126 # Result: {pool: number of host ip addresses in pool, ...}
127 pools_max = {pool: (2 ** (32 - int(pool.split('/')[1])) - 2)
128 for pool in self.pools}
130 # Result: {pool: % utilization, ....} (percent)
131 pools_util = {pool:int(round(float(pools_count[pool]) / pools_max[pool] * 100, 0))
132 for pool in self.pools}
134 # Bulding dicts to send to netdata
135 final_count = {''.join(['le_', k]): v for k, v in pools_count.items()}
136 final_util = {''.join(['ut_', k]): v for k, v in pools_util.items()}
138 to_netdata = {'total': len(active_leases)}
139 to_netdata.update({'lsize': int(stat(self.leases_path)[6] / 1024)})
140 to_netdata.update({'ptime': int(raw_leases[1])})
141 to_netdata.update(final_util)
142 to_netdata.update(final_count)
147 def is_binding_active(binding):
148 return mktime(strptime(binding, '%w %Y/%m/%d %H:%M:%S')) - mktime(gmtime()) > 0
151 def is_address_in(address, pool):
152 return ipaddress(return_utf(address)) in ip_network(return_utf(pool))
155 def find_lease(value):
156 return value[0:3] != 'lea'
159 def find_ends(value):
160 return value[2:6] != 'ends'
163 # python2 returns "<type 'str'>" for simple strings
164 # python3 returns "<class 'str'>" for unicode strings
165 if str(type(s)) == "<type 'str'>":
166 return unicode(s, 'utf-8')