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 = True
  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         response = self._get_raw_data()
  62
  63         data = {}
  64         try:
  65             raw = ""
  66             for tmp in response.split('\r\n'):
  67                 if tmp.startswith("sample_time"):
  68                     raw = tmp
  69                     break
  70
  71             if raw.startswith('<'):
  72                 self.error("invalid data received")
  73                 return None
  74
  75             for row in raw.split('\n'):
  76                 if row.startswith(("client", "server.all")):
  77                     tmp = row.split("=")
  78                     data[tmp[0].replace('.', '_').strip(' ')] = int(tmp[1])
  79
  80         except (ValueError, AttributeError, TypeError):
  81             self.error("invalid data received")
  82             return None
  83
  84         if len(data) == 0:
  85             self.error("no data received")
  86             return None
  87         else:
  88             return data
  89
  90     def _check_raw_data(self, data):
  91         header = data[:1024].lower()
  92
  93         if "connection: keep-alive" in header:
  94             self._keep_alive = True
  95         else:
  96             self._keep_alive = False
  97
  98         if data[-7:] == "\r\n0\r\n\r\n" and "transfer-encoding: chunked" in header:  # HTTP/1.1 response
  99             self.debug("received full response from squid")
 100             return True
 101
 102         self.debug("waiting more data from squid")
 103         return False
 104
 105     def check(self):
 106         """
 107         Parse essential configuration, autodetect squid configuration (if needed), and check if data is available
 108         :return: boolean
 109         """
 110         self._parse_config()
 111         # format request
 112         req = self.request.decode()
 113         if not req.startswith("GET"):
 114             req = "GET " + req
 115         if not req.endswith(" HTTP/1.1\r\n\r\n"):
 116             req += " HTTP/1.1\r\n\r\n"
 117         self.request = req.encode()
 118         if self._get_data() is not None:
 119             return True
 120         else:
 121             return False