check_activemq.py

#!/usr/bin/env python
# -*- coding: utf-8 *-*

"""	Copyright 2015 predic8 GmbH, www.predic8.com

	Licensed under the Apache License, Version 2.0 (the "License");
	you may not use this file except in compliance with the License.
	You may obtain a copy of the License at

	http://www.apache.org/licenses/LICENSE-2.0

	Unless required by applicable law or agreed to in writing, software
	distributed under the License is distributed on an "AS IS" BASIS,
	WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	See the License for the specific language governing permissions and
	limitations under the License. """

""" Project Home: https://github.com/predic8/activemq-nagios-plugin """

import os
import os.path as path
import urllib
import json
import argparse
import fnmatch
import nagiosplugin as np

PLUGIN_VERSION = "0.7.2"

PREFIX = 'org.apache.activemq:'

def make_url(args, dest):
	return (
		(args.jolokia_url + ('' if args.jolokia_url[-1] == '/' else '/') + dest)
		if args.jolokia_url
		else ('http://'+args.user+':'+args.pwd
			+'@'+args.host+':'+str(args.port)
			+'/'+args.url_tail+'/'+dest)
	)

def query_url(args, dest=''):
	return make_url(args, PREFIX + 'type=Broker,brokerName=localhost'+dest)

def queue_url(args, queue):
	return query_url(args, ',destinationType=Queue,destinationName='+urllib.quote(queue))

def topic_url(args, topic):
	return query_url(args, ',destinationType=Topic,destinationName='+urllib.quote(topic))

def health_url(args):
	return query_url(args, ',service=Health')

def loadJson(srcurl):
	jsn = urllib.urlopen(srcurl)
	return json.loads(jsn.read())





def queuesize(args):

	class ActiveMqQueueSizeContext(np.ScalarContext):
		def evaluate(self, metric, resource):
			if metric.value < 0:
				return self.result_cls(np.Unknown, metric=metric)

			if metric.value >= self.critical.end:
				return self.result_cls(np.Critical, ActiveMqQueueSizeContext.fmt_violation(self.critical.end), metric)

			if metric.value >= self.warning.end:
				return self.result_cls(np.Warn, ActiveMqQueueSizeContext.fmt_violation(self.warning.end), metric)

			return self.result_cls(np.Ok, None, metric)

		def describe(self, metric):
			if metric.value < 0:
				return 'ERROR: ' + metric.name
			return super(ActiveMqQueueSizeContext, self).describe(metric)

		@staticmethod
		def fmt_violation(max_value):
			return 'Queue size is greater than or equal to %d' % max_value

	class ActiveMqQueueSize(np.Resource):
		def __init__(self, pattern=None):
			self.pattern = pattern
		def probe(self):
			try:
				for queue in loadJson(query_url(args))['value']['Queues']:
					qJ = loadJson(make_url(args, queue['objectName']))['value']

					if (self.pattern
							and fnmatch.fnmatch(qJ['Name'], self.pattern)
							or not self.pattern):
						yield np.Metric('Queue Size of %s' % qJ['Name'],
						                qJ['QueueSize'], min=0, context='size')
			except IOError as e:
				yield np.Metric('Fetching network FAILED: ' + str(e), -1, context='size')
			except ValueError as e:
				yield np.Metric('Decoding Json FAILED: ' + str(e), -1, context='size')
			except KeyError as e:
				yield np.Metric('Getting Queue(s) FAILED: ' + str(e), -1, context='size')

	class ActiveMqQueueSizeSummary(np.Summary):
		def ok(self, results):
			if len(results) > 1:
				lenQ = str(len(results))
				minQ = str(min([r.metric.value for r in results]))
				avgQ = str(sum([r.metric.value for r in results]) / len(results))
				maxQ = str(max([r.metric.value for r in results]))
				return ('Checked ' + lenQ + ' queues with lengths min/avg/max = '
						+ '/'.join([minQ, avgQ, maxQ]))
			else:
				return super(ActiveMqQueueSizeSummary, self).ok(results)

	np.Check(
		ActiveMqQueueSize(args.queue) if args.queue else ActiveMqQueueSize(),
		ActiveMqQueueSizeContext('size', args.warn, args.crit),
		ActiveMqQueueSizeSummary()
	).main(timeout=get_timeout())


