diff --git a/README.md b/README.md index 63c06c5..b021554 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,8 @@ This is a generic plugin for Nagios which checks json values from a given HTTP e Executing `./check_http_json.py -h` will yield the following details: ``` -usage: check_http_json.py [-h] [-d] [-s] -H HOST [-P PORT] [-p PATH] +usage: check_http_json.py [-h] [-d] [-s] -H HOST [-k] [-V] [--cacert CACERT] + [--cert CERT] [--key KEY] [-P PORT] [-p PATH] [-t TIMEOUT] [-B AUTH] [-D DATA] [-A HEADERS] [-f SEPARATOR] [-w [KEY_THRESHOLD_WARNING [KEY_THRESHOLD_WARNING ...]]] @@ -24,19 +25,31 @@ usage: check_http_json.py [-h] [-d] [-s] -H HOST [-P PORT] [-p PATH] [-E [KEY_LIST_CRITICAL [KEY_LIST_CRITICAL ...]]] [-q [KEY_VALUE_LIST [KEY_VALUE_LIST ...]]] [-Q [KEY_VALUE_LIST_CRITICAL [KEY_VALUE_LIST_CRITICAL ...]]] + [-u [KEY_VALUE_LIST_UNKNOWN [KEY_VALUE_LIST_UNKNOWN ...]]] + [-y [KEY_VALUE_LIST_NOT [KEY_VALUE_LIST_NOT ...]]] + [-Y [KEY_VALUE_LIST_NOT_CRITICAL [KEY_VALUE_LIST_NOT_CRITICAL ...]]] [-m [METRIC_LIST [METRIC_LIST ...]]] -Nagios plugin which checks json values from a given endpoint against argument -specified rules and determines the status and performance data for that -service +Check HTTP JSON Nagios Plugin + +Generic Nagios plugin which checks json values from a given endpoint against +argument specified rules and determines the status and performance data for +that service. + +Version: 1.4.0 (2019-05-09) optional arguments: -h, --help show this help message and exit - -d, --debug Debug mode. - -s, --ssl HTTPS mode. - -H HOST, --host HOST Host. + -d, --debug debug mode + -s, --ssl use TLS to connect to remote host + -H HOST, --host HOST remote host to query + -k, --insecure do not check server SSL certificate + -V, --version print version of this plugin + --cacert CACERT SSL CA certificate + --cert CERT SSL client certificate + --key KEY SSL client key ( if not bundled into the cert ) -P PORT, --port PORT TCP port - -p PATH, --path PATH Path. + -p PATH, --path PATH Path -t TIMEOUT, --timeout TIMEOUT Connection timeout (seconds) -B AUTH, --basic-auth AUTH @@ -45,7 +58,7 @@ optional arguments: -A HEADERS, --headers HEADERS The http headers in JSON format. -f SEPARATOR, --field_separator SEPARATOR - Json Field separator, defaults to "." ; Select element + JSON Field separator, defaults to "."; Select element in an array with "(" ")" -w [KEY_THRESHOLD_WARNING [KEY_THRESHOLD_WARNING ...]], --warning [KEY_THRESHOLD_WARNING [KEY_THRESHOLD_WARNING ...]] Warning threshold for these values @@ -72,15 +85,26 @@ optional arguments: -Q [KEY_VALUE_LIST_CRITICAL [KEY_VALUE_LIST_CRITICAL ...]], --key_equals_critical [KEY_VALUE_LIST_CRITICAL [KEY_VALUE_LIST_CRITICAL ...]] Same as -q but return critical if equality check fails. + -u [KEY_VALUE_LIST_UNKNOWN [KEY_VALUE_LIST_UNKNOWN ...]], --key_equals_unknown [KEY_VALUE_LIST_UNKNOWN [KEY_VALUE_LIST_UNKNOWN ...]] + Same as -q but return unknown if equality check fails. + -y [KEY_VALUE_LIST_NOT [KEY_VALUE_LIST_NOT ...]], --key_not_equals [KEY_VALUE_LIST_NOT [KEY_VALUE_LIST_NOT ...]] + Checks equality of these keys and values + (key[>alias],value key2,value2) to determine status. + Multiple key values can be delimited with colon + (key,value1:value2). Return warning if equality check + succeeds + -Y [KEY_VALUE_LIST_NOT_CRITICAL [KEY_VALUE_LIST_NOT_CRITICAL ...]], --key_not_equals_critical [KEY_VALUE_LIST_NOT_CRITICAL [KEY_VALUE_LIST_NOT_CRITICAL ...]] + Same as -q but return critical if equality check + succeeds. -m [METRIC_LIST [METRIC_LIST ...]], --key_metric [METRIC_LIST [METRIC_LIST ...]] - Gathers the values of these keys (key[>alias],UnitOfMe - asure,WarnRange,CriticalRange,Min,Max) for Nagios - performance data. More information about Range format - and units of measure for nagios can be found at + Gathers the values of these keys (key[>alias], + UnitOfMeasure,WarnRange,CriticalRange,Min,Max) for + Nagios performance data. More information about Range + format and units of measure for nagios can be found at nagios-plugins.org/doc/guidelines.html Additional formats for this parameter are: (key[>alias]), (key[>alias],UnitOfMeasure), - (key[>alias],UnitOfMeasure,WarnRange,CriticalRange). + (key[>alias],UnitOfMeasure,WarnRange, CriticalRange). ``` ## Examples @@ -142,7 +166,7 @@ optional arguments: * **Warning:** `./check_http_json.py -H : -p -w "metric,RANGE"` * **Critical:** `./check_http_json.py -H : -p -c "metric,RANGE"` * **Metrics with Warning:** `./check_http_json.py -H : -p -w "metric,RANGE"` -* **Metris with Critical:** +* **Metrics with Critical:** ./check_http_json.py -H : -p -w "metric,,,RANGE" ./check_http_json.py -H : -p -w "metric,,,,MIN,MAX" @@ -159,7 +183,7 @@ optional arguments: More info about Nagios Range format and Units of Measure can be found at [https://nagios-plugins.org/doc/guidelines.html](https://nagios-plugins.org/doc/guidelines.html). -#### Using Headers +#### Using Headers * `./check_http_json.py -H : -p -A '{"content-type": "application/json"}' -w "metric,RANGE"` @@ -167,7 +191,7 @@ More info about Nagios Range format and Units of Measure can be found at [https: ### Requirements -* Python +* Python 2.7 ### Configuration diff --git a/check_http_json.py b/check_http_json.py index dac67ec..c5b7960 100755 --- a/check_http_json.py +++ b/check_http_json.py @@ -1,39 +1,48 @@ -#!/usr/bin/python +#!/usr/bin/python2.7 +plugin_description = \ """ Check HTTP JSON Nagios Plugin -Generic Nagios plugin which checks json values from a given endpoint against argument specified rules -and determines the status and performance data for that service. +Generic Nagios plugin which checks json values from a given endpoint against +argument specified rules and determines the status and performance data for +that service. """ -import httplib, urllib, urllib2, base64 +import urllib2 +import base64 import json import argparse import sys +import ssl from pprint import pprint from urllib2 import HTTPError from urllib2 import URLError -# TEST = False - - OK_CODE = 0 WARNING_CODE = 1 CRITICAL_CODE = 2 UNKNOWN_CODE = 3 +__version__ = '1.4.0' +__version_date__ = '2019-05-09' + class NagiosHelper: """Help with Nagios specific status string formatting.""" - message_prefixes = {OK_CODE: 'OK', WARNING_CODE: 'WARNING', CRITICAL_CODE: 'CRITICAL', UNKNOWN_CODE: 'UNKNOWN'} + message_prefixes = {OK_CODE: 'OK', + WARNING_CODE: 'WARNING', + CRITICAL_CODE: 'CRITICAL', + UNKNOWN_CODE: 'UNKNOWN'} performance_data = '' warning_message = '' critical_message = '' unknown_message = '' def getMessage(self): - """Build a status-prefixed message with optional performance data generated externally""" - text = "%s: Status %s." % (self.message_prefixes[self.getCode()], self.message_prefixes[self.getCode()]) + """Build a status-prefixed message with optional performance data + generated externally""" + text = "%s: Status %s." % (self.message_prefixes[self.getCode()], + self.message_prefixes[self.getCode()]) text += self.warning_message text += self.critical_message text += self.unknown_message @@ -53,17 +62,23 @@ class NagiosHelper: def append_warning(self, warning_message): self.warning_message += warning_message + def append_critical(self, critical_message): self.critical_message += critical_message + def append_unknown(self, unknown_message): self.unknown_message += unknown_message - def append_metrics(self, (performance_data, warning_message, critical_message)): + + def append_metrics(self, (performance_data, + warning_message, critical_message)): self.performance_data += performance_data self.append_warning(warning_message) self.append_critical(critical_message) + class JsonHelper: - """Perform simple comparison operations against values in a given JSON dict""" + """Perform simple comparison operations against values in a given + JSON dict""" def __init__(self, json_data, separator): self.data = json_data self.separator = separator @@ -81,7 +96,8 @@ class JsonHelper: def getSubArrayElement(self, key, data): subElemKey = key[:key.find(self.arrayOpener)] - index = int(key[key.find(self.arrayOpener) + 1:key.find(self.arrayCloser)]) + index = int(key[key.find(self.arrayOpener) + + 1:key.find(self.arrayCloser)]) remainingKey = key[key.find(self.arrayCloser + self.separator) + 2:] if key.find(self.arrayCloser + self.separator) == -1: remainingKey = key[key.find(self.arrayCloser) + 1:] @@ -96,30 +112,45 @@ class JsonHelper: else: return (None, 'not_found') - def equals(self, key, value): return self.exists(key) and str(self.get(key)) in value.split(':') - def lte(self, key, value): return self.exists(key) and float(self.get(key)) <= float(value) - def lt(self, key, value): return self.exists(key) and float(self.get(key)) < float(value) - def gte(self, key, value): return self.exists(key) and float(self.get(key)) >= float(value) - def gt(self, key, value): return self.exists(key) and float(self.get(key)) > float(value) - def exists(self, key): return (self.get(key) != (None, 'not_found')) + def equals(self, key, value): + return self.exists(key) and \ + str(self.get(key)) in value.split(':') + + def lte(self, key, value): + return self.exists(key) and float(self.get(key)) <= float(value) + + def lt(self, key, value): + return self.exists(key) and float(self.get(key)) < float(value) + + def gte(self, key, value): + return self.exists(key) and float(self.get(key)) >= float(value) + + def gt(self, key, value): + return self.exists(key) and float(self.get(key)) > float(value) + + def exists(self, key): + return (self.get(key) != (None, 'not_found')) + def get(self, key, temp_data=''): - """Can navigate nested json keys with a dot format (Element.Key.NestedKey). Returns (None, 'not_found') if not found""" + """Can navigate nested json keys with a dot format + (Element.Key.NestedKey). Returns (None, 'not_found') if not found""" if temp_data: data = temp_data else: data = self.data if len(key) <= 0: return data - if key.find(self.separator) != -1 and key.find(self.arrayOpener) != -1 : - if key.find(self.separator) < key.find(self.arrayOpener) : + if key.find(self.separator) != -1 and \ + key.find(self.arrayOpener) != -1: + if key.find(self.separator) < key.find(self.arrayOpener): return self.getSubElement(key, data) else: return self.getSubArrayElement(key, data) else: - if key.find(self.separator) != -1 : + if key.find(self.separator) != -1: return self.getSubElement(key, data) else: - if key.find(self.arrayOpener) != -1 : + if key.find(self.arrayOpener) != -1: return self.getSubArrayElement(key, data) else: if key in data: @@ -127,6 +158,29 @@ class JsonHelper: else: return (None, 'not_found') + def expandKey(self, key, keys): + if '(*)' not in key: + keys.append(key) + return keys + subElemKey = '' + if key.find('(*)') > 0: + subElemKey = key[:key.find('(*)')-1] + remainingKey = key[key.find('(*)')+3:] + elemData = self.get(subElemKey) + if elemData is (None, 'not_found'): + keys.append(key) + return keys + if subElemKey is not '': + subElemKey = subElemKey + '.' + for i in range(len(elemData)): + newKey = subElemKey + '(' + str(i) + ')' + remainingKey + newKeys = self.expandKey(newKey, []) + for j in newKeys: + keys.append(j) + + return keys + + def _getKeyAlias(original_key): key = original_key alias = original_key @@ -136,22 +190,51 @@ def _getKeyAlias(original_key): key, alias = keys return key, alias + class JsonRuleProcessor: - """Perform checks and gather values from a JSON dict given rules and metrics definitions""" + """Perform checks and gather values from a JSON dict given rules + and metrics definitions""" def __init__(self, json_data, rules_args): self.data = json_data self.rules = rules_args separator = '.' - if self.rules.separator: separator = self.rules.separator + if self.rules.separator: + separator = self.rules.separator self.helper = JsonHelper(self.data, separator) debugPrint(rules_args.debug, "rules:%s" % rules_args) debugPrint(rules_args.debug, "separator:%s" % separator) + self.metric_list = self.expandKeys(self.rules.metric_list) + self.key_threshold_warning = self.expandKeys( + self.rules.key_threshold_warning) + self.key_threshold_critical = self.expandKeys( + self.rules.key_threshold_critical) + self.key_value_list = self.expandKeys(self.rules.key_value_list) + self.key_value_list_not = self.expandKeys( + self.rules.key_value_list_not) + self.key_list = self.expandKeys(self.rules.key_list) + self.key_value_list_critical = self.expandKeys( + self.rules.key_value_list_critical) + self.key_value_list_not_critical = self.expandKeys( + self.rules.key_value_list_not_critical) + self.key_list_critical = self.expandKeys(self.rules.key_list_critical) + self.key_value_list_unknown = self.expandKeys( + self.rules.key_value_list_unknown) + + def expandKeys(self, src): + if src is None: + return + dest = [] + for key in src: + newKeys = self.helper.expandKey(key, []) + for k in newKeys: + dest.append(k) + return dest def checkExists(self, exists_list): failure = '' for k in exists_list: key, alias = _getKeyAlias(k) - if (self.helper.exists(key) == False): + if (self.helper.exists(key) is False): failure += " Key %s did not exist." % alias return failure @@ -161,7 +244,18 @@ class JsonRuleProcessor: k, v = kv.split(',') key, alias = _getKeyAlias(k) if (self.helper.equals(key, v) == False): - failure += " Value for key %s did not match %s." % (alias, v) + failure += " Key %s mismatch. %s != %s" % (alias, v, + self.helper.get(key)) + return failure + + def checkNonEquality(self, equality_list): + failure = '' + for kv in equality_list: + k, v = kv.split(',') + key, alias = _getKeyAlias(k) + if (self.helper.equals(key, v) == True): + failure += " Key %s match found. %s == %s" % (alias, v, + self.helper.get(key)) return failure def checkThreshold(self, key, alias, r): @@ -181,19 +275,28 @@ class JsonRuleProcessor: end = vals[1] if(start == '~'): if (invert and self.helper.lte(key, end)): - failure += " Value for key %s was less than or equal to %s." % (alias, end) + failure += " Value (%s) for key %s was less than or equal to %s." % \ + (self.helper.get(key), alias, end) elif (not invert and self.helper.gt(key, end)): - failure += " Value for key %s was greater than %s." % (alias, end) + failure += " Value (%s) for key %s was greater than %s." % \ + (self.helper.get(key), alias, end) elif(end == 'infinity'): if (invert and self.helper.gte(key, start)): - failure += " Value for key %s was greater than or equal to %s." % (alias, start) + failure += " Value (%s) for key %s was greater than or equal to %s." % \ + (self.helper.get(key), alias, start) elif (not invert and self.helper.lt(key, start)): - failure += " Value for key %s was less than %s." % (alias, start) + failure += " Value (%s) for key %s was less than %s." % \ + (self.helper.get(key), alias, start) else: - if (invert and self.helper.gte(key, start) and self.helper.lte(key, end)): - failure += " Value for key %s was inside the range %s:%s." % (alias, start, end) - elif (not invert and (self.helper.lt(key, start) or self.helper.gt(key, end))): - failure += " Value for key %s was outside the range %s:%s." % (alias, start, end) + if (invert and self.helper.gte(key, start) and + self.helper.lte(key, end)): + failure += " Value (%s) for key %s was inside the range %s:%s." % \ + (self.helper.get(key), alias, start, end) + elif (not invert and (self.helper.lt(key, start) or + self.helper.gt(key, end))): + failure += " Value (%s) for key %s was outside the range %s:%s." % \ + (self.helper.get(key), alias, start, end) + return failure def checkThresholds(self, threshold_list): @@ -206,127 +309,236 @@ class JsonRuleProcessor: def checkWarning(self): failure = '' - if self.rules.key_threshold_warning != None: - failure += self.checkThresholds(self.rules.key_threshold_warning) - if self.rules.key_value_list != None: - failure += self.checkEquality(self.rules.key_value_list) - if self.rules.key_list != None: - failure += self.checkExists(self.rules.key_list) + if self.key_threshold_warning is not None: + failure += self.checkThresholds(self.key_threshold_warning) + if self.key_value_list is not None: + failure += self.checkEquality(self.key_value_list) + if self.key_value_list_not is not None: + failure += self.checkNonEquality(self.key_value_list_not) + if self.key_list is not None: + failure += self.checkExists(self.key_list) return failure def checkCritical(self): failure = '' - if self.rules.key_threshold_critical != None: - failure += self.checkThresholds(self.rules.key_threshold_critical) - if self.rules.key_value_list_critical != None: - failure += self.checkEquality(self.rules.key_value_list_critical) - if self.rules.key_list_critical != None: - failure += self.checkExists(self.rules.key_list_critical) + if self.key_threshold_critical is not None: + failure += self.checkThresholds(self.key_threshold_critical) + if self.key_value_list_critical is not None: + failure += self.checkEquality(self.key_value_list_critical) + if self.key_value_list_not_critical is not None: + failure += self.checkNonEquality(self.key_value_list_not_critical) + if self.key_list_critical is not None: + failure += self.checkExists(self.key_list_critical) return failure + def checkUnknown(self): + unknown = '' + if self.key_value_list_unknown is not None: + unknown += self.checkEquality(self.key_value_list_unknown) + return unknown + def checkMetrics(self): - """Return a Nagios specific performance metrics string given keys and parameter definitions""" + """Return a Nagios specific performance metrics string given keys + and parameter definitions""" metrics = '' warning = '' critical = '' - if self.rules.metric_list != None: - for metric in self.rules.metric_list: + if self.metric_list is not None: + for metric in self.metric_list: key = metric minimum = maximum = warn_range = crit_range = None uom = '' if ',' in metric: vals = metric.split(',') if len(vals) == 2: - key,uom = vals + key, uom = vals if len(vals) == 4: - key,uom,warn_range,crit_range = vals + key, uom, warn_range, crit_range = vals if len(vals) == 6: - key,uom,warn_range,crit_range,minimum,maximum = vals + key, uom, warn_range, crit_range, \ + minimum, maximum = vals key, alias = _getKeyAlias(key) if self.helper.exists(key): metrics += "'%s'=%s" % (alias, self.helper.get(key)) - if uom: metrics += uom - if warn_range != None: + if uom: + metrics += uom + if warn_range is not None: warning += self.checkThreshold(key, alias, warn_range) metrics += ";%s" % warn_range - if crit_range != None: + if crit_range is not None: critical += self.checkThreshold(key, alias, crit_range) metrics += ";%s" % crit_range - if minimum != None: - critical += self.checkThreshold(key, alias, minimum + ':') + if minimum is not None: + critical += self.checkThreshold(key, alias, minimum + + ':') metrics += ";%s" % minimum - if maximum != None: - critical += self.checkThreshold(key, alias, '~:' + maximum) + if maximum is not None: + critical += self.checkThreshold(key, alias, '~:' + + maximum) metrics += ";%s" % maximum metrics += ' ' return ("%s" % metrics, warning, critical) -def parseArgs(): - parser = argparse.ArgumentParser(description= - 'Nagios plugin which checks json values from a given endpoint against argument specified rules\ - and determines the status and performance data for that service') - # parser.add_argument('-v', '--verbose', action='store_true', help='Verbose Output') - parser.add_argument('-d', '--debug', action='store_true', help='Debug mode.') - parser.add_argument('-s', '--ssl', action='store_true', help='HTTPS mode.') - parser.add_argument('-H', '--host', dest='host', required=True, help='Host.') +def parseArgs(): + parser = argparse.ArgumentParser( + description = plugin_description + '\n\nVersion: %s (%s)' + %(__version__, __version_date__), + formatter_class=argparse.RawDescriptionHelpFormatter) + + parser.add_argument('-d', '--debug', action='store_true', + help='debug mode') + parser.add_argument('-s', '--ssl', action='store_true', + help='use TLS to connect to remote host') + parser.add_argument('-H', '--host', dest='host', + required=not ('-V' in sys.argv or '--version' in sys.argv), + help='remote host to query') + parser.add_argument('-k', '--insecure', action='store_true', + help='do not check server SSL certificate') + parser.add_argument('-V', '--version', action='store_true', + help='print version of this plugin') + parser.add_argument('--cacert', + dest='cacert', help='SSL CA certificate') + parser.add_argument('--cert', + dest='cert', help='SSL client certificate') + parser.add_argument('--key', dest='key', + help='SSL client key ( if not bundled into the cert )') parser.add_argument('-P', '--port', dest='port', help='TCP port') - parser.add_argument('-p', '--path', dest='path', help='Path.') - parser.add_argument('-t', '--timeout', type=int, help='Connection timeout (seconds)') - parser.add_argument('-B', '--basic-auth', dest='auth', help='Basic auth string "username:password"') - parser.add_argument('-D', '--data', dest='data', help='The http payload to send as a POST') - parser.add_argument('-A', '--headers', dest='headers', help='The http headers in JSON format.') + parser.add_argument('-p', '--path', dest='path', help='Path') + parser.add_argument('-t', '--timeout', type=int, + help='Connection timeout (seconds)') + parser.add_argument('-B', '--basic-auth', dest='auth', + help='Basic auth string "username:password"') + parser.add_argument('-D', '--data', dest='data', + help='The http payload to send as a POST') + parser.add_argument('-A', '--headers', dest='headers', + help='The http headers in JSON format.') parser.add_argument('-f', '--field_separator', dest='separator', - help='Json Field separator, defaults to "." ; Select element in an array with "(" ")"') - parser.add_argument('-w', '--warning', dest='key_threshold_warning', nargs='*', - help='Warning threshold for these values (key1[>alias],WarnRange key2[>alias],WarnRange). WarnRange is in the format [@]start:end, more information at nagios-plugins.org/doc/guidelines.html.') - parser.add_argument('-c', '--critical', dest='key_threshold_critical', nargs='*', - help='Critical threshold for these values (key1[>alias],CriticalRange key2[>alias],CriticalRange. CriticalRange is in the format [@]start:end, more information at nagios-plugins.org/doc/guidelines.html.') + help='''JSON Field separator, defaults to "."; + Select element in an array with "(" ")"''') + parser.add_argument('-w', '--warning', dest='key_threshold_warning', + nargs='*', + help='''Warning threshold for these values + (key1[>alias],WarnRange key2[>alias],WarnRange). + WarnRange is in the format [@]start:end, more + information at + nagios-plugins.org/doc/guidelines.html.''') + parser.add_argument('-c', '--critical', dest='key_threshold_critical', + nargs='*', + help='''Critical threshold for these values + (key1[>alias],CriticalRange key2[>alias],CriticalRange. + CriticalRange is in the format [@]start:end, more + information at + nagios-plugins.org/doc/guidelines.html.''') parser.add_argument('-e', '--key_exists', dest='key_list', nargs='*', - help='Checks existence of these keys to determine status. Return warning if key is not present.') - parser.add_argument('-E', '--key_exists_critical', dest='key_list_critical', nargs='*', - help='Same as -e but return critical if key is not present.') + help='''Checks existence of these keys to determine + status. Return warning if key is not present.''') + parser.add_argument('-E', '--key_exists_critical', + dest='key_list_critical', + nargs='*', + help='''Same as -e but return critical if key is + not present.''') parser.add_argument('-q', '--key_equals', dest='key_value_list', nargs='*', - help='Checks equality of these keys and values (key[>alias],value key2,value2) to determine status.\ - Multiple key values can be delimited with colon (key,value1:value2). Return warning if equality check fails') - parser.add_argument('-Q', '--key_equals_critical', dest='key_value_list_critical', nargs='*', - help='Same as -q but return critical if equality check fails.') + help='''Checks equality of these keys and values + (key[>alias],value key2,value2) to determine status. + Multiple key values can be delimited with colon + (key,value1:value2). Return warning if equality + check fails''') + parser.add_argument('-Q', '--key_equals_critical', + dest='key_value_list_critical', nargs='*', + help='''Same as -q but return critical if + equality check fails.''') + parser.add_argument('-u', '--key_equals_unknown', + dest='key_value_list_unknown', nargs='*', + help='''Same as -q but return unknown if + equality check fails.''') + parser.add_argument('-y', '--key_not_equals', + dest='key_value_list_not', nargs='*', + help='''Checks equality of these keys and values + (key[>alias],value key2,value2) to determine status. + Multiple key values can be delimited with colon + (key,value1:value2). Return warning if equality + check succeeds''') + parser.add_argument('-Y', '--key_not_equals_critical', + dest='key_value_list_not_critical', nargs='*', + help='''Same as -q but return critical if equality + check succeeds.''') parser.add_argument('-m', '--key_metric', dest='metric_list', nargs='*', - help='Gathers the values of these keys (key[>alias],UnitOfMeasure,WarnRange,CriticalRange,Min,Max) for Nagios performance data.\ - More information about Range format and units of measure for nagios can be found at nagios-plugins.org/doc/guidelines.html\ - Additional formats for this parameter are: (key[>alias]), (key[>alias],UnitOfMeasure), (key[>alias],UnitOfMeasure,WarnRange,CriticalRange).') + help='''Gathers the values of these keys (key[>alias], + UnitOfMeasure,WarnRange,CriticalRange,Min,Max) for + Nagios performance data. More information about Range + format and units of measure for nagios can be found at + nagios-plugins.org/doc/guidelines.html + Additional formats for this parameter are: + (key[>alias]), (key[>alias],UnitOfMeasure), + (key[>alias],UnitOfMeasure,WarnRange, + CriticalRange).''') return parser.parse_args() + def debugPrint(debug_flag, message, pretty_flag=False): if debug_flag: if pretty_flag: pprint(message) else: - print message + print(message) if __name__ == "__main__" and len(sys.argv) >= 2 and sys.argv[1] == 'UnitTest': import unittest + class RulesHelper: separator = '.' debug = False - key_threshold_warning,key_value_list,key_list,key_threshold_critical,key_value_list_critical,key_list_critical,metric_list = None, None, None, None, None, None, None + key_threshold_warning = None + key_value_list = None + key_value_list_not = None + key_list = None + key_threshold_critical = None + key_value_list_critical = None + key_value_list_not_critical = None + key_list_critical = None + metric_list = None + def dash_m(self, data): - self.metric_list = data; return self + self.metric_list = data + return self + def dash_e(self, data): - self.key_list = data; return self + self.key_list = data + return self + def dash_E(self, data): - self.key_list_critical = data; return self + self.key_list_critical = data + return self + def dash_q(self, data): - self.key_value_list = data; return self + self.key_value_list = data + return self + def dash_Q(self, data): - self.key_value_list_critical = data; return self + self.key_value_list_critical = data + return self + + def dash_y(self, data): + self.key_value_list_not = data + return self + + def dash_Y(self, data): + self.key_value_list_not_critical = data + return self + def dash_w(self, data): - self.key_threshold_warning = data; return self + self.key_threshold_warning = data + return self + def dash_c(self, data): - self.key_threshold_critical = data; return self + self.key_threshold_critical = data + return self + class UnitTest(unittest.TestCase): rules = RulesHelper() + def check_data(self, args, jsondata, code): data = json.loads(jsondata) nagios = NagiosHelper() @@ -335,61 +547,134 @@ if __name__ == "__main__" and len(sys.argv) >= 2 and sys.argv[1] == 'UnitTest': nagios.append_critical(processor.checkCritical()) nagios.append_metrics(processor.checkMetrics()) self.assertEqual(code, nagios.getCode()) + def test_metrics(self): - self.check_data(RulesHelper().dash_m(['metric,,1:4,1:5']), '{"metric": 5}', WARNING_CODE) - self.check_data(RulesHelper().dash_m(['metric,,1:5,1:4']), '{"metric": 5}', CRITICAL_CODE) - self.check_data(RulesHelper().dash_m(['metric,,1:5,1:5,6,10']), '{"metric": 5}', CRITICAL_CODE) - self.check_data(RulesHelper().dash_m(['metric,,1:5,1:5,1,4']), '{"metric": 5}', CRITICAL_CODE) - self.check_data(RulesHelper().dash_m(['metric,s,@1:4,@6:10,1,10']), '{"metric": 5}', OK_CODE) + self.check_data(RulesHelper().dash_m(['metric,,1:4,1:5']), + '{"metric": 5}', WARNING_CODE) + self.check_data(RulesHelper().dash_m(['metric,,1:5,1:4']), + '{"metric": 5}', CRITICAL_CODE) + self.check_data(RulesHelper().dash_m(['metric,,1:5,1:5,6,10']), + '{"metric": 5}', CRITICAL_CODE) + self.check_data(RulesHelper().dash_m(['metric,,1:5,1:5,1,4']), + '{"metric": 5}', CRITICAL_CODE) + self.check_data(RulesHelper().dash_m(['metric,s,@1:4,@6:10,1,10']), + '{"metric": 5}', OK_CODE) + self.check_data(RulesHelper().dash_m(['(*).value,s,1:5,1:5']), + '[{"value": 5},{"value": 100}]', CRITICAL_CODE) + def test_exists(self): - self.check_data(RulesHelper().dash_e(['nothere']), '{"metric": 5}', WARNING_CODE) - self.check_data(RulesHelper().dash_E(['nothere']), '{"metric": 5}', CRITICAL_CODE) - self.check_data(RulesHelper().dash_e(['metric']), '{"metric": 5}', OK_CODE) + self.check_data(RulesHelper().dash_e(['nothere']), + '{"metric": 5}', WARNING_CODE) + self.check_data(RulesHelper().dash_E(['nothere']), + '{"metric": 5}', CRITICAL_CODE) + self.check_data(RulesHelper().dash_e(['metric']), + '{"metric": 5}', OK_CODE) + def test_equality(self): - self.check_data(RulesHelper().dash_q(['metric,6']), '{"metric": 5}', WARNING_CODE) - self.check_data(RulesHelper().dash_Q(['metric,6']), '{"metric": 5}', CRITICAL_CODE) - self.check_data(RulesHelper().dash_q(['metric,5']), '{"metric": 5}', OK_CODE) + self.check_data(RulesHelper().dash_q(['metric,6']), + '{"metric": 5}', WARNING_CODE) + self.check_data(RulesHelper().dash_Q(['metric,6']), + '{"metric": 5}', CRITICAL_CODE) + self.check_data(RulesHelper().dash_q(['metric,5']), + '{"metric": 5}', OK_CODE) + + def test_non_equality(self): + self.check_data(RulesHelper().dash_y(['metric,6']), + '{"metric": 6}', WARNING_CODE) + self.check_data(RulesHelper().dash_Y(['metric,6']), + '{"metric": 6}', CRITICAL_CODE) + self.check_data(RulesHelper().dash_y(['metric,5']), + '{"metric": 6}', OK_CODE) + def test_warning_thresholds(self): - self.check_data(RulesHelper().dash_w(['metric,5']), '{"metric": 5}', OK_CODE) - self.check_data(RulesHelper().dash_w(['metric,5:']), '{"metric": 5}', OK_CODE) - self.check_data(RulesHelper().dash_w(['metric,~:5']), '{"metric": 5}', OK_CODE) - self.check_data(RulesHelper().dash_w(['metric,1:5']), '{"metric": 5}', OK_CODE) - self.check_data(RulesHelper().dash_w(['metric,@5']), '{"metric": 6}', OK_CODE) - self.check_data(RulesHelper().dash_w(['metric,@5:']), '{"metric": 4}', OK_CODE) - self.check_data(RulesHelper().dash_w(['metric,@~:5']), '{"metric": 6}', OK_CODE) - self.check_data(RulesHelper().dash_w(['metric,@1:5']), '{"metric": 6}', OK_CODE) - self.check_data(RulesHelper().dash_w(['metric,5']), '{"metric": 6}', WARNING_CODE) - self.check_data(RulesHelper().dash_w(['metric,5:']), '{"metric": 4}', WARNING_CODE) - self.check_data(RulesHelper().dash_w(['metric,~:5']), '{"metric": 6}', WARNING_CODE) - self.check_data(RulesHelper().dash_w(['metric,1:5']), '{"metric": 6}', WARNING_CODE) - self.check_data(RulesHelper().dash_w(['metric,@5']), '{"metric": 5}', WARNING_CODE) - self.check_data(RulesHelper().dash_w(['metric,@5:']), '{"metric": 5}', WARNING_CODE) - self.check_data(RulesHelper().dash_w(['metric,@~:5']), '{"metric": 5}', WARNING_CODE) - self.check_data(RulesHelper().dash_w(['metric,@1:5']), '{"metric": 5}', WARNING_CODE) + self.check_data(RulesHelper().dash_w(['metric,5']), + '{"metric": 5}', OK_CODE) + self.check_data(RulesHelper().dash_w(['metric,5:']), + '{"metric": 5}', OK_CODE) + self.check_data(RulesHelper().dash_w(['metric,~:5']), + '{"metric": 5}', OK_CODE) + self.check_data(RulesHelper().dash_w(['metric,1:5']), + '{"metric": 5}', OK_CODE) + self.check_data(RulesHelper().dash_w(['metric,@5']), + '{"metric": 6}', OK_CODE) + self.check_data(RulesHelper().dash_w(['metric,@5:']), + '{"metric": 4}', OK_CODE) + self.check_data(RulesHelper().dash_w(['metric,@~:5']), + '{"metric": 6}', OK_CODE) + self.check_data(RulesHelper().dash_w(['metric,@1:5']), + '{"metric": 6}', OK_CODE) + self.check_data(RulesHelper().dash_w(['metric,5']), + '{"metric": 6}', WARNING_CODE) + self.check_data(RulesHelper().dash_w(['metric,5:']), + '{"metric": 4}', WARNING_CODE) + self.check_data(RulesHelper().dash_w(['metric,~:5']), + '{"metric": 6}', WARNING_CODE) + self.check_data(RulesHelper().dash_w(['metric,1:5']), + '{"metric": 6}', WARNING_CODE) + self.check_data(RulesHelper().dash_w(['metric,@5']), + '{"metric": 5}', WARNING_CODE) + self.check_data(RulesHelper().dash_w(['metric,@5:']), + '{"metric": 5}', WARNING_CODE) + self.check_data(RulesHelper().dash_w(['metric,@~:5']), + '{"metric": 5}', WARNING_CODE) + self.check_data(RulesHelper().dash_w(['metric,@1:5']), + '{"metric": 5}', WARNING_CODE) + self.check_data(RulesHelper().dash_w(['(*).value,@1:5']), + '[{"value": 5},{"value": 1000}]', WARNING_CODE) + def test_critical_thresholds(self): - self.check_data(RulesHelper().dash_c(['metric,5']), '{"metric": 5}', OK_CODE) - self.check_data(RulesHelper().dash_c(['metric,5:']), '{"metric": 5}', OK_CODE) - self.check_data(RulesHelper().dash_c(['metric,~:5']), '{"metric": 5}', OK_CODE) - self.check_data(RulesHelper().dash_c(['metric,1:5']), '{"metric": 5}', OK_CODE) - self.check_data(RulesHelper().dash_c(['metric,@5']), '{"metric": 6}', OK_CODE) - self.check_data(RulesHelper().dash_c(['metric,@5:']), '{"metric": 4}', OK_CODE) - self.check_data(RulesHelper().dash_c(['metric,@~:5']), '{"metric": 6}', OK_CODE) - self.check_data(RulesHelper().dash_c(['metric,@1:5']), '{"metric": 6}', OK_CODE) - self.check_data(RulesHelper().dash_c(['metric,5']), '{"metric": 6}', CRITICAL_CODE) - self.check_data(RulesHelper().dash_c(['metric,5:']), '{"metric": 4}', CRITICAL_CODE) - self.check_data(RulesHelper().dash_c(['metric,~:5']), '{"metric": 6}', CRITICAL_CODE) - self.check_data(RulesHelper().dash_c(['metric,1:5']), '{"metric": 6}', CRITICAL_CODE) - self.check_data(RulesHelper().dash_c(['metric,@5']), '{"metric": 5}', CRITICAL_CODE) - self.check_data(RulesHelper().dash_c(['metric,@5:']), '{"metric": 5}', CRITICAL_CODE) - self.check_data(RulesHelper().dash_c(['metric,@~:5']), '{"metric": 5}', CRITICAL_CODE) - self.check_data(RulesHelper().dash_c(['metric,@1:5']), '{"metric": 5}', CRITICAL_CODE) + self.check_data(RulesHelper().dash_c(['metric,5']), + '{"metric": 5}', OK_CODE) + self.check_data(RulesHelper().dash_c(['metric,5:']), + '{"metric": 5}', OK_CODE) + self.check_data(RulesHelper().dash_c(['metric,~:5']), + '{"metric": 5}', OK_CODE) + self.check_data(RulesHelper().dash_c(['metric,1:5']), + '{"metric": 5}', OK_CODE) + self.check_data(RulesHelper().dash_c(['metric,@5']), + '{"metric": 6}', OK_CODE) + self.check_data(RulesHelper().dash_c(['metric,@5:']), + '{"metric": 4}', OK_CODE) + self.check_data(RulesHelper().dash_c(['metric,@~:5']), + '{"metric": 6}', OK_CODE) + self.check_data(RulesHelper().dash_c(['metric,@1:5']), + '{"metric": 6}', OK_CODE) + self.check_data(RulesHelper().dash_c(['metric,5']), + '{"metric": 6}', CRITICAL_CODE) + self.check_data(RulesHelper().dash_c(['metric,5:']), + '{"metric": 4}', CRITICAL_CODE) + self.check_data(RulesHelper().dash_c(['metric,~:5']), + '{"metric": 6}', CRITICAL_CODE) + self.check_data(RulesHelper().dash_c(['metric,1:5']), + '{"metric": 6}', CRITICAL_CODE) + self.check_data(RulesHelper().dash_c(['metric,@5']), + '{"metric": 5}', CRITICAL_CODE) + self.check_data(RulesHelper().dash_c(['metric,@5:']), + '{"metric": 5}', CRITICAL_CODE) + self.check_data(RulesHelper().dash_c(['metric,@~:5']), + '{"metric": 5}', CRITICAL_CODE) + self.check_data(RulesHelper().dash_c(['metric,@1:5']), + '{"metric": 5}', CRITICAL_CODE) + self.check_data(RulesHelper().dash_c(['(*).value,@1:5']), + '[{"value": 5},{"value": 1000}]', CRITICAL_CODE) + def test_separator(self): rules = RulesHelper() rules.separator = '_' self.check_data( - rules.dash_q(['(0)_gauges_jvm.buffers.direct.capacity(1)_value,1234']), - '[{ "gauges": { "jvm.buffers.direct.capacity": [{"value": 215415},{"value": 1234}]}}]', + rules.dash_q( + ['(0)_gauges_jvm.buffers.direct.capacity(1)_value,1234']), + '''[{ "gauges": { "jvm.buffers.direct.capacity": [ + {"value": 215415},{"value": 1234}]}}]''', OK_CODE) + self.check_data( + rules.dash_q( + ['(*)_gauges_jvm.buffers.direct.capacity(1)_value,1234']), + '''[{ "gauges": { "jvm.buffers.direct.capacity": [ + {"value": 215415},{"value": 1234}]}}, + { "gauges": { "jvm.buffers.direct.capacity": [ + {"value": 215415},{"value": 1235}]}}]''', + WARNING_CODE) unittest.main() exit(0) @@ -397,39 +682,89 @@ if __name__ == "__main__" and len(sys.argv) >= 2 and sys.argv[1] == 'UnitTest': if __name__ == "__main__": args = parseArgs() nagios = NagiosHelper() + if args.version: + print('Version: %s - Date: %s' % (__version__, __version_date__)) + exit(0) + if args.ssl: url = "https://%s" % args.host + + context = ssl.SSLContext(ssl.PROTOCOL_SSLv23) + context.options |= ssl.OP_NO_SSLv2 + context.options |= ssl.OP_NO_SSLv3 + + if args.insecure: + context.verify_mode = ssl.CERT_NONE + else: + context.verify_mode = ssl.CERT_OPTIONAL + if args.cacert: + try: + context.load_verify_locations(args.cacert) + except ssl.SSLError: + nagios.append_unknown( + ''' Error loading SSL CA cert "%s"!''' + % args.cacert) + + if args.cert: + try: + context.load_cert_chain(args.cert,keyfile=args.key) + except ssl.SSLError: + if args.key: + nagios.append_unknown( + ''' Error loading SSL cert. Make sure key "%s" belongs to cert "%s"!''' + % (args.key, args.cert)) + else: + nagios.append_unknown( + ''' Error loading SSL cert. Make sure "%s" contains the key as well!''' + % (args.cert)) + + if nagios.getCode() != OK_CODE: + print(nagios.getMessage()) + exit(nagios.getCode()) + else: url = "http://%s" % args.host - if args.port: url += ":%s" % args.port - if args.path: url += "/%s" % args.path + if args.port: + url += ":%s" % args.port + if args.path: + url += "/%s" % args.path debugPrint(args.debug, "url:%s" % url) - # Attempt to reach the endpoint + json_data = '' try: req = urllib2.Request(url) + req.add_header("User-Agent", "check_http_json") if args.auth: base64str = base64.encodestring(args.auth).replace('\n', '') req.add_header('Authorization', 'Basic %s' % base64str) if args.headers: - headers=json.loads(args.headers) + headers = json.loads(args.headers) debugPrint(args.debug, "Headers:\n %s" % headers) for header in headers: req.add_header(header, headers[header]) if args.timeout and args.data: - response = urllib2.urlopen(req, timeout=args.timeout, data=args.data) + response = urllib2.urlopen(req, timeout=args.timeout, + data=args.data, context=context) elif args.timeout: - response = urllib2.urlopen(req, timeout=args.timeout) + response = urllib2.urlopen(req, timeout=args.timeout, + context=context) elif args.data: - response = urllib2.urlopen(req, data=args.data) + response = urllib2.urlopen(req, data=args.data, context=context) else: - response = urllib2.urlopen(req) + response = urllib2.urlopen(req, context=context) + + json_data = response.read() + except HTTPError as e: - nagios.append_unknown("HTTPError[%s], url:%s" % (str(e.code), url)) + nagios.append_unknown(" HTTPError[%s], url:%s" % (str(e.code), url)) except URLError as e: - nagios.append_critical("URLError[%s], url:%s" % (str(e.reason), url)) + nagios.append_critical(" URLError[%s], url:%s" % (str(e.reason), url)) + + try: + data = json.loads(json_data) + except ValueError as e: + nagios.append_unknown(" Parser error: %s" % str(e)) + else: - jsondata = response.read() - data = json.loads(jsondata) debugPrint(args.debug, 'json:') debugPrint(args.debug, data, True) # Apply rules to returned JSON data @@ -437,6 +772,10 @@ if __name__ == "__main__": nagios.append_warning(processor.checkWarning()) nagios.append_critical(processor.checkCritical()) nagios.append_metrics(processor.checkMetrics()) + nagios.append_unknown(processor.checkUnknown()) + # Print Nagios specific string and exit appropriately - print nagios.getMessage() + print(nagios.getMessage()) exit(nagios.getCode()) + +#EOF