isc_dhcpd: new pools format and module conf file update
Ilya committed
Jun 9, 2017 at 18:20 UTC
bfe6ce2fd14a89e96ed3adbe14b3002500d5859b
2 files changed
+100
-101
conf.d/python.d/isc_dhcpd.conf
+8
-3
@@ -56,8 +56,11 @@
56
#
57
# Additionally to the above, isc_dhcpd supports the following:
58
#
59
-# leases_path: 'PATH' # the path to dhcpd.leases file
60
-# pools: 'dhcpd pools list' # Pools in CIDR format
59
+# leases_path: 'PATH' # the path to dhcpd.leases file
60
+# pools:
61
+# office: '192.168.2.0/24' # name(dimension): pool in CIDR format
62
+# wifi: '192.168.3.0/24' # name(dimension): pool in CIDR format
63
+# 192.168.4.0/24: '192.168.4.0/24' # name(dimension): pool in CIDR format
64
#
65
#-----------------------------------------------------------------------
66
# IMPORTANT notes
@@ -75,4 +78,6 @@
78
#
79
#leases:
80
# leases_path : '/var/lib/dhcp/dhcpd.leases'
78
-# pools : '192.168.3.0/24 192.168.4.0/24 192.168.5.0/24'
81
+# pools:
82
+# office: '192.168.2.0/24'
83
+# wifi: '192.168.3.0/24'
python.d/isc_dhcpd.chart.py
+92
-98
@@ -2,30 +2,56 @@
2
# Description: isc dhcpd lease netdata python.d module
3
# Author: l2isbad
4
5
-from base import SimpleService
5
from time import mktime, strptime, gmtime, time
7
-from os import stat
6
+from os import stat, access, R_OK
7
+from os.path import isfile
8
try:
9
- from ipaddress import IPv4Address as ipaddress
10
- from ipaddress import ip_network
9
+ from ipaddress import ip_network, ip_address
10
have_ipaddress = True
11
except ImportError:
12
have_ipaddress = False
13
try:
15
- from itertools import filterfalse as filterfalse
14
+ from itertools import filterfalse
15
except ImportError:
16
from itertools import ifilterfalse as filterfalse
18
-
17
+from base import SimpleService
18
19
priority = 60000
20
retries = 60
22
-update_every = 60
21
+update_every = 5
22
+
23
+ORDER = ['pools_utilization', 'pools_active_leases', 'leases_total', 'parse_time', 'leases_size']
24
+
25
+CHARTS = {
26
+ 'pools_utilization': {
27
+ 'options': [None, 'Pools Utilization', 'used in percent', 'utilization',
28
+ 'isc_dhcpd.utilization', 'line'],
29
+ 'lines': []},
30
+ 'pools_active_leases': {
31
+ 'options': [None, 'Active Leases', 'leases per pool', 'active leases',
32
+ 'isc_dhcpd.active_leases', 'line'],
33
+ 'lines': []},
34
+ 'leases_total': {
35
+ 'options': [None, 'Total All Pools', 'number', 'active leases',
36
+ 'isc_dhcpd.leases_total', 'line'],
37
+ 'lines': [['leases_total', 'leases', 'absolute']]},
38
+ 'parse_time': {
39
+ 'options': [None, 'Parse Time', 'ms', 'parse stats',
40
+ 'isc_dhcpd.parse_time', 'line'],
41
+ 'lines': [['parse_time', 'time', 'absolute']]},
42
+ 'leases_size': {
43
+ 'options': [None, 'Dhcpd Leases File Size', 'kilobytes',
44
+ 'parse stats', 'isc_dhcpd.leases_size', 'line'],
45
+ 'lines': [['leases_size', 'size', 'absolute', 1, 1024]]}}
46
+
47
48
class Service(SimpleService):
49
def __init__(self, configuration=None, name=None):
50
SimpleService.__init__(self, configuration=configuration, name=name)
51
self.leases_path = self.configuration.get('leases_path', '/var/lib/dhcp/dhcpd.leases')
28
- self.pools = self.configuration.get('pools')
52
+ self.order = ORDER
53
+ self.definitions = CHARTS
54
+ self.pools = dict()
55
56
# Will work only with 'default' db-time-format (weekday year/month/day hour:minute:second)
57
# TODO: update algorithm to parse correctly 'local' db-time-format
@@ -33,50 +59,30 @@ class Service(SimpleService):
59
# Also only ipv4 supported
60
61
def check(self):
36
- if not self._get_raw_data():
62
+ if not have_ipaddress:
63
+ self.error('\'python-ipaddress\' module is needed')
64
+ return False
65
+ if not (isfile(self.leases_path) and access(self.leases_path, R_OK)):
66
self.error('Make sure leases_path is correct and leases log file is readable by netdata')
67
return False
39
- elif not have_ipaddress:
40
- self.error('No ipaddress module. Please install (py2-ipaddress in case of python2)')
68
+ if not self.configuration.get('pools'):
69
+ self.error('Pools are not defined')
70
return False
42
- else:
71
+ if not isinstance(self.configuration['pools'], dict):
72
+ self.error('Invalid \'pools\' format')
73
+ return False
74
+
75
+ for pool in self.configuration['pools']:
76
try:
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')
47
- return False
48
- except (ValueError, IndexError, AttributeError, SyntaxError) as e:
49
- self.error('Pools configurations is incorrect', str(e))
50
- return False
51
-
52
- # Creating static charts
53
- self.order = ['parse_time', 'leases_size', 'utilization', 'total']
54
- self.definitions = {'utilization':
55
- {'options':
56
- [None, 'Pools utilization', 'used %', 'utilization', 'isc_dhcpd.util', 'line'],
57
- 'lines': []},
58
- 'total':
59
- {'options':
60
- [None, 'Total all pools', 'leases', 'utilization', 'isc_dhcpd.total', 'line'],
61
- 'lines': [['total', 'leases', 'absolute']]},
62
- 'parse_time':
63
- {'options':
64
- [None, 'Parse time', 'ms', 'parse stats', 'isc_dhcpd.parse', 'line'],
65
- 'lines': [['ptime', 'time', 'absolute']]},
66
- 'leases_size':
67
- {'options':
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']]}
77
-
78
- self.info('Plugin was started succesfully')
79
- return True
77
+ net = ip_network(u'%s' % self.configuration['pools'][pool])
78
+ self.pools[pool] = dict(net=net, num_hosts=net.num_addresses - 2)
79
+ except ValueError as error:
80
+ self.error('%s removed, error: %s' % (self.configuration['pools'][pool], error))
81
+
82
+ if not self.pools:
83
+ return False
84
+ self.create_charts()
85
+ return True
86
87
def _get_raw_data(self):
88
"""
@@ -87,65 +93,60 @@ class Service(SimpleService):
93
)
94
"""
95
try:
90
- with open(self.leases_path, 'rt') as dhcp_leases:
96
+ with open(self.leases_path) as leases:
97
time_start = time()
92
- part1 = filterfalse(find_lease, dhcp_leases)
93
- part2 = filterfalse(find_ends, dhcp_leases)
94
- raw_result = dict(zip(part1, part2))
98
+ part1 = filterfalse(find_lease, leases)
99
+ part2 = filterfalse(find_ends, leases)
100
+ result = dict(zip(part1, part2))
101
time_end = time()
102
file_parse_time = round((time_end - time_start) * 1000)
97
- except Exception as e:
98
- self.error("Failed to parse leases file:", str(e))
103
+ return result, file_parse_time
104
+ except (OSError, IOError) as error:
105
+ self.error("Failed to parse leases file:", str(error))
106
return None
100
- else:
101
- result = (raw_result, file_parse_time)
102
- return result
107
108
def _get_data(self):
109
"""
110
:return: dict
111
"""
108
- raw_leases = self._get_raw_data()
109
- if not raw_leases:
112
+ raw_data = self._get_raw_data()
113
+ if not raw_data:
114
return None
115
112
- # Result: {ipaddress: end lease time, ...}
113
- all_leases = dict([(k[6:len(k)-3], v[7:len(v)-2]) for k, v in raw_leases[0].items()])
114
-
115
- # Result: [active binding, active binding....]. (Expire time (ends date;) - current time > 0)
116
- active_leases = [k for k, v in all_leases.items() if is_binding_active(all_leases[k])]
117
-
118
- # Result: {pool: number of active bindings in pool, ...}
119
- pools_count = dict([(pool, len([lease for lease in active_leases if is_address_in(lease, pool)]))
120
- for pool in self.pools])
121
-
122
- # Result: {pool: number of host ip addresses in pool, ...}
123
- pools_max = dict([(pool, (2 ** (32 - int(pool.split('/')[1])) - 2))
124
- for pool in self.pools])
125
-
126
- # Result: {pool: % utilization, ....} (percent)
127
- pools_util = dict([(pool, int(round(float(pools_count[pool]) / pools_max[pool] * 100, 0)))
128
- for pool in self.pools])
129
-
130
- # Bulding dicts to send to netdata
131
- final_count = dict([(''.join(['le_', k]), v) for k, v in pools_count.items()])
132
- final_util = dict([(''.join(['ut_', k]), v) for k, v in pools_util.items()])
133
-
134
- to_netdata = {'total': len(active_leases)}
135
- to_netdata.update({'lsize': int(stat(self.leases_path)[6] / 1024)})
136
- to_netdata.update({'ptime': int(raw_leases[1])})
137
- to_netdata.update(final_util)
138
- to_netdata.update(final_count)
116
+ raw_leases, parse_time = raw_data[0], raw_data[1]
117
118
+ # Result: {ipaddress: end lease time, ...}
119
+ active_leases, to_netdata = list(), dict()
120
+ current_time = mktime(gmtime())
121
+
122
+ for ip, lease_end_time in raw_leases.items():
123
+ # Result: [active binding, active binding....]. (Expire time (ends date;) - current time > 0)
124
+ if binding_active(lease_end_time=lease_end_time[7:-2],
125
+ current_time=current_time):
126
+ active_leases.append(ip_address(u'%s' % ip[6:-3]))
127
+
128
+ for pool in self.pools:
129
+ dim_id = pool.replace('.', '_')
130
+ pool_leases_count = len([ip for ip in active_leases if ip in self.pools[pool]['net']])
131
+ to_netdata[dim_id + '_active_leases'] = pool_leases_count
132
+ to_netdata[dim_id + '_utilization'] = float(pool_leases_count) / self.pools[pool]['num_hosts'] * 10000
133
+
134
+ to_netdata['leases_total'] = len(active_leases)
135
+ to_netdata['leases_size'] = stat(self.leases_path)[6]
136
+ to_netdata['parse_time'] = parse_time
137
return to_netdata
138
139
+ def create_charts(self):
140
+ for pool in self.pools:
141
+ dim, dim_id = pool, pool.replace('.', '_')
142
+ self.definitions['pools_utilization']['lines'].append([dim_id + '_utilization',
143
+ dim, 'absolute', 1, 100])
144
+ self.definitions['pools_active_leases']['lines'].append([dim_id + '_active_leases',
145
+ dim, 'absolute'])
146
143
-def is_binding_active(binding):
144
- return mktime(strptime(binding, '%w %Y/%m/%d %H:%M:%S')) - mktime(gmtime()) > 0
147
146
-
147
-def is_address_in(address, pool):
148
- return ipaddress(return_utf(address)) in ip_network(return_utf(pool))
148
+def binding_active(lease_end_time, current_time):
149
+ return mktime(strptime(lease_end_time, '%w %Y/%m/%d %H:%M:%S')) - current_time > 0
150
151
152
def find_lease(value):
@@ -155,10 +156,3 @@ def find_lease(value):
156
def find_ends(value):
157
return value[2:6] != 'ends'
158
158
-
159
-def return_utf(s):
160
- # python2 returns "<type 'str'>" for simple strings
161
- # python3 returns "<class 'str'>" for unicode strings
162
- if str(type(s)) == "<type 'str'>":
163
- return unicode(s, 'utf-8')
164
- return s