# when debugging the application, set the TIMEOUT env variable to 0 to disable the timeout during check execution
def get_timeout():
	return int(os.environ.get('TIMEOUT')) if 'TIMEOUT' in os.environ else 10

def health(args):

	class ActiveMqHealthContext(np.Context):
		def evaluate(self, metric, resource):
			if metric.value < 0:
				return self.result_cls(np.Unknown, metric=metric)
			if metric.value == "Good":
				return self.result_cls(np.Ok, metric=metric)
			else:
				return self.result_cls(np.Warn, metric=metric)
		def describe(self, metric):
			if metric.value < 0:
				return 'ERROR: ' + metric.name
			return metric.name + ' ' + metric.value

	class ActiveMqHealth(np.Resource):
		def probe(self):
			try:
				status = loadJson(health_url(args))['value']['CurrentStatus']
				return np.Metric('CurrentStatus', status, context='health')
			except IOError as e:
				return np.Metric('Fetching network FAILED: ' + str(e), -1, context='health')
			except ValueError as e:
				return np.Metric('Decoding Json FAILED: ' + str(e), -1, context='health')
			except KeyError as e:
				return np.Metric('Getting Values FAILED: ' + str(e), -1, context='health')

	np.Check(
		ActiveMqHealth(), ## check ONE queue
		ActiveMqHealthContext('health')
	).main(timeout=get_timeout())


def subscriber(args):
	""" There are several internal error codes for the subscriber module:
	    -1   Miscellaneous Error (network, json, key value)
	    -2   Topic Name is invalid / doesn't exist
	    -3   Topic has no Subscribers
	    -4   Client ID is invalid / doesn't exist
	    True/False aren't error codes, but the result whether clientId is an
	    active subscriber of topic.
	"""

	class ActiveMqSubscriberContext(np.Context):
		def evaluate(self, metric, resource):
			if metric.value == -1: # Network or JSON Error
				return self.result_cls(np.Unknown, metric=metric)
			elif metric.value == -2: # Topic doesn't exist
				return self.result_cls(np.Critical, metric=metric)
			elif metric.value == -3: # Topic has no subscribers
				return self.result_cls(np.Critical, metric=metric)
			elif metric.value == -4: # Client invalid
				return self.result_cls(np.Critical, metric=metric)
			elif metric.value == True:
				return self.result_cls(np.Ok, metric=metric)
			elif metric.value == False:
				return self.result_cls(np.Warn, metric=metric)
			else: ###
				return self.result_cls(np.Critical, metric=metric)
		def describe(self, metric):
			if metric.value == -1:
				return 'ERROR: ' + metric.name
			elif metric.value == -2:
				return 'Topic ' + args.topic + ' IS INVALID / DOES NOT EXIST'
			elif metric.value == -3:
				return 'Topic ' + args.topic + ' HAS NO SUBSCRIBERS'
			elif metric.value == -4:
				return 'Subscriber ID ' + args.clientId + ' IS INVALID / DOES NOT EXIST'
			return ('Client ' + args.clientId + ' is an '
			        + ('active' if metric.value == True else 'INACTIVE')
			        + ' subscriber of Topic ' + args.topic)

	class ActiveMqSubscriber(np.Resource):
		def probe(self):
			try:
				resp = loadJson(topic_url(args, args.topic))

				if resp['status'] != 200: # None -> Topic doesn't exist
					return np.Metric('subscription', -2, context='subscriber')

				subs = resp['value']['Subscriptions'] # Subscriptions for Topic

				def client_is_active_subscriber(subscription):
					subUrl = make_url(args, urllib.quote(subscription['objectName']))
					subResp = loadJson(subUrl) # get the subscription

					if subResp['value']['DestinationName'] != args.topic: # should always hold
						return -2 # Topic is invalid / doesn't exist
					if subResp['value']['ClientId'] != args.clientId: # subscriber ID check
						return -4 # clientId invalid
					return subResp['value']['Active'] # subscribtion active?

				# check if clientId is among the subscribers
				analyze = [client_is_active_subscriber(s) for s in subs]
				if not analyze:
					return np.Metric('subscription', -3, context='subscriber')
				if -2 in analyze: # should never occur, just for safety
					return np.Metric('subscription', -2, context='subscriber')
				elif True in analyze: # active subscriber
					return np.Metric('subscription', True, context='subscriber')
				elif False in analyze: # INACTIVE subscriber
					return np.Metric('subscription', False, context='subscriber')
				elif -4 in analyze: # all clients failed
					return np.Metric('subscription', -4, context='subscriber')

			except IOError as e:
				return np.Metric('Fetching network FAILED: ' + str(e), -1, context='subscriber')
			except ValueError as e:
				return np.Metric('Decoding Json FAILED: ' + str(e), -1, context='subscriber')
			except KeyError as e:
				return np.Metric('Getting Values FAILED: ' + str(e), -1, context='subscriber')

	np.Check(
		ActiveMqSubscriber(),
		ActiveMqSubscriberContext('subscriber')
	).main(timeout=get_timeout())


