diff --git a/README.md b/README.md index ad3ef9f..aed5065 100644 --- a/README.md +++ b/README.md @@ -83,6 +83,18 @@ options: can be delimited with colon (key,value1:value2). Return warning if equality check fails -Q [KEY_VALUE_LIST_CRITICAL ...], --key_equals_critical [KEY_VALUE_LIST_CRITICAL ...] Same as -q but return critical if equality check fails. + --key_time [KEY_TIME_LIST ...], + Checks a Timestamp 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 the key is older + than the value (ex.: 30s,10m,2h,3d,...). + With at it return warning if the key is jounger + than the value (ex.: @30s,@10m,@2h,@3d,...). + With Minus you can shift the time in the future. + --key_time_critical [KEY_TIME_LIST_CRITICAL ...], + Same as --key_time but return critical if + Timestamp age fails. -u [KEY_VALUE_LIST_UNKNOWN ...], --key_equals_unknown [KEY_VALUE_LIST_UNKNOWN ...] Same as -q but return unknown if equality check fails. -y [KEY_VALUE_LIST_NOT ...], --key_not_equals [KEY_VALUE_LIST_NOT ...] @@ -188,6 +200,45 @@ options: 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). +### Timestamp + +**Data**: + + { "metric": "2020-01-01 10:10:00.000000+00:00" } + +#### Relevant Commands + +* **Warning:** `./check_http_json.py -H : -p --key_time "metric,TIME"` +* **Critical:** `./check_http_json.py -H : -p --key_time_critical "metric,TIME"` + +#### TIME Definitions + +* **Format:** [@][-]TIME +* **Generates a Warning or Critical if...** + * **Timestamp is more than 30 seconds in the past:** `30s` + * **Timestamp is more than 5 minutes in the past:** `5m` + * **Timestamp is more than 12 hours in the past:** `12h` + * **Timestamp is more than 2 days in the past:** `2d` + * **Timestamp is more than 30 minutes in the future:** `-30m` + * **Timestamp is not more than 30 minutes in the future:** `@-30m` + * **Timestamp is not more than 30 minutes in the past:** `@30m` + +##### Timestamp Format + +This plugin uses the Python function 'datetime.fromisoformat'. +Since Python 3.11 any valid ISO 8601 format is supported, with the following exceptions: + +* Time zone offsets may have fractional seconds. +* The T separator may be replaced by any single unicode character. +* Fractional hours and minutes are not supported. +* Reduced precision dates are not currently supported (YYYY-MM, YYYY). +* Extended date representations are not currently supported (±YYYYYY-MM-DD). +* Ordinal dates are not currently supported (YYYY-OOO). + +Before Python 3.11, this method only supported the format YYYY-MM-DD + +More info and examples the about Timestamp Format can be found at [https://docs.python.org/3/library/datetime.html#datetime.datetime.fromisoformat](https://docs.python.org/3/library/datetime.html#datetime.datetime.fromisoformat). + #### Using Headers * `./check_http_json.py -H : -p -A '{"content-type": "application/json"}' -w "metric,RANGE"` diff --git a/check_http_json.py b/check_http_json.py index e46124a..e242431 100755 --- a/check_http_json.py +++ b/check_http_json.py @@ -8,6 +8,7 @@ import sys import ssl from urllib.error import HTTPError from urllib.error import URLError +from datetime import datetime, timedelta, timezone plugin_description = \ """ @@ -234,11 +235,13 @@ class JsonRuleProcessor: 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_time_list = self.expandKeys(self.rules.key_time_list) 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_time_list_critical = self.expandKeys(self.rules.key_time_list_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) @@ -330,6 +333,72 @@ class JsonRuleProcessor: failure += self.checkThreshold(key, alias, r) return failure + def checkTimestamp(self, key, alias, r): + failure = '' + invert = False + negative = False + if r.startswith('@'): + invert = True + r = r[1:] + if r.startswith('-'): + negative = True + r = r[1:] + duration = int(r[:-1]) + unit = r[-1] + + if unit == 's': + tiemduration = timedelta(seconds=duration) + elif unit == 'm': + tiemduration = timedelta(minutes=duration) + elif unit == 'h': + tiemduration = timedelta(hours=duration) + elif unit == 'd': + tiemduration = timedelta(days=duration) + else: + return " Value (%s) is not a vaild timeduration." % (r) + + if not self.helper.exists(key): + return " Key (%s) for key %s not Exists." % \ + (key, alias) + + try: + timestamp = datetime.fromisoformat(self.helper.get(key)) + except ValueError as ve: + return " Value (%s) for key %s is not a Date in ISO format. %s" % \ + (self.helper.get(key), alias, ve) + + now = datetime.now(timezone.utc) + + if timestamp.tzinfo == None: + timestamp = timestamp.replace(tzinfo=timezone.utc) + + age = now - timestamp + + if not negative: + if age > tiemduration and not invert: + failure += " Value (%s) for key %s is older than now-%s%s." % \ + (self.helper.get(key), alias, duration, unit) + if not age > tiemduration and invert: + failure += " Value (%s) for key %s is newer than now-%s%s." % \ + (self.helper.get(key), alias, duration, unit) + else: + if age < -tiemduration and not invert: + failure += " Value (%s) for key %s is newer than now+%s%s." % \ + (self.helper.get(key), alias, duration, unit) + if not age < -tiemduration and invert: + failure += " Value (%s) for key %s is older than now+%s%s.." % \ + (self.helper.get(key), alias, duration, unit) + + return failure + + def checkTimestamps(self, threshold_list): + failure = '' + for threshold in threshold_list: + k, r = threshold.split(',') + key, alias = _getKeyAlias(k) + failure += self.checkTimestamp(key, alias, r) + return failure + def checkWarning(self): failure = '' if self.key_threshold_warning is not None: @@ -338,6 +407,8 @@ class JsonRuleProcessor: 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_time_list is not None: + failure += self.checkTimestamps(self.key_time_list) if self.key_list is not None: failure += self.checkExists(self.key_list) return failure @@ -352,6 +423,8 @@ class JsonRuleProcessor: 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_time_list_critical is not None: + failure += self.checkTimestamps(self.key_time_list_critical) if self.key_list_critical is not None: failure += self.checkExists(self.key_list_critical) return failure @@ -490,6 +563,19 @@ def parseArgs(args): dest='key_value_list_critical', nargs='*', help='''Same as -q but return critical if equality check fails.''') + parser.add_argument('--key_time', dest='key_time_list', nargs='*', + help='''Checks a Timestamp 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 the key is older + than the value (ex.: 30s,10m,2h,3d,...). + With at it return warning if the key is jounger + than the value (ex.: @30s,@10m,@2h,@3d,...). + With Minus you can shift the time in the future.''') + parser.add_argument('--key_time_critical', + dest='key_time_list_critical', nargs='*', + help='''Same as --key_time but return critical if + Timestamp age fails.''') parser.add_argument('-u', '--key_equals_unknown', dest='key_value_list_unknown', nargs='*', help='''Same as -q but return unknown if diff --git a/test/test_check_http_json.py b/test/test_check_http_json.py index 3f2f8eb..33627e3 100644 --- a/test/test_check_http_json.py +++ b/test/test_check_http_json.py @@ -28,6 +28,8 @@ class RulesHelper: key_threshold_critical = None key_value_list_critical = None key_value_list_not_critical = None + key_time_list = None + key_time_list_critical = None key_value_list_unknown = None key_list_critical = None metric_list = None @@ -71,7 +73,14 @@ class RulesHelper: def dash_c(self, data): self.key_threshold_critical = data return self + + def dash_dash_key_time(self, data): + self.key_time_list = data + return self + def dash_dash_key_time_critical(self, data): + self.key_time_list_critical = data + return self class UtilTest(unittest.TestCase): """ @@ -302,3 +311,140 @@ class UtilTest(unittest.TestCase): # This should throw an error data = '[]' self.check_data(rules.dash_q(['(*).update_status,warn_me']), data, CRITICAL_CODE) + + def test_key_time(self): + if sys.version_info[1] >= 11: + # Test current timestamp. + now = datetime.now(timezone.utc) + data = "{\"timestamp\": \"%s\",\"timestamp2\": \"%s\"}" % (now, now) + + self.check_data(RulesHelper().dash_dash_key_time(['timestamp,30s', 'timestamp2,30s']), data, OK_CODE) + + self.check_data(RulesHelper().dash_dash_key_time(['timestamp,30m']), data, OK_CODE) + self.check_data(RulesHelper().dash_dash_key_time_critical(['timestamp,1h']), data, OK_CODE) + self.check_data(RulesHelper().dash_dash_key_time(['timestamp,3h']), data, OK_CODE) + self.check_data(RulesHelper().dash_dash_key_time_critical(['timestamp,2d']), data, OK_CODE) + + self.check_data(RulesHelper().dash_dash_key_time(['timestamp,@30m']), data, WARNING_CODE) + self.check_data(RulesHelper().dash_dash_key_time_critical(['timestamp,@1h']), data, CRITICAL_CODE) + self.check_data(RulesHelper().dash_dash_key_time(['timestamp,@3h']), data, WARNING_CODE) + self.check_data(RulesHelper().dash_dash_key_time_critical(['timestamp,@2d']), data, CRITICAL_CODE) + + self.check_data(RulesHelper().dash_dash_key_time(['timestamp,-30m']), data, OK_CODE) + self.check_data(RulesHelper().dash_dash_key_time_critical(['timestamp,-1h']), data, OK_CODE) + self.check_data(RulesHelper().dash_dash_key_time(['timestamp,-3h']), data, OK_CODE) + self.check_data(RulesHelper().dash_dash_key_time_critical(['timestamp,-2d']), data, OK_CODE) + + self.check_data(RulesHelper().dash_dash_key_time(['timestamp,@-30m']), data, WARNING_CODE) + self.check_data(RulesHelper().dash_dash_key_time_critical(['timestamp,@-1h']), data, CRITICAL_CODE) + self.check_data(RulesHelper().dash_dash_key_time(['timestamp,@-3h']), data, WARNING_CODE) + self.check_data(RulesHelper().dash_dash_key_time_critical(['timestamp,@-2d']), data, CRITICAL_CODE) + + # Test 31 minute in the past. + data = "{\"timestamp\": \"%s\"}" % (now - timedelta(minutes=31)) + self.check_data(RulesHelper().dash_dash_key_time(['timestamp,30m']), data, WARNING_CODE) + self.check_data(RulesHelper().dash_dash_key_time_critical(['timestamp,1h']), data, OK_CODE) + self.check_data(RulesHelper().dash_dash_key_time(['timestamp,3h']), data, OK_CODE) + self.check_data(RulesHelper().dash_dash_key_time_critical(['timestamp,2d']), data, OK_CODE) + + self.check_data(RulesHelper().dash_dash_key_time(['timestamp,@30m']), data, OK_CODE) + self.check_data(RulesHelper().dash_dash_key_time_critical(['timestamp,@1h']), data, CRITICAL_CODE) + self.check_data(RulesHelper().dash_dash_key_time(['timestamp,@3h']), data, WARNING_CODE) + self.check_data(RulesHelper().dash_dash_key_time_critical(['timestamp,@2d']), data, CRITICAL_CODE) + + self.check_data(RulesHelper().dash_dash_key_time(['timestamp,-30m']), data, OK_CODE) + self.check_data(RulesHelper().dash_dash_key_time_critical(['timestamp,-1h']), data, OK_CODE) + self.check_data(RulesHelper().dash_dash_key_time(['timestamp,-3h']), data, OK_CODE) + self.check_data(RulesHelper().dash_dash_key_time_critical(['timestamp,-2d']), data, OK_CODE) + + self.check_data(RulesHelper().dash_dash_key_time(['timestamp,@-30m']), data, WARNING_CODE) + self.check_data(RulesHelper().dash_dash_key_time_critical(['timestamp,@-1h']), data, CRITICAL_CODE) + self.check_data(RulesHelper().dash_dash_key_time(['timestamp,@-3h']), data, WARNING_CODE) + self.check_data(RulesHelper().dash_dash_key_time_critical(['timestamp,@-2d']), data, CRITICAL_CODE) + + # Test two hours and one minute in the past. + data = "{\"timestamp\": \"%s\"}" % (now - timedelta(hours=2) - timedelta(minutes=1)) + self.check_data(RulesHelper().dash_dash_key_time(['timestamp,30m']), data, WARNING_CODE) + self.check_data(RulesHelper().dash_dash_key_time_critical(['timestamp,1h']), data, CRITICAL_CODE) + self.check_data(RulesHelper().dash_dash_key_time(['timestamp,3h']), data, OK_CODE) + self.check_data(RulesHelper().dash_dash_key_time_critical(['timestamp,2d']), data, OK_CODE) + + self.check_data(RulesHelper().dash_dash_key_time(['timestamp,@30m']), data, OK_CODE) + self.check_data(RulesHelper().dash_dash_key_time_critical(['timestamp,@1h']), data, OK_CODE) + self.check_data(RulesHelper().dash_dash_key_time(['timestamp,@3h']), data, WARNING_CODE) + self.check_data(RulesHelper().dash_dash_key_time_critical(['timestamp,@2d']), data, CRITICAL_CODE) + + self.check_data(RulesHelper().dash_dash_key_time(['timestamp,-30m']), data, OK_CODE) + self.check_data(RulesHelper().dash_dash_key_time_critical(['timestamp,-1h']), data, OK_CODE) + self.check_data(RulesHelper().dash_dash_key_time(['timestamp,-3h']), data, OK_CODE) + self.check_data(RulesHelper().dash_dash_key_time_critical(['timestamp,-2d']), data, OK_CODE) + + self.check_data(RulesHelper().dash_dash_key_time(['timestamp,@-30m']), data, WARNING_CODE) + self.check_data(RulesHelper().dash_dash_key_time_critical(['timestamp,@-1h']), data, CRITICAL_CODE) + self.check_data(RulesHelper().dash_dash_key_time(['timestamp,@-3h']), data, WARNING_CODE) + self.check_data(RulesHelper().dash_dash_key_time_critical(['timestamp,@-2d']), data, CRITICAL_CODE) + + # Test one day and one minute in the past. + data = "{\"timestamp\": \"%s\"}" % (now - timedelta(days=1) - timedelta(minutes=1)) + self.check_data(RulesHelper().dash_dash_key_time(['timestamp,30m']), data, WARNING_CODE) + self.check_data(RulesHelper().dash_dash_key_time_critical(['timestamp,1h']), data, CRITICAL_CODE) + self.check_data(RulesHelper().dash_dash_key_time(['timestamp,3h']), data, WARNING_CODE) + self.check_data(RulesHelper().dash_dash_key_time_critical(['timestamp,2d']), data, OK_CODE) + + self.check_data(RulesHelper().dash_dash_key_time(['timestamp,@30m']), data, OK_CODE) + self.check_data(RulesHelper().dash_dash_key_time_critical(['timestamp,@1h']), data, OK_CODE) + self.check_data(RulesHelper().dash_dash_key_time(['timestamp,@3h']), data, OK_CODE) + self.check_data(RulesHelper().dash_dash_key_time_critical(['timestamp,@2d']), data, CRITICAL_CODE) + + self.check_data(RulesHelper().dash_dash_key_time(['timestamp,-30m']), data, OK_CODE) + self.check_data(RulesHelper().dash_dash_key_time_critical(['timestamp,-1h']), data, OK_CODE) + self.check_data(RulesHelper().dash_dash_key_time(['timestamp,-3h']), data, OK_CODE) + self.check_data(RulesHelper().dash_dash_key_time_critical(['timestamp,-2d']), data, OK_CODE) + + self.check_data(RulesHelper().dash_dash_key_time(['timestamp,@-30m']), data, WARNING_CODE) + self.check_data(RulesHelper().dash_dash_key_time_critical(['timestamp,@-1h']), data, CRITICAL_CODE) + self.check_data(RulesHelper().dash_dash_key_time(['timestamp,@-3h']), data, WARNING_CODE) + self.check_data(RulesHelper().dash_dash_key_time_critical(['timestamp,@-2d']), data, CRITICAL_CODE) + + # Test two hours and one minute in the future. + data = "{\"timestamp\": \"%s\"}" % (now + timedelta(hours=2) + timedelta(minutes=1)) + self.check_data(RulesHelper().dash_dash_key_time(['timestamp,30m']), data, OK_CODE) + self.check_data(RulesHelper().dash_dash_key_time_critical(['timestamp,1h']), data, OK_CODE) + self.check_data(RulesHelper().dash_dash_key_time(['timestamp,3h']), data, OK_CODE) + self.check_data(RulesHelper().dash_dash_key_time_critical(['timestamp,2d']), data, OK_CODE) + + self.check_data(RulesHelper().dash_dash_key_time(['timestamp,@30m']), data, WARNING_CODE) + self.check_data(RulesHelper().dash_dash_key_time_critical(['timestamp,@1h']), data, CRITICAL_CODE) + self.check_data(RulesHelper().dash_dash_key_time(['timestamp,@3h']), data, WARNING_CODE) + self.check_data(RulesHelper().dash_dash_key_time_critical(['timestamp,@2d']), data, CRITICAL_CODE) + + self.check_data(RulesHelper().dash_dash_key_time(['timestamp,-30m']), data, WARNING_CODE) + self.check_data(RulesHelper().dash_dash_key_time_critical(['timestamp,-1h']), data, CRITICAL_CODE) + self.check_data(RulesHelper().dash_dash_key_time(['timestamp,-3h']), data, OK_CODE) + self.check_data(RulesHelper().dash_dash_key_time_critical(['timestamp,-2d']), data, OK_CODE) + + self.check_data(RulesHelper().dash_dash_key_time(['timestamp,@-30m']), data, OK_CODE) + self.check_data(RulesHelper().dash_dash_key_time_critical(['timestamp,@-1h']), data, OK_CODE) + self.check_data(RulesHelper().dash_dash_key_time(['timestamp,@-3h']), data, WARNING_CODE) + self.check_data(RulesHelper().dash_dash_key_time_critical(['timestamp,@-2d']), data, CRITICAL_CODE) + else: + data = "{\"timestamp\": \"2020-01-01\"}" + self.check_data(RulesHelper().dash_dash_key_time(['timestamp,30m']), data, WARNING_CODE) + self.check_data(RulesHelper().dash_dash_key_time_critical(['timestamp,1h']), data, CRITICAL_CODE) + self.check_data(RulesHelper().dash_dash_key_time(['timestamp,3h']), data, WARNING_CODE) + self.check_data(RulesHelper().dash_dash_key_time_critical(['timestamp,2d']), data, CRITICAL_CODE) + + self.check_data(RulesHelper().dash_dash_key_time(['timestamp,@30m']), data, OK_CODE) + self.check_data(RulesHelper().dash_dash_key_time_critical(['timestamp,@1h']), data, OK_CODE) + self.check_data(RulesHelper().dash_dash_key_time(['timestamp,@3h']), data, OK_CODE) + self.check_data(RulesHelper().dash_dash_key_time_critical(['timestamp,@2d']), data, OK_CODE) + + self.check_data(RulesHelper().dash_dash_key_time(['timestamp,-30m']), data, OK_CODE) + self.check_data(RulesHelper().dash_dash_key_time_critical(['timestamp,-1h']), data, OK_CODE) + self.check_data(RulesHelper().dash_dash_key_time(['timestamp,-3h']), data, OK_CODE) + self.check_data(RulesHelper().dash_dash_key_time_critical(['timestamp,-2d']), data, OK_CODE) + + self.check_data(RulesHelper().dash_dash_key_time(['timestamp,@-30m']), data, WARNING_CODE) + self.check_data(RulesHelper().dash_dash_key_time_critical(['timestamp,@-1h']), data, CRITICAL_CODE) + self.check_data(RulesHelper().dash_dash_key_time(['timestamp,@-3h']), data, WARNING_CODE) + self.check_data(RulesHelper().dash_dash_key_time_critical(['timestamp,@-2d']), data, CRITICAL_CODE)