python.d/squid.chart.py

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