forked from ganglia/gmond_python_modules
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathrabbitmq.py
More file actions
470 lines (386 loc) · 17.3 KB
/
rabbitmq.py
File metadata and controls
470 lines (386 loc) · 17.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
#!/usr/bin/python2.4
import itertools
import json
import logging
import logging.handlers
import optparse
import os
import pprint
import sys
import threading
import time
import urllib2
from string import Template
global url, descriptors, last_update, vhost, username, password, url_template, result, result_dict, keyToPath
log = None
JSON_PATH_SEPARATOR = "?"
METRIC_TOKEN_SEPARATOR = "___"
INTERVAL = 10
descriptors = list()
username, password = "guest", "guest"
stats = {}
keyToPath = {}
last_update = None
#last_update = {}
compiled_results = {"nodes": None, "queues": None, "connections": None, "exchanges": None}
#Make initial stat test time dict
#for stat_type in ('queues', 'connections','exchanges', 'nodes'):
# last_update[stat_type] = None
### CONFIGURATION SECTION ###
STATS = ['nodes', 'queues']
# QUEUE METRICS #
keyToPath['rmq_messages_ready'] = "%s{0}messages_ready".format(JSON_PATH_SEPARATOR)
keyToPath['rmq_messages_unacknowledged'] = "%s{0}messages_unacknowledged".format(JSON_PATH_SEPARATOR)
keyToPath['rmq_backing_queue_ack_egress_rate'] = "%s{0}backing_queue_status{0}avg_ack_egress_rate".format(JSON_PATH_SEPARATOR)
keyToPath['rmq_backing_queue_ack_ingress_rate'] = "%s{0}backing_queue_status{0}avg_ack_ingress_rate".format(JSON_PATH_SEPARATOR)
keyToPath['rmq_backing_queue_egress_rate'] = "%s{0}backing_queue_status{0}avg_egress_rate".format(JSON_PATH_SEPARATOR)
keyToPath['rmq_backing_queue_ingress_rate'] = "%s{0}backing_queue_status{0}avg_ingress_rate".format(JSON_PATH_SEPARATOR)
keyToPath['rmq_backing_queue_mirror_senders'] = "%s{0}backing_queue_status{0}mirror_senders".format(JSON_PATH_SEPARATOR)
keyToPath['rmq_memory'] = "%s{0}memory".format(JSON_PATH_SEPARATOR)
keyToPath['rmq_consumers'] = "%s{0}consumers".format(JSON_PATH_SEPARATOR)
keyToPath['rmq_messages'] = "%s{0}messages".format(JSON_PATH_SEPARATOR)
RATE_METRICS = [
'rmq_backing_queue_ack_egress_rate',
'rmq_backing_queue_ack_ingress_rate',
'rmq_backing_queue_egress_rate',
'rmq_backing_queue_ingress_rate',
'rmq_exchange_publish_in_rate',
'rmq_exchange_publish_out_rate',
]
QUEUE_METRICS = ['rmq_messages_ready',
'rmq_messages_unacknowledged',
'rmq_backing_queue_ack_egress_rate',
'rmq_backing_queue_ack_ingress_rate',
'rmq_backing_queue_egress_rate',
'rmq_backing_queue_ingress_rate',
'rmq_backing_queue_mirror_senders',
'rmq_memory',
'rmq_consumers',
'rmq_messages']
# NODE METRICS #
keyToPath['rmq_disk_free'] = "%s{0}disk_free".format(JSON_PATH_SEPARATOR)
keyToPath['rmq_disk_free_alarm'] = "%s{0}disk_free_alarm".format(JSON_PATH_SEPARATOR)
keyToPath['rmq_fd_used'] = "%s{0}fd_used".format(JSON_PATH_SEPARATOR)
keyToPath['rmq_fd_used'] = "%s{0}fd_used".format(JSON_PATH_SEPARATOR)
keyToPath['rmq_mem_used'] = "%s{0}mem_used".format(JSON_PATH_SEPARATOR)
keyToPath['rmq_proc_used'] = "%s{0}proc_used".format(JSON_PATH_SEPARATOR)
keyToPath['rmq_sockets_used'] = "%s{0}sockets_used".format(JSON_PATH_SEPARATOR)
keyToPath['rmq_mem_alarm'] = "%s{0}mem_alarm".format(JSON_PATH_SEPARATOR) # Boolean
keyToPath['rmq_mem_binary'] = "%s{0}mem_binary".format(JSON_PATH_SEPARATOR)
keyToPath['rmq_mem_code'] = "%s{0}mem_code".format(JSON_PATH_SEPARATOR)
keyToPath['rmq_mem_proc_used'] = "%s{0}mem_proc_used".format(JSON_PATH_SEPARATOR)
keyToPath['rmq_running'] = "%s{0}running".format(JSON_PATH_SEPARATOR) # Boolean
NODE_METRICS = ['rmq_disk_free', 'rmq_mem_used', 'rmq_disk_free_alarm', 'rmq_running', 'rmq_proc_used', 'rmq_mem_proc_used', 'rmq_fd_used', 'rmq_mem_alarm', 'rmq_mem_code', 'rmq_mem_binary', 'rmq_sockets_used']
# EXCHANGE METRICS #
keyToPath['rmq_exchange_publish_in_rate'] = "%s{0}message_stats{0}publish_in_details{0}rate".format(JSON_PATH_SEPARATOR)
keyToPath['rmq_exchange_publish_out_rate'] = "%s{0}message_stats{0}publish_out_details{0}rate".format(JSON_PATH_SEPARATOR)
EXCHANGE_METRICS = ['rmq_exchange_publish_in_rate', 'rmq_exchange_publish_out_rate']
def dig_it_up(obj, path):
try:
path = path.split(JSON_PATH_SEPARATOR)
return reduce(lambda x, y: x[y], path, obj)
except Exception, e:
# not WARN because the False return is used for control flow
# (zero assumed)
log.debug('dig_it_up Exception %r path: %s' % (e, path))
return False
def refreshStats(stats=('nodes', 'queues'), vhosts=['/']):
global url_template
global last_update, url, compiled_results
now = time.time()
if not last_update:
diff = INTERVAL
else:
diff = now - last_update
if diff >= INTERVAL or not last_update:
log.debug("Fetching Results after %d seconds" % INTERVAL)
last_update = now
for stat in stats:
for vhost in vhosts:
if stat in ('nodes'):
vhost = '/'
result_dict = {}
urlstring = url_template.safe_substitute(stats=stat, vhost=vhost)
log.debug('urlspring: %s' % urlstring)
result = json.load(urllib2.urlopen(urlstring))
# Rearrange results so entry is held in a dict keyed by name - queue name, host name, etc.
if stat in ("queues", "nodes", "exchanges"):
for entry in result:
name = entry['name']
result_dict[name] = entry
compiled_results[(stat, vhost)] = result_dict
return compiled_results
def validatedResult(value):
if not isInstance(value, bool):
return float(value)
else:
return None
def list_queues(vhost):
global compiled_results
queues = compiled_results[('queues', vhost)].keys()
return queues
def list_nodes():
global compiled_results
nodes = compiled_results[('nodes', '/')].keys()
return nodes
def list_exchanges(vhost):
global compiled_results
exchanges = compiled_results[('exchanges', vhost)].keys()
return exchanges
def getQueueStat(name):
refreshStats(stats=STATS, vhosts=vhosts)
# Split a name like "rmq_backing_queue_ack_egress_rate.access"
# handle queue names with . in them
log.debug(name)
stat_name, queue_name, vhost = name.split(METRIC_TOKEN_SEPARATOR)
vhost = vhost.replace('-', '/') # decoding vhost from metric name
# Run refreshStats to get the result object
result = compiled_results[('queues', vhost)]
value = dig_it_up(result, keyToPath[stat_name] % queue_name)
if zero_rates_when_idle and stat_name in RATE_METRICS and 'idle_since' in result[queue_name].keys():
value = 0
# Convert Booleans
if value is True:
value = 1
elif value is False:
value = 0
return float(value)
def getNodeStat(name):
refreshStats(stats=STATS, vhosts=vhosts)
# Split a name like "rmq_backing_queue_ack_egress_rate.access"
stat_name, node_name, vhost = name.split(METRIC_TOKEN_SEPARATOR)
vhost = vhost.replace('-', '/') # decoding vhost from metric name
result = compiled_results[('nodes', '/')]
value = dig_it_up(result, keyToPath[stat_name] % node_name)
log.debug('name: %r value: %r' % (name, value))
# Convert Booleans
if value is True:
value = 1
elif value is False:
value = 0
return float(value)
def getExchangeStat(name):
refreshStats(stats=STATS, vhosts=vhosts)
# Split a name like "rmq_backing_queue_ack_egress_rate.access"
# handle queue names with . in them
log.debug(name)
stat_name, exchange_name, vhost = name.split(METRIC_TOKEN_SEPARATOR)
vhost = vhost.replace('-', '/') # decoding vhost from metric name
# Run refreshStats to get the result object
result = compiled_results[('exchanges', vhost)]
value = dig_it_up(result, keyToPath[stat_name] % exchange_name)
if zero_rates_when_idle and stat_name in RATE_METRICS and 'idle_since' in result[exchange_name].keys():
value = 0
# Convert Booleans
if value is True:
value = 1
elif value is False:
value = 0
return float(value)
def product(*args, **kwds):
# replacement for itertools.product
# product('ABCD', 'xy') --> Ax Ay Bx By Cx Cy Dx Dy
pools = map(tuple, args) * kwds.get('repeat', 1)
result = [[]]
for pool in pools:
result = [x + [y] for x in result for y in pool]
for prod in result:
yield tuple(prod)
def str2bool(string):
if string.lower() in ("yes", "true"):
return True
if string.lower() in ("no", "false"):
return False
raise Exception("Invalid value of the 'zero_rates_when_idle' param, use one of the ('true', 'yes', 'false', 'no')")
def metric_init(params):
''' Create the metric definition object '''
global descriptors, stats, vhost, username, password, urlstring, url_template, compiled_results, STATS, vhosts, zero_rates_when_idle
if log is None:
setup_logging('syslog', params['syslog_facility'], params['log_level'])
log.info('received the following params: %r' % params)
# Set this globally so we can refresh stats
if 'host' not in params:
params['host'], params['vhost'], params['username'], params['password'], params['port'] = "localhost", "/", "guest", "guest", "15672"
if 'zero_rates_when_idle' not in params:
params['zero_rates_when_idle'] = "false"
# Set the vhosts as a list split from params
vhosts = params['vhost'].split(',')
username, password = params['username'], params['password']
host = params['host']
port = params['port']
STATS = params['stats']
zero_rates_when_idle = str2bool(params['zero_rates_when_idle'])
url = 'http://%s:%s/api/$stats/$vhost' % (host, port)
base_url = 'http://%s:%s/api' % (host, port)
password_mgr = urllib2.HTTPPasswordMgrWithDefaultRealm()
password_mgr.add_password(None, base_url, username, password)
handler = urllib2.HTTPBasicAuthHandler(password_mgr)
opener = urllib2.build_opener(handler)
opener.open(base_url)
urllib2.install_opener(opener)
url_template = Template(url)
refreshStats(stats=STATS, vhosts=vhosts)
def metric_handler(name):
if 15 < time.time() - metric_handler.timestamp:
metric_handler.timestamp = time.time()
return refreshStats(stats=STATS, vhosts=vhosts)
def create_desc(prop):
d = {
'name' : 'XXX',
'call_back' : getQueueStat,
'time_max' : 60,
'value_type' : 'uint',
'units' : 'units',
'slope' : 'both',
'format' : '%d',
'description' : 'XXX',
'groups' : params["metric_group"],
}
for k, v in prop.iteritems():
d[k] = v
return d
def buildQueueDescriptors():
for vhost, metric in product(vhosts, QUEUE_METRICS):
queues = list_queues(vhost)
for queue in queues:
name = "{1}{0}{2}{0}{3}".format(METRIC_TOKEN_SEPARATOR, metric, queue, vhost.replace('/', '-'))
log.debug(name)
d1 = create_desc({'name': name.encode('ascii', 'ignore'),
'call_back': getQueueStat,
'value_type': 'float',
'units': 'N',
'slope': 'both',
'format': '%f',
'description': 'Queue_Metric',
'groups': 'rabbitmq,queue'})
log.debug(d1)
descriptors.append(d1)
def buildNodeDescriptors():
for metric in NODE_METRICS:
for node in list_nodes():
name = "{1}{0}{2}{0}-".format(METRIC_TOKEN_SEPARATOR, metric, node)
log.debug(name)
d2 = create_desc({'name': name.encode('ascii', 'ignore'),
'call_back': getNodeStat,
'value_type': 'float',
'units': 'N',
'slope': 'both',
'format': '%f',
'description': 'Node_Metric',
'groups': 'rabbitmq,node'})
log.debug(d2)
descriptors.append(d2)
def buildExchangeDescriptors():
for vhost, metric in product(vhosts, EXCHANGE_METRICS):
exchanges = list_exchanges(vhost)
for exchange in exchanges:
name = "{1}{0}{2}{0}{3}".format(METRIC_TOKEN_SEPARATOR, metric, exchange, vhost.replace('/', '-'))
log.debug(name)
d1 = create_desc({'name': name.encode('ascii', 'ignore'),
'call_back': getExchangeStat,
'value_type': 'float',
'units': 'N',
'slope': 'both',
'format': '%f',
'description': 'Exchange_Metric',
'groups': 'rabbitmq,exchange'})
log.debug(d1)
descriptors.append(d1)
if 'queues' in STATS:
buildQueueDescriptors()
if 'nodes' in STATS:
buildNodeDescriptors()
if 'exchanges' in STATS:
buildExchangeDescriptors()
# buildTestNodeStat()
return descriptors
def metric_cleanup():
logging.shutdown()
def setup_logging(handlers, facility, level):
global log
log = logging.getLogger('gmond_python_rabbitmq')
formatter = logging.Formatter(' | '.join(['%(asctime)s', '%(name)s', '%(levelname)s', '%(message)s']))
if handlers in ['syslog', 'both']:
sh = logging.handlers.SysLogHandler(address='/dev/log', facility=facility)
sh.setFormatter(formatter)
log.addHandler(sh)
if handlers in ['stderr', 'both']:
ch = logging.StreamHandler()
ch.setFormatter(formatter)
log.addHandler(ch)
lmap = {
'CRITICAL': logging.CRITICAL,
'ERROR': logging.ERROR,
'WARNING': logging.WARNING,
'INFO': logging.INFO,
'DEBUG': logging.DEBUG,
'NOTSET': logging.NOTSET}
log.setLevel(lmap[level])
def parse_args(argv):
parser = optparse.OptionParser()
parser.add_option('--admin-host',
action='store', dest='admin_host', default='localhost',
help='')
parser.add_option('--admin-port',
action='store', dest='admin_port', default=15672,
help='')
parser.add_option('--stats',
action='store', dest='stats', default='nodes,queues,exchanges',
help='csv of which stats to emit, choies: nodes, queues')
parser.add_option('--vhosts',
action='store', dest='vhosts', default='/',
help='csv of vhosts')
parser.add_option('--list-only',
action='store_true', dest='list_only', default='defualt',
help='List known queues etc instead of printing values in a loop')
parser.add_option('--log',
action='store', dest='log', default='stderr', choices=['stderr', 'syslog', 'both'],
help='log to stderr and/or syslog')
parser.add_option('--log-level',
action='store', dest='log_level', default='WARNING',
choices=['CRITICAL', 'ERROR', 'WARNING', 'INFO', 'DEBUG', 'NOTSET'],
help='log to stderr and/or syslog')
parser.add_option('--log-facility',
action='store', dest='log_facility', default='user',
help='facility to use when using syslog')
return parser.parse_args(argv)
def main(argv):
""" used for testing """
(opts, args) = parse_args(argv)
setup_logging(opts.log, opts.log_facility, opts.log_level)
# in config files we use '/' in vhosts names but we should convert '/' to '-' when calculating a metric
parameters = {"vhost": "/", "username": "guest", "password": "guest", "metric_group": "rabbitmq",
"zero_rates_when_idle": "yes",
"host": opts.admin_host, "port": opts.admin_port,
"stats": opts.stats.split(','),
"vhosts": opts.vhosts.split(',')}
descriptors = metric_init(parameters)
result = refreshStats(stats=parameters['stats'], vhosts=parameters['vhosts'])
print '***' * 20
if opts.list_only is True:
print 'nodes:'
pprint.pprint(list_nodes())
print 'exchanges:'
for vhost in parameters['vhosts']:
print 'vhost: %s' % vhost
pprint.pprint(list_exchanges(vhost))
print 'queues:'
for vhost in parameters['vhosts']:
print 'vhost: %s' % vhost
pprint.pprint(list_queues(vhost))
return
try:
while True:
for d in descriptors:
v = d['call_back'](d['name'])
if v is None:
print 'got None for %s' % d['name']
else:
print 'value for %s is %r' % (d['name'], v)
time.sleep(5)
print '----------------------------'
except KeyboardInterrupt:
log.debug('KeyboardInterrupt, shutting down...')
metric_cleanup()
if __name__ == "__main__":
main(sys.argv[1:])