def exists(args):

	class ActiveMqExistsContext(np.Context):
		def evaluate(self, metric, resource):
			if metric.value < 0:
				return self.result_cls(np.Unknown, metric=metric)
			if metric.value > 0:
				return self.result_cls(np.Ok, metric=metric)
			return self.result_cls(np.Critical, metric=metric)
		def describe(self, metric):
			if metric.value < 0:
				return 'ERROR: ' + metric.name
			if metric.value == 0:
				return 'Neither Queue nor Topic with name ' + args.name + ' were found!'
			if metric.value == 1:
				return 'Found Queue with name ' + args.name
			if metric.value == 2:
				return 'Found Topic with name ' + args.name
			return super(ActiveMqExistsContext, self).describe(metric)

	class ActiveMqExists(np.Resource):
		def probe(self):
			try:
				respQ = loadJson(queue_url(args, args.name))
				if respQ['status'] == 200:
					return np.Metric('exists', 1, context='exists')

				respT = loadJson(topic_url(args, args.name))
				if respT['status'] == 200:
					return np.Metric('exists', 2, context='exists')

				return np.Metric('exists', 0, context='exists')

			except IOError as e:
				return np.Metric('Network fetching FAILED: ' + str(e), -1, context='exists')
			except ValueError as e:
				return np.Metric('Decoding Json FAILED: ' + str(e), -1, context='exists')
			except KeyError as e:
				return np.Metric('Getting Queue(s) FAILED: ' + str(e), -1, context='exists')

	np.Check(
		ActiveMqExists(),
		ActiveMqExistsContext('exists')
	).main(timeout=get_timeout())


def subscriber_pending(args):
	""" Mix from queuesize and subscriber check.
	    Check that the given clientId is a subscriber of the given Topic.
		Also check
	"""

	class ActiveMqSubscriberPendingContext(np.ScalarContext):
		def evaluate(self, metric, resource):
			if metric.value < 0:
				return self.result_cls(np.Critical, metric=metric)
			return super(ActiveMqSubscriberPendingContext, self).evaluate(metric, resource)
		def describe(self, metric):
			if metric.value < 0:
				return 'ERROR: ' + metric.name
			return super(ActiveMqSubscriberPendingContext, self).describe(metric)

	class ActiveMqSubscriberPending(np.Resource):
		def probe(self):
			try:
				resp = loadJson(query_url(args))
				subs = (resp['value']['TopicSubscribers'] +
				        resp['value']['InactiveDurableTopicSubscribers'])
				for sub in subs:
					qJ = loadJson(make_url(args, sub['objectName']))['value']
					if not qJ['SubscriptionName'] == args.subscription:
						continue # skip subscriber
					if not qJ['ClientId'] == args.clientId:
						# When this if is entered, we have found the correct
						# subscription, but the clientId doesn't match
						return np.Metric('ClientId error: Expected: %s. Got: %s'
						                  % (args.clientId, qJ['ClientId']),
						                 -1, context='subscriber_pending')
					return np.Metric('Pending Messages for %s' % qJ['SubscriptionName'],
					                 qJ['PendingQueueSize'], min=0,
					                 context='subscriber_pending')
			except IOError as e:
				return np.Metric('Fetching network FAILED: ' + str(e), -1, context='subscriber_pending')
			except ValueError as e:
				return np.Metric('Decoding Json FAILED: ' + str(e), -1, context='subscriber_pending')
			except KeyError as e:
				return np.Metric('Getting Subscriber FAILED: ' + str(e), -1, context='subscriber_pending')

	np.Check(
		ActiveMqSubscriberPending(),
		ActiveMqSubscriberPendingContext('subscriber_pending', args.warn, args.crit),
	).main(timeout=get_timeout())


