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