python.d/squid.chart.py

   1 # -*- coding: utf-8 -*-
   2 # Description: squid netdata python.d module
   3 # Author: Pawel Krupa (paulfantom)
   4
   5 from base import SocketService
   6 import select
   7
   8 # default module values (can be overridden per job in `config`)
   9 # update_every = 2
  10 priority = 60000
  11 retries = 60
  12
  13 # charts order (can be overridden if you want less charts, or different order)
  14 ORDER = ['clients_net', 'clients_requests', 'servers_net', 'servers_requests']
  15
  16 CHARTS = {
  17     'clients_net': {
  18         'options': [None, "Squid Client Bandwidth", "kilobits/s", "clients", "squid.clients.net", "area"],
  19         'lines': [
  20             ["client_http_kbytes_in", "in", "incremental", 8, 1],
  21             ["client_http_kbytes_out", "out", "incremental", -8, 1],
  22             ["client_http_hit_kbytes_out", "hits", "incremental", -8, 1]
  23         ]},
  24     'clients_requests': {
  25         'options': [None, "Squid Client Requests", "requests/s", "clients", "squid.clients.requests", 'line'],
  26         'lines': [
  27             ["client_http_requests", "requests", "incremental"],
  28             ["client_http_hits", "hits", "incremental"],
  29             ["client_http_errors", "errors", "incremental", -1, 1]
  30         ]},
  31     'servers_net': {
  32         'options': [None, "Squid Server Bandwidth", "kilobits/s", "servers", "squid.servers.net", "area"],
  33         'lines': [
  34             ["server_all_kbytes_in", "in", "incremental", 8, 1],
  35             ["server_all_kbytes_out", "out", "incremental", -8, 1]
  36         ]},
  37     'servers_requests': {
  38         'options': [None, "Squid Server Requests", "requests/s", "servers", "squid.servers.requests", 'line'],
  39         'lines': [
  40             ["server_all_requests", "requests", "incremental"],
  41             ["server_all_errors", "errors", "incremental", -1, 1]
  42         ]}
  43 }
  44
  45
  46 class Service(SocketService):
  47     def __init__(self, configuration=None, name=None):
  48         SocketService.__init__(self, configuration=configuration, name=name)
  49         self._keep_alive = False
  50         self.request = ""
  51         self.host = "localhost"
  52         self.port = 3128
  53         self.order = ORDER
  54         self.definitions = CHARTS
  55
  56     def _get_data(self):
  57         """
  58         Get data via http request
  59         :return: dict
  60         """
  61         data = {}
  62         try:
  63             raw = self._get_raw_data().split('\r\n')[-1]
  64             if raw.startswith('<'):
  65                 self.error("invalid data received")
  66                 return None
  67             for row in raw.split('\n'):
  68                 if row.startswith(("client", "server.all")):
  69                     tmp = row.split("=")
  70                     data[tmp[0].replace('.', '_').strip(' ')] = int(tmp[1])
  71         except (ValueError, AttributeError, TypeError):
  72             self.error("invalid data received")
  73             return None
  74
  75         if len(data) == 0:
  76             self.error("no data received")
  77             return None
  78         else:
  79             return data
  80
  81     def _more_data_available(self):
  82         try:
  83             ready_to_read, _, in_error = select.select([self._sock, ], [], [], 0.05)
  84         except Exception as e:
  85             self.debug("select returned exception", str(e))
  86         if len(ready_to_read) > 0:
  87             return True
  88         else:
  89             return False
  90
  91     def check(self):
  92         """
  93         Parse essential configuration, autodetect squid configuration (if needed), and check if data is available
  94         :return: boolean
  95         """
  96         self._parse_config()
  97         # format request
  98         req = self.request.decode()
  99         if not req.startswith("GET"):
 100             req = "GET " + req
 101         if not req.endswith(" HTTP/1.0\r\n\r\n"):
 102             req += " HTTP/1.0\r\n\r\n"
 103         self.request = req.encode()
 104         if self._get_data() is not None:
 105             return True
 106         else:
 107             return False