def dlq(args):

	class ActiveMqDlqScalarContext(np.ScalarContext):
		def evaluate(self, metric, resource):
			if metric.value > 0:
				return self.result_cls(np.Critical, metric=metric)
			else:
				return self.result_cls(np.Ok, metric=metric)

	class ActiveMqDlq(np.Resource):
		def __init__(self, prefix, cachedir):
			super(ActiveMqDlq, self).__init__()
			self.cache = None
			self.cachedir = path.join(path.expanduser(cachedir), 'activemq-nagios-plugin')
			self.cachefile = path.join(self.cachedir, 'dlq-cache.json')
			self.parse_cache()
			self.prefix = prefix
		def parse_cache(self): # deserialize
			if not os.path.exists(self.cachefile):
				self.cache = {}
			else:
				with open(self.cachefile, 'r') as cachefile:
					self.cache = json.load(cachefile)
		def write_cache(self): # serialize
			if not os.path.exists(self.cachedir):
				os.makedirs(self.cachedir)
			with open(self.cachefile, 'w') as cachefile:
				json.dump(self.cache, cachefile)
		def probe(self):
			try:
				for queue in loadJson(query_url(args))['value']['Queues']:
					qJ = loadJson(make_url(args, queue['objectName']))['value']
					if qJ['Name'].startswith(self.prefix):
						oldcount = self.cache.get(qJ['Name'])

						if oldcount == None:
							more = 0
							msg = 'First check for DLQ'
						else:
							assert isinstance(oldcount, int)
							more = qJ['QueueSize'] - oldcount
							if more == 0:
								msg = 'No additional messages in'
							elif more > 0:
								msg = 'More messages in'
							else: # more < 0
								msg = 'Less messages in'
						self.cache[qJ['Name']] = qJ['QueueSize']
						self.write_cache()
						yield np.Metric(msg + ' %s' % qJ['Name'],
										more, context='dlq')
			except IOError as e:
				yield np.Metric('Fetching network FAILED: ' + str(e), -1, context='dlq')
			except ValueError as e:
				yield np.Metric('Decoding Json FAILED: ' + str(e), -1, context='dlq')
			except KeyError as e:
				yield np.Metric('Getting Queue(s) FAILED: ' + str(e), -1, context='dlq')

	class ActiveMqDlqSummary(np.Summary):
		def ok(self, results):
			if len(results) > 1:
				lenQ = str(len(results))
				bigger = str(len([r.metric.value for r in results if r.metric.value > 0]))
				return ('Checked ' + lenQ + ' DLQs of which ' + bigger + ' contain additional messages.')
			else:
				return super(ActiveMqDlqSummary, self).ok(results)

	np.Check(
		ActiveMqDlq(args.prefix, args.cachedir),
		ActiveMqDlqScalarContext('dlq'),
		ActiveMqDlqSummary()
	).main(timeout=get_timeout())





def add_warn_crit(parser, what):
	parser.add_argument('-w', '--warn',
		metavar='WARN', type=int, default=10,
		help='Warning if ' + what + ' is greater than or equal to. (default: %(default)s)')
	parser.add_argument('-c', '--crit',
		metavar='CRIT', type=int, default=100,
		help='Warning if ' + what + ' is greater than or equal to. (default: %(default)s)')





@np.guarded
def main():

	# Top-level Argument Parser & Subparsers Initialization
	parser = argparse.ArgumentParser(description=__doc__)

	parser.add_argument('-v', '--version', action='version',
		help='Print version number',
		version='%(prog)s version ' + str(PLUGIN_VERSION)
	)

	connection = parser.add_argument_group('Connection')
	connection.add_argument('--host', default='localhost',
		help='ActiveMQ Server Hostname (default: %(default)s)')
	connection.add_argument('--port', type=int, default=8161,
		help='ActiveMQ Server Port (default: %(default)s)')
	connection.add_argument('--url-tail',
		default='api/jolokia/read',
		#default='hawtio/jolokia/read',
		help='Jolokia URL tail part. (default: %(default)s)')
	connection.add_argument('-j', '--jolokia-url',
		help='''Override complete Jolokia URL.
		        (Default: "http://USER:PWD@HOST:PORT/URLTAIL/").
		        The parameters --user, --pwd, --host and --port are IGNORED
		        if this paramter is specified!
		        Please set this parameter carefully as it essential
		        for the program to work properly and is not validated.''')

	credentials = parser.add_argument_group('Credentials')
	credentials.add_argument('-u', '--user', default='admin',
		help='Username for ActiveMQ admin account. (default: %(default)s)')
	credentials.add_argument('-p', '--pwd', default='admin',
		help='Password for ActiveMQ admin account. (default: %(default)s)')

	subparsers = parser.add_subparsers()

	# Sub-Parser for queuesize
	parser_queuesize = subparsers.add_parser('queuesize',
		help="""Check QueueSize: This mode checks the queue size of one
		        or more queues on the ActiveMQ server.
		        You can specify a queue name to check (even a pattern);
		        see description of the 'queue' paramter for details.""")
	add_warn_crit(parser_queuesize, 'Queue Size')
	parser_queuesize.add_argument('queue', nargs='?',
		help='''Name of the Queue that will be checked.
		        If left empty, all Queues will be checked.
		        This also can be a Unix shell-style Wildcard
		        (much less powerful than a RegEx)
		        where * and ? can be used.''')
	parser_queuesize.set_defaults(func=queuesize)

	# Sub-Parser for health
	parser_health = subparsers.add_parser('health',
		help="""Check Health: This mode checks if the current status is 'Good'.""")
	# no additional arguments necessary
	parser_health.set_defaults(func=health)

	# Sub-Parser for subscriber
	parser_subscriber = subparsers.add_parser('subscriber',
		help="""Check Subscriber: This mode checks if the given 'clientId'
		        is a subscriber of the specified 'topic'.""")
	parser_subscriber.add_argument('--clientId', required=True,
		help='Client ID of the client that will be checked')
	parser_subscriber.add_argument('--topic', required=True,
		help='Name of the Topic that will be checked.')
	parser_subscriber.set_defaults(func=subscriber)

	# Sub-Parser for exists
	parser_exists = subparsers.add_parser('exists',
		help="""Check Exists: This mode checks if a Queue or Topic with the
		        given name exists.
		        If either a Queue or a Topic with this name exist,
				this mode yields OK.""")
	parser_exists.add_argument('--name', required=True,
		help='Name of the Queue or Topic that will be checked.')
	parser_exists.set_defaults(func=exists)

	# Sub-Parser for queuesize-subscriber
	parser_subscriber_pending = subparsers.add_parser('subscriber-pending',
		help="""Check Subscriber-Pending:
		        This mode checks that the given subscriber doesn't have
		        too many pending messages (specified with -w and -c)
		        and that the given clientId the Id that is involved in
		        the subscription.""")
	parser_subscriber_pending.add_argument('--subscription', required=True,
		help='Name of the subscription thath will be checked.')
	parser_subscriber_pending.add_argument('--clientId', required=True,
		help='The ID of the client that is involved in the specified subscription.')
	add_warn_crit(parser_subscriber_pending, 'Pending Messages')
	parser_subscriber_pending.set_defaults(func=subscriber_pending)

	# Sub-Parser for dlq
	parser_dlq = subparsers.add_parser('dlq',
		help="""Check DLQ (Dead Letter Queue):
		        This mode checks if there are new messages in DLQs
		        with the specified prefix.""")
	parser_dlq.add_argument('--prefix', #required=False,
		default='ActiveMQ.DLQ.',
		help='DLQ prefix to check. (default: %(default)s)')
	parser_dlq.add_argument('--cachedir', #required=False,
		default='~/.cache', 
		help='DLQ cache base directory. (default: %(default)s)')
	add_warn_crit(parser_dlq, 'DLQ Queue Size')
	parser_dlq.set_defaults(func=dlq)

	# Evaluate Arguments
	args = parser.parse_args()
	# call the determined function with the parsed arguments
	args.func(args)

if __name__ == '__main__':
	main()