python.d/freeradius.chart.py

   1 # -*- coding: utf-8 -*-
   2 # Description: freeradius netdata python.d module
   3 # Author: l2isbad
   4
   5 from base import SimpleService
   6 from os.path import isfile
   7 from re import findall
   8 from subprocess import Popen, PIPE
   9
  10 # default module values (can be overridden per job in `config`)
  11 priority = 60000
  12 retries = 60
  13 update_every = 15
  14 directories = ['/bin/', '/usr/bin/', '/sbin/', '/usr/sbin/']
  15
  16 # charts order (can be overridden if you want less charts, or different order)
  17 ORDER = ['authentication', 'accounting', 'proxy-auth', 'proxy-acct']
  18
  19 CHARTS = {
  20     'authentication': {
  21         'options': [None, "Authentication", "packets/s", 'Authentication', 'freerad.auth', 'line'],
  22         'lines': [
  23             ['access-accepts', None, 'incremental'], ['access-rejects', None, 'incremental'],
  24             ['auth-dropped-requests', None, 'incremental'], ['auth-duplicate-requests', None, 'incremental'],
  25             ['auth-invalid-requests', None, 'incremental'], ['auth-malformed-requests', None, 'incremental'],
  26             ['auth-unknown-types', None, 'incremental']
  27         ]},
  28      'accounting': {
  29         'options': [None, "Accounting", "packets/s", 'Accounting', 'freerad.acct', 'line'],
  30         'lines': [
  31             ['accounting-requests', None, 'incremental'], ['accounting-responses', None, 'incremental'],
  32             ['acct-dropped-requests', None, 'incremental'], ['acct-duplicate-requests', None, 'incremental'],
  33             ['acct-invalid-requests', None, 'incremental'], ['acct-malformed-requests', None, 'incremental'],
  34             ['acct-unknown-types', None, 'incremental']
  35         ]},
  36     'proxy-auth': {
  37         'options': [None, "Proxy Authentication", "packets/s", 'Authentication', 'freerad.proxy.auth', 'line'],
  38         'lines': [
  39             ['proxy-access-accepts', None, 'incremental'], ['proxy-access-rejects', None, 'incremental'],
  40             ['proxy-auth-dropped-requests', None, 'incremental'], ['proxy-auth-duplicate-requests', None, 'incremental'],
  41             ['proxy-auth-invalid-requests', None, 'incremental'], ['proxy-auth-malformed-requests', None, 'incremental'],
  42             ['proxy-auth-unknown-types', None, 'incremental']
  43         ]},
  44      'proxy-acct': {
  45         'options': [None, "Proxy Accounting", "packets/s", 'Accounting', 'freerad.proxy.acct', 'line'],
  46         'lines': [
  47             ['proxy-accounting-requests', None, 'incremental'], ['proxy-accounting-responses', None, 'incremental'],
  48             ['proxy-acct-dropped-requests', None, 'incremental'], ['proxy-acct-duplicate-requests', None, 'incremental'],
  49             ['proxy-acct-invalid-requests', None, 'incremental'], ['proxy-acct-malformed-requests', None, 'incremental'],
  50             ['proxy-acct-unknown-types', None, 'incremental']
  51         ]}
  52
  53 }
  54
  55
  56 class Service(SimpleService):
  57     def __init__(self, configuration=None, name=None):
  58         SimpleService.__init__(self, configuration=configuration, name=name)
  59         self.host = self.configuration.get('host', 'localhost')
  60         self.port = self.configuration.get('port', '18121')
  61         self.secret = self.configuration.get('secret', 'adminsecret')
  62         self.acct = self.configuration.get('acct', False)
  63         self.proxy_auth = self.configuration.get('proxy_auth', False)
  64         self.proxy_acct = self.configuration.get('proxy_acct', False)
  65         try:
  66             self.echo = [''.join([directory, 'echo']) for directory in directories if isfile(''.join([directory, 'echo']))][0]
  67             self.radclient = [''.join([directory, 'radclient']) for directory in directories if isfile(''.join([directory, 'radclient']))][0]
  68         except IndexError:
  69             self.echo = []
  70             self.radclient = []
  71         self.sub_echo = [self.echo, 'Message-Authenticator = 0x00, FreeRADIUS-Statistics-Type = 15, Response-Packet-Type = Access-Accept']
  72         self.sub_radclient = [self.radclient, '-r', '1', '-t', '1', ':'.join([self.host, self.port]), 'status', self.secret]
  73
  74     def check(self):
  75         if not all([self.echo, self.radclient]):
  76             self.error('Command radclient not found')
  77             return False
  78         if self._get_raw_data():
  79             chart_choice = [True, bool(self.acct), bool(self.proxy_auth), bool(self.proxy_acct)]
  80             self.order = [chart for chart, choice in zip(ORDER, chart_choice) if choice]
  81             self.definitions = {k:v for k, v in CHARTS.items() if k in self.order}
  82             self.info('Plugin was started succesfully')
  83             return True
  84         else:
  85             self.error('Request returned no data. Is server alive? Used options: host {}, port {}, secret {}'.format(self.host, self.port, self.secret))
  86             return False
  87
  88
  89     def _get_data(self):
  90         """
  91         Format data received from shell command
  92         :return: dict
  93         """
  94         result = self._get_raw_data()
  95         return {k.lower():int(v) for k, v in findall(r'((?<=-)[AP][a-zA-Z-]+) = (\d+)', result)}
  96
  97     def _get_raw_data(self):
  98         """
  99         The following code is equivalent to
 100         'echo "Message-Authenticator = 0x00, FreeRADIUS-Statistics-Type = 15, Response-Packet-Type = Access-Accept" | radclient -t 1 -r 1 host:port status secret'
 101         :return: str
 102         """
 103         try:
 104             process_echo = Popen(self.sub_echo, stdout=PIPE, stderr=PIPE, shell=False)
 105             process_rad = Popen(self.sub_radclient, stdin=process_echo.stdout, stdout=PIPE, stderr=PIPE, shell=False)
 106             process_echo.stdout.close()
 107             raw_result = process_rad.communicate()[0]
 108         except Exception:
 109             return None
 110         else:
 111             if process_rad.returncode is 0:
 112                 return raw_result.decode()
 113             else:
 114                 return None