mirror of
https://github.com/drewkerrigan/nagios-http-json.git
synced 2024-12-22 09:03:57 +01:00
fix symlink
This commit is contained in:
Drew Kerrigan
parent
6d9903ec4a
commit
553cfd7531
@ -1 +0,0 @@
|
||||
check_http_json.py
|
||||
199
check_http_json.py
Executable file
199
check_http_json.py
Executable file
@ -0,0 +1,199 @@
|
||||
#!/usr/bin/python
|
||||
|
||||
"""
|
||||
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.
|
||||
"""
|
||||
|
||||
import httplib, urllib, urllib2
|
||||
import json
|
||||
import argparse
|
||||
from pprint import pprint
|
||||
|
||||
|
||||
class NagiosHelper:
|
||||
"""Help with Nagios specific status string formatting."""
|
||||
code = 0
|
||||
message_prefixes = {0: 'OK', 1: 'WARNING', 2: 'CRITICAL', 3: 'UNKNOWN'}
|
||||
message_text = ''
|
||||
performance_data = ''
|
||||
|
||||
def getMessage(self):
|
||||
"""Build a status-prefixed message with optional performance data generated externally"""
|
||||
text = "%s" % self.message_prefixes[self.code]
|
||||
if self.message_text:
|
||||
text += ": %s" % self.message_text
|
||||
if self.performance_data:
|
||||
text += "|%s" % self.performance_data
|
||||
return text
|
||||
|
||||
def setCodeAndMessage(self, code, text):
|
||||
self.code = code
|
||||
self.message_text = text
|
||||
|
||||
def ok(self, text): self.setCodeAndMessage(0, text)
|
||||
def warning(self, text): self.setCodeAndMessage(1, text)
|
||||
def critical(self, text): self.setCodeAndMessage(2, text)
|
||||
def unknown(self, text): self.setCodeAndMessage(3, text)
|
||||
|
||||
class JsonHelper:
|
||||
"""Perform simple comparison operations against values in a given JSON dict"""
|
||||
def __init__(self, json_data):
|
||||
self.data = json_data
|
||||
|
||||
def equals(self, key, value): return (key in self.data) and (str(self.data[key]) == value)
|
||||
def lte(self, key, value): return (key in self.data) and (str(self.data[key]) <= value)
|
||||
def gte(self, key, value): return (key in self.data) and (str(self.data[key]) >= value)
|
||||
def exists(self, key): return key in self.data
|
||||
def get(self, key):
|
||||
if key in self.data:
|
||||
return self.data[key]
|
||||
else:
|
||||
return ''
|
||||
|
||||
class JsonRuleProcessor:
|
||||
"""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
|
||||
|
||||
def isAlive(self):
|
||||
"""Return a tuple with liveness and reason for not liveness given existence, equality, and comparison rules"""
|
||||
reason = ''
|
||||
helper = JsonHelper(self.data)
|
||||
|
||||
if self.rules.key_list != None:
|
||||
for k in self.rules.key_list:
|
||||
if (helper.exists(k) == False):
|
||||
reason += " Key %s did not exist." % k
|
||||
|
||||
if self.rules.key_value_list != None:
|
||||
for kv in self.rules.key_value_list:
|
||||
k, v = kv.split(',')
|
||||
if (helper.equals(k, v) == False):
|
||||
reason += " Value %s for key %sdid not match." % (v, k)
|
||||
|
||||
if self.rules.key_lte_list != None:
|
||||
for kv in self.rules.key_lte_list:
|
||||
k, v = kv.split(',')
|
||||
if (helper.lte(k, v) == False):
|
||||
reason += " Value %s was not less than or equal to value for key %s." % (v, k)
|
||||
|
||||
if self.rules.key_gte_list != None:
|
||||
for kv in self.rules.key_gte_list:
|
||||
k, v = kv.split(',')
|
||||
if (helper.gte(k, v) == False):
|
||||
reason += " Value %s was not greater than or equal to value for key %s." % (v, k)
|
||||
|
||||
is_alive = (reason == '')
|
||||
|
||||
return (is_alive, reason)
|
||||
|
||||
def getMetrics(self):
|
||||
"""Return a Nagios specific performance metrics string given keys and parameter definitions"""
|
||||
metrics = ''
|
||||
helper = JsonHelper(self.data)
|
||||
|
||||
if self.rules.metric_list != None:
|
||||
for metric in self.rules.metric_list:
|
||||
key = metric
|
||||
minimum = maximum = warn_range = crit_range = 0
|
||||
uom = ''
|
||||
|
||||
vals = metric.split(',')
|
||||
|
||||
if ',' in metric:
|
||||
vals = metric.split(',')
|
||||
|
||||
if len(vals) == 2:
|
||||
key,uom = vals
|
||||
if len(vals) == 4:
|
||||
key,uom,minimum,maximum = vals
|
||||
if len(vals) == 6:
|
||||
key,uom,minimum,maximum,warn_range,crit_range = vals
|
||||
|
||||
if helper.exists(key):
|
||||
metrics += "'%s'=%s" % (key, helper.get(key))
|
||||
if uom: metrics += uom
|
||||
metrics += ";%s" % minimum
|
||||
metrics += ";%s" % maximum
|
||||
if warn_range: metrics += ";%s" % warn_range
|
||||
if crit_range: metrics += ";%s" % crit_range
|
||||
|
||||
metrics += ' '
|
||||
|
||||
|
||||
return "%s" % metrics
|
||||
|
||||
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('-H', '--host', dest='host', required=True, help='Host.')
|
||||
parser.add_argument('-p', '--path', dest='path', help='Path.')
|
||||
parser.add_argument('-e', '--key_exists', dest='key_list', nargs='*',
|
||||
help='Checks existence of these keys to determine status.')
|
||||
parser.add_argument('-q', '--key_equals', dest='key_value_list', nargs='*',
|
||||
help='Checks equality of these keys and values (key,value key2,value2) to determine status.')
|
||||
parser.add_argument('-l', '--key_lte', dest='key_lte_list', nargs='*',
|
||||
help='Checks that these keys and values (key,value key2,value2) are less than or equal to\
|
||||
the returned json value to determine status.')
|
||||
parser.add_argument('-g', '--key_gte', dest='key_gte_list', nargs='*',
|
||||
help='Checks that these keys and values (key,value key2,value2) are greater than or equal to\
|
||||
the returned json value to determine status.')
|
||||
parser.add_argument('-m', '--key_metric', dest='metric_list', nargs='*',
|
||||
help='Gathers the values of these keys (key,UnitOfMeasure,Min,Max,WarnRange,CriticalRange) for Nagios performance data.\
|
||||
More information about Range format and units of measure for nagios can be found at https://nagios-plugins.org/doc/guidelines.html\
|
||||
Additional formats for this parameter are: (key), (key,UnitOfMeasure), (key,UnitOfMeasure,Min,Max).')
|
||||
parser.add_argument('-d', '--debug', action='store_true', help='Debug mode.')
|
||||
|
||||
return parser.parse_args()
|
||||
|
||||
def debugPrint(debug_flag, message, pretty_flag=False):
|
||||
if debug_flag:
|
||||
if pretty_flag:
|
||||
pprint(message)
|
||||
else:
|
||||
print message
|
||||
|
||||
"""Program entry point"""
|
||||
if __name__ == "__main__":
|
||||
args = parseArgs()
|
||||
nagios = NagiosHelper()
|
||||
|
||||
url = "http://%s" % args.host
|
||||
if args.path: url += "/%s" % args.path
|
||||
debugPrint(args.debug, "url:%s" % url)
|
||||
|
||||
# Attempt to reach the endpoint
|
||||
try:
|
||||
req = urllib2.Request(url)
|
||||
response = urllib2.urlopen(req)
|
||||
except HTTPError as e:
|
||||
nagios.unknown("HTTPError[%s], url:%s" % (str(e.code), url))
|
||||
except URLError as e:
|
||||
nagios.critical("URLError[%s], url:%s" % (str(e.reason), url))
|
||||
else:
|
||||
jsondata = response.read()
|
||||
data = json.loads(jsondata)
|
||||
|
||||
debugPrint(args.debug, 'json:')
|
||||
debugPrint(args.debug, data, True)
|
||||
|
||||
# Apply rules to returned JSON data
|
||||
processor = JsonRuleProcessor(data, args)
|
||||
is_alive, reason = processor.isAlive()
|
||||
|
||||
if is_alive:
|
||||
# Rules all passed, attempt to get performance data
|
||||
nagios.performance_data = processor.getMetrics()
|
||||
nagios.ok("Status OK.")
|
||||
else:
|
||||
nagios.warning("Status check failed, reason:%s" % reason)
|
||||
|
||||
# Print Nagios specific string and exit appropriately
|
||||
print nagios.getMessage()
|
||||
exit(nagios.code)
|
||||
Loading…
Reference in New Issue
Block a user