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 = ['net', 'connections', 'items', 'evicted_reclaimed', 'get', 'get_rate', 'set_rate', 'delete', 'cas', 'increment', 'decrement', 'touch', 'touch_rate']
  23
  24 CHARTS = {
  25     'net': {
  26         'options': [None, 'Network', 'kilobytes/s', 'Network', 'memcached.net', 'line'],
  27         'lines': [
  28             ['bytes_read', 'read', 'incremental', 1, 1024],
  29             ['bytes_written', 'written', 'incremental', 1, 1024]
  30         ]},
  31     'connections': {
  32         'options': [None, 'Connections', 'connections/s', 'Cluster', 'memcached.cluster', 'line'],
  33         'lines': [
  34             ['curr_connections', 'current', 'incremental'],
  35             ['rejected_connections', 'rejected', 'incremental'],
  36             ['total_connections', 'total', 'incremental']
  37         ]},
  38     'items': {
  39         'options': [None, 'Items', 'items', 'Cluster', 'memcached.cluster', 'line'],
  40         'lines': [
  41             ['curr_items', 'current', 'absolute'],
  42             ['total_items', 'total', 'absolute']
  43         ]},
  44     'evicted_reclaimed': {
  45         'options': [None, 'Items', 'items', 'Evicted and Reclaimed', 'memcached.evicted_reclaimed', 'line'],
  46         'lines': [
  47             ['evictions', 'evicted', 'absolute'],
  48             ['reclaimed', 'reclaimed', 'absolute']
  49         ]},
  50     'get': {
  51         'options': [None, 'Requests', 'requests', 'GET', 'memcached.get', 'stacked'],
  52         'lines': [
  53             ['get_hits', 'hits', 'percent-of-absolute-row'],
  54             ['get_misses', 'misses', 'percent-of-absolute-row']
  55         ]},
  56     'get_rate': {
  57         'options': [None, 'Rate', 'requests/s', 'GET', 'memcached.get', 'line'],
  58         'lines': [
  59             ['cmd_get', 'rate', 'incremental']
  60         ]},
  61     'set_rate': {
  62         'options': [None, 'Rate', 'requests/s', 'SET', 'memcached.set', 'line'],
  63         'lines': [
  64             ['cmd_set', 'rate', 'incremental']
  65         ]},
  66     'delete': {
  67         'options': [None, 'Requests', 'requests', 'DELETE', 'memcached.delete', 'stacked'],
  68         'lines': [
  69             ['delete_hits', 'hits', 'percent-of-absolute-row'],
  70             ['delete_misses', 'misses', 'percent-of-absolute-row'],
  71         ]},
  72     'cas': {
  73         'options': [None, 'Requests', 'requests', 'CAS', 'memcached.cas', 'stacked'],
  74         'lines': [
  75             ['cas_hits', 'hits', 'percent-of-absolute-row'],
  76             ['cas_misses', 'misses', 'percent-of-absolute-row'],
  77             ['cas_badval', 'bad value', 'percent-of-absolute-row']
  78         ]},
  79     'increment': {
  80         'options': [None, 'Requests', 'requests', 'Increment', 'memcached.incr', 'stacked'],
  81         'lines': [
  82             ['incr_hits', 'hits', 'percent-of-absolute-row'],
  83             ['incr_misses', 'misses', 'percent-of-absolute-row']
  84         ]},
  85     'decrement': {
  86         'options': [None, 'Requests', 'requests', 'Decrement', 'memcached.decr', 'stacked'],
  87         'lines': [
  88             ['decr_hits', 'hits', 'percent-of-absolute-row'],
  89             ['decr_misses', 'misses', 'percent-of-absolute-row']
  90         ]},
  91     'touch': {
  92         'options': [None, 'Requests', 'requests', 'Touch', 'memcached.touch', 'stacked'],
  93         'lines': [
  94             ['touch_hits', 'hits', 'percent-of-absolute-row'],
  95             ['touch_misses', 'misses', 'percent-of-absolute-row']
  96         ]},
  97     'touch_rate': {
  98         'options': [None, 'Rate', 'requests/s', 'Touch', 'memcached.touch', 'line'],
  99         'lines': [
 100             ['cmd_touch', 'rate', 'incremental']
 101         ]}
 102 }
 103
 104
 105 class Service(SocketService):
 106     def __init__(self, configuration=None, name=None):
 107         SocketService.__init__(self, configuration=configuration, name=name)
 108         self.request = "stats\r\n"
 109         self.host = "localhost"
 110         self.port = 11211
 111         self._keep_alive = True
 112         self.unix_socket = None
 113         self.order = ORDER
 114         self.definitions = CHARTS
 115
 116     def _get_data(self):
 117         """
 118         Get data from socket
 119         :return: dict
 120         """
 121         try:
 122             raw = self._get_raw_data().split("\n")
 123         except AttributeError:
 124             self.error("no data received")
 125             return None
 126         if raw[0].startswith('ERROR'):
 127             self.error("Memcached returned ERROR")
 128             return None
 129         data = {}
 130         for line in raw:
 131             if line.startswith('STAT'):
 132                 try:
 133                     t = line[5:].split(' ')
 134                     data[t[0]] = int(t[1])
 135                 except (IndexError, ValueError):
 136                     pass
 137         try:
 138             data['hit_rate'] = int((data['keyspace_hits'] / float(data['keyspace_hits'] + data['keyspace_misses'])) * 100)
 139         except:
 140             data['hit_rate'] = 0
 141
 142         if len(data) == 0:
 143             self.error("received data doesn't have needed records")
 144             return None
 145         else:
 146             return data
 147
 148     def _check_raw_data(self, data):
 149         if data.endswith('END\r\n'):
 150             return True
 151         else:
 152             return False
 153
 154     def check(self):
 155         """
 156         Parse configuration, check if memcached is available
 157         :return: boolean
 158         """
 159         self._parse_config()
 160         if self.name == "":
 161             self.name = "local"
 162         self.chart_name += "_" + self.name
 163         data = self._get_data()
 164         if data is None:
 165             return False
 166
 167         return True