python.d/memcached.chart.py

   1 # -*- coding: utf-8 -*-
   2 # Description: memcached netdata python.d module
   3 # Author: Pawel Krupa (paulfantom)
   4
   5 from base import SocketService
   6
   7 # default module values (can be overridden per job in `config`)
   8 #update_every = 2
   9 priority = 60000
  10 retries = 60
  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 #             'host': 'localhost',
  18 #             'port': 11211,
  19 #             'unix_socket': None
  20 #          }}
  21
  22 ORDER = ['cache', 'net', 'connections', 'items', 'evicted_reclaimed',
  23          'get', 'get_rate', 'set_rate', 'cas', 'delete', 'increment', 'decrement', 'touch', 'touch_rate']
  24
  25 CHARTS = {
  26     'cache': {
  27         'options': [None, 'Cache Size', 'megabytes', 'cache', 'memcached.cache', 'stacked'],
  28         'lines': [
  29             ['avail', 'available', 'absolute', 1, 1048576],
  30             ['used', 'used', 'absolute', 1, 1048576]
  31         ]},
  32     'net': {
  33         'options': [None, 'Network', 'kilobits/s', 'network', 'memcached.net', 'area'],
  34         'lines': [
  35             ['bytes_read', 'in', 'incremental', 8, 1024],
  36             ['bytes_written', 'out', 'incremental', -8, 1024]
  37         ]},
  38     'connections': {
  39         'options': [None, 'Connections', 'connections/s', 'connections', 'memcached.connections', 'line'],
  40         'lines': [
  41             ['curr_connections', 'current', 'incremental'],
  42             ['rejected_connections', 'rejected', 'incremental'],
  43             ['total_connections', 'total', 'incremental']
  44         ]},
  45     'items': {
  46         'options': [None, 'Items', 'items', 'items', 'memcached.items', 'line'],
  47         'lines': [
  48             ['curr_items', 'current', 'absolute'],
  49             ['total_items', 'total', 'absolute']
  50         ]},
  51     'evicted_reclaimed': {
  52         'options': [None, 'Items', 'items', 'items', 'memcached.evicted_reclaimed', 'line'],
  53         'lines': [
  54             ['reclaimed', 'reclaimed', 'absolute'],
  55             ['evictions', 'evicted', 'absolute']
  56         ]},
  57     'get': {
  58         'options': [None, 'Requests', 'requests', 'get ops', 'memcached.get', 'stacked'],
  59         'lines': [
  60             ['get_hits', 'hits', 'percent-of-absolute-row'],
  61             ['get_misses', 'misses', 'percent-of-absolute-row']
  62         ]},
  63     'get_rate': {
  64         'options': [None, 'Rate', 'requests/s', 'get ops', 'memcached.get_rate', 'line'],
  65         'lines': [
  66             ['cmd_get', 'rate', 'incremental']
  67         ]},
  68     'set_rate': {
  69         'options': [None, 'Rate', 'requests/s', 'set ops', 'memcached.set_rate', 'line'],
  70         'lines': [
  71             ['cmd_set', 'rate', 'incremental']
  72         ]},
  73     'delete': {
  74         'options': [None, 'Requests', 'requests', 'delete ops', 'memcached.delete', 'stacked'],
  75         'lines': [
  76             ['delete_hits', 'hits', 'percent-of-absolute-row'],
  77             ['delete_misses', 'misses', 'percent-of-absolute-row'],
  78         ]},
  79     'cas': {
  80         'options': [None, 'Requests', 'requests', 'check and set ops', 'memcached.cas', 'stacked'],
  81         'lines': [
  82             ['cas_hits', 'hits', 'percent-of-absolute-row'],
  83             ['cas_misses', 'misses', 'percent-of-absolute-row'],
  84             ['cas_badval', 'bad value', 'percent-of-absolute-row']
  85         ]},
  86     'increment': {
  87         'options': [None, 'Requests', 'requests', 'increment ops', 'memcached.increment', 'stacked'],
  88         'lines': [
  89             ['incr_hits', 'hits', 'percent-of-absolute-row'],
  90             ['incr_misses', 'misses', 'percent-of-absolute-row']
  91         ]},
  92     'decrement': {
  93         'options': [None, 'Requests', 'requests', 'decrement ops', 'memcached.decrement', 'stacked'],
  94         'lines': [
  95             ['decr_hits', 'hits', 'percent-of-absolute-row'],
  96             ['decr_misses', 'misses', 'percent-of-absolute-row']
  97         ]},
  98     'touch': {
  99         'options': [None, 'Requests', 'requests', 'touch ops', 'memcached.touch', 'stacked'],
 100         'lines': [
 101             ['touch_hits', 'hits', 'percent-of-absolute-row'],
 102             ['touch_misses', 'misses', 'percent-of-absolute-row']
 103         ]},
 104     'touch_rate': {
 105         'options': [None, 'Rate', 'requests/s', 'touch ops', 'memcached.touch_rate', 'line'],
 106         'lines': [
 107             ['cmd_touch', 'rate', 'incremental']
 108         ]}
 109 }
 110
 111
 112 class Service(SocketService):
 113     def __init__(self, configuration=None, name=None):
 114         SocketService.__init__(self, configuration=configuration, name=name)
 115         self.request = "stats\r\n"
 116         self.host = "localhost"
 117         self.port = 11211
 118         self._keep_alive = True
 119         self.unix_socket = None
 120         self.order = ORDER
 121         self.definitions = CHARTS
 122
 123     def _get_data(self):
 124         """
 125         Get data from socket
 126         :return: dict
 127         """
 128         response = self._get_raw_data()
 129         if response is None:
 130             # error has already been logged
 131             return None
 132
 133         if response.startswith('ERROR'):
 134             self.error("received ERROR")
 135             return None
 136
 137         try:
 138             parsed = response.split("\n")
 139         except AttributeError:
 140             self.error("response is invalid/empty")
 141             return None
 142
 143         # split the response
 144         data = {}
 145         for line in parsed:
 146             if line.startswith('STAT'):
 147                 try:
 148                     t = line[5:].split(' ')
 149                     data[t[0]] = t[1]
 150                 except (IndexError, ValueError):
 151                     self.debug("invalid line received: " + str(line))
 152                     pass
 153
 154         if len(data) == 0:
 155             self.error("received data doesn't have any records")
 156             return None
 157
 158         # custom calculations
 159         try:
 160             data['avail'] = int(data['limit_maxbytes']) - int(data['bytes'])
 161             data['used'] = int(data['bytes'])
 162         except:
 163             pass
 164
 165         return data
 166
 167     def _check_raw_data(self, data):
 168         if data.endswith('END\r\n'):
 169             self.debug("received full response from memcached")
 170             return True
 171
 172         self.debug("waiting more data from memcached")
 173         return False
 174
 175     def check(self):
 176         """
 177         Parse configuration, check if memcached is available
 178         :return: boolean
 179         """
 180         self._parse_config()
 181         if self.name == "":
 182             self.name = "local"
 183         self.chart_name += "_" + self.name
 184         data = self._get_data()
 185         if data is None:
 186             return False
 187
 188         return True