From b920a65afd26565eea956f5bdab3bcf86d54980f Mon Sep 17 00:00:00 2001
From: aro-lew <114079388+aro-lew@users.noreply.github.com>
Date: Fri, 28 Jun 2024 14:39:57 +0200
Subject: [PATCH 01/10] Feature: Add Timestamp checks (#87)

---
 README.md                    |  51 ++++++++++++
 check_http_json.py           |  86 +++++++++++++++++++++
 test/test_check_http_json.py | 146 +++++++++++++++++++++++++++++++++++
 3 files changed, 283 insertions(+)

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 <host>:<port> -p <path> --key_time "metric,TIME"`
+* **Critical:** `./check_http_json.py -H <host>:<port> -p <path> --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 <host>:<port> -p <path> -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)

From 5c4a955abd8f87d54521045063697360ad04fd2c Mon Sep 17 00:00:00 2001
From: Markus Opolka <markus.opolka@netways.de>
Date: Fri, 28 Jun 2024 14:40:19 +0200
Subject: [PATCH 02/10] Fix object comparision

---
 check_http_json.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/check_http_json.py b/check_http_json.py
index e242431..257256f 100755
--- a/check_http_json.py
+++ b/check_http_json.py
@@ -369,7 +369,7 @@ class JsonRuleProcessor:
 
         now = datetime.now(timezone.utc)
 
-        if timestamp.tzinfo == None:
+        if timestamp.tzinfo is None:
             timestamp = timestamp.replace(tzinfo=timezone.utc)
 
         age = now - timestamp

From 9d344f5a7a6d52d25b634d0f2c5cbd4a556d3669 Mon Sep 17 00:00:00 2001
From: Markus Opolka <markus.opolka@netways.de>
Date: Mon, 29 Jul 2024 09:45:30 +0200
Subject: [PATCH 03/10] Add multiple key example to README

---
 README.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/README.md b/README.md
index aed5065..1b80eed 100644
--- a/README.md
+++ b/README.md
@@ -172,6 +172,22 @@ options:
         ]
     }
 
+
+**Data for multiple keys for an object** `-q capacity1.value,True capacity2.value,True capacity3.value,True`
+
+    {
+      "capacity1": {
+        "value": true
+      },
+      "capacity2": {
+        "value": true
+      },
+      "capacity3": {
+        "value": true
+      }
+    }
+
+
 ### Thresholds and Ranges
 
 **Data**:

From d3a2f3ed9ec43d657ec355783b1102630191b0da Mon Sep 17 00:00:00 2001
From: Markus Opolka <markus.opolka@netways.de>
Date: Mon, 29 Jul 2024 11:11:41 +0200
Subject: [PATCH 04/10] Improve error handling

 - Added another try-catch around the CLI Rules parsing
   to make sure that users get a clean exit code and error messages
---
 check_http_json.py | 12 ++++++++++--
 1 file changed, 10 insertions(+), 2 deletions(-)

diff --git a/check_http_json.py b/check_http_json.py
index 257256f..1ff1718 100755
--- a/check_http_json.py
+++ b/check_http_json.py
@@ -6,6 +6,7 @@ import json
 import argparse
 import sys
 import ssl
+import traceback
 from urllib.error import HTTPError
 from urllib.error import URLError
 from datetime import datetime, timedelta, timezone
@@ -720,6 +721,7 @@ def main(cliargs):
     json_data = ''
 
     try:
+        # Requesting the data from the URL
         json_data = make_request(args, url, context)
     except HTTPError as e:
         # Try to recover from HTTP Error, if there is JSON in the response
@@ -736,23 +738,29 @@ def main(cliargs):
         sys.exit(nagios.getCode())
 
     try:
+        # Loading the JSON data from the request
         data = json.loads(json_data)
     except ValueError as e:
+        debugPrint(args.debug, traceback.format_exc())
         nagios.append_message(UNKNOWN_CODE, " JSON Parser error: %s" % str(e))
     else:
         verbosePrint(args.verbose, 1, json.dumps(data, indent=2))
-        # Apply rules to returned JSON data
+
+    try:
+        # Applying rules to returned JSON data
         processor = JsonRuleProcessor(data, args)
         nagios.append_message(WARNING_CODE, processor.checkWarning())
         nagios.append_message(CRITICAL_CODE, processor.checkCritical())
         nagios.append_metrics(processor.checkMetrics())
         nagios.append_message(UNKNOWN_CODE, processor.checkUnknown())
+    except Exception as e: # pylint: disable=broad-exception-caught
+        debugPrint(args.debug, traceback.format_exc())
+        nagios.append_message(UNKNOWN_CODE, " Rule Parser error: %s" % str(e))
 
     # Print Nagios specific string and exit appropriately
     print(nagios.getMessage())
     sys.exit(nagios.getCode())
 
-
 if __name__ == "__main__":
     # Program entry point
     main(sys.argv[1:])

From 2a6d88bc39f6d977986628fbc2e5d0e9396ecc4c Mon Sep 17 00:00:00 2001
From: Markus Opolka <markus.opolka@netways.de>
Date: Wed, 9 Apr 2025 16:57:17 +0200
Subject: [PATCH 05/10] Add testdata to simplify integration testing

---
 test/testdata/README.md          | 63 ++++++++++++++++++++++++++++++++
 test/testdata/data0-invalid.json |  1 +
 test/testdata/data1.json         |  5 +++
 test/testdata/data2.json         | 17 +++++++++
 test/testdata/data3.json         | 18 +++++++++
 test/testdata/data4.json         | 13 +++++++
 test/testdata/data5.json         | 38 +++++++++++++++++++
 test/testdata/docker-compose.yml |  7 ++++
 8 files changed, 162 insertions(+)
 create mode 100644 test/testdata/README.md
 create mode 100644 test/testdata/data0-invalid.json
 create mode 100644 test/testdata/data1.json
 create mode 100644 test/testdata/data2.json
 create mode 100644 test/testdata/data3.json
 create mode 100644 test/testdata/data4.json
 create mode 100644 test/testdata/data5.json
 create mode 100644 test/testdata/docker-compose.yml

diff --git a/test/testdata/README.md b/test/testdata/README.md
new file mode 100644
index 0000000..a563ac8
--- /dev/null
+++ b/test/testdata/README.md
@@ -0,0 +1,63 @@
+# Example Data for Testing
+
+Example calls:
+
+```bash
+python check_http_json.py -H localhost:8080 -p data0.json -q "age,20"
+UNKNOWN: Status UNKNOWN. Could not find JSON in HTTP body.
+```
+
+```bash
+python check_http_json.py -H localhost:8080 -p data1.json -e date
+WARNING: Status WARNING. Key date did not exist.
+
+python check_http_json.py -H localhost:8080 -p data1.json -E age
+OK: Status OK.
+
+python check_http_json.py -H localhost:8080 -p data1.json -w "age,30"
+OK: Status OK.
+
+python check_http_json.py -H localhost:8080 -p data1.json -w "age,20"
+WARNING: Status WARNING. Value (30) for key age was outside the range 0:20.
+
+python check_http_json.py -H localhost:8080 -p data1.json -q "age,20"
+WARNING: Status WARNING. Key age mismatch. 20 != 30
+```
+
+```bash
+python check_http_json.py -H localhost:8080 -p data2.json -q "(1).id,123"
+WARNING: Status WARNING. Key (1).id mismatch. 123 != 2
+
+python check_http_json.py -H localhost:8080 -p data2.json -Y "(1).id,2"
+CRITICAL: Status CRITICAL. Key (1).id match found. 2 == 2
+
+python check_http_json.py -H localhost:8080 -p data2.json -E "(1).author"
+OK: Status OK.
+
+python check_http_json.py -H localhost:8080 -p data2.json -E "(1).pages"
+CRITICAL: Status CRITICAL. Key (1).pages did not exist.
+```
+
+```bash
+python check_http_json.py -H localhost:8080 -p data3.json -q "company.employees.(0).role,Developer"
+OK: Status OK.
+
+python check_http_json.py -H localhost:8080 -p data3.json -q "company.employees.(0).role,Dev"
+WARNING: Status WARNING. Key company.employees.(0).role mismatch. Dev != Developer
+
+python check_http_json.py -H localhost:8080 -p data3.json -q "company.employees.(0).role,Developer" "company.employees.(1).role,Designer" 
+OK: Status OK.
+```
+
+```bash
+python check_http_json.py -H localhost:8080 -p data4.json -u "ratings(0),4.5"
+OK: Status OK.
+
+python check_http_json.py -H localhost:8080 -p data4.json -u "ratings(0),4.1"
+UNKNOWN: Status UNKNOWN. Key ratings(0) mismatch. 4.1 != 4.5
+```
+
+```bash
+python check_http_json.py -H localhost:8080 -p data5.json -q service1.status,True service2.status,True service3.status,True
+OK: Status OK.
+```
diff --git a/test/testdata/data0-invalid.json b/test/testdata/data0-invalid.json
new file mode 100644
index 0000000..11dcdb1
--- /dev/null
+++ b/test/testdata/data0-invalid.json
@@ -0,0 +1 @@
+No JSON
diff --git a/test/testdata/data1.json b/test/testdata/data1.json
new file mode 100644
index 0000000..cf7fb75
--- /dev/null
+++ b/test/testdata/data1.json
@@ -0,0 +1,5 @@
+{
+  "name": "John Doe",
+  "age": 30,
+  "city": "New York"
+}
diff --git a/test/testdata/data2.json b/test/testdata/data2.json
new file mode 100644
index 0000000..a5c9dcd
--- /dev/null
+++ b/test/testdata/data2.json
@@ -0,0 +1,17 @@
+[
+  {
+    "id": 1,
+    "title": "Book One",
+    "author": "Author One"
+  },
+  {
+    "id": 2,
+    "title": "Book Two",
+    "author": "Author Two"
+  },
+  {
+    "id": 3,
+    "title": "Book Three",
+    "author": "Author Three"
+  }
+]
diff --git a/test/testdata/data3.json b/test/testdata/data3.json
new file mode 100644
index 0000000..dfde663
--- /dev/null
+++ b/test/testdata/data3.json
@@ -0,0 +1,18 @@
+{
+  "company": {
+    "name": "Tech Corp",
+    "location": "San Francisco",
+    "employees": [
+      {
+        "name": "Alice",
+        "role": "Developer"
+      },
+      {
+        "name": "Bob",
+        "role": "Designer"
+      }
+    ]
+  },
+  "founded": 2010,
+  "industry": "Technology"
+}
diff --git a/test/testdata/data4.json b/test/testdata/data4.json
new file mode 100644
index 0000000..6524bff
--- /dev/null
+++ b/test/testdata/data4.json
@@ -0,0 +1,13 @@
+{
+  "id": 123,
+  "active": true,
+  "tags": ["tech", "startup", "innovation"],
+  "details": {
+    "website": "https://example.com",
+    "contact": {
+      "email": "info@example.com",
+      "phone": "+1-234-567-890"
+    }
+  },
+  "ratings": [4.5, 4.7, 4.8]
+}
diff --git a/test/testdata/data5.json b/test/testdata/data5.json
new file mode 100644
index 0000000..c10a7ab
--- /dev/null
+++ b/test/testdata/data5.json
@@ -0,0 +1,38 @@
+{
+  "service1": {
+    "status": true
+  },
+  "service2": {
+    "status": true,
+    "meta": {
+      "res": "PONG"
+    }
+  },
+  "service3": {
+    "status": true,
+    "meta": {
+      "took": 9,
+      "timed_out": false,
+      "_shards": {
+        "total": 0,
+        "successful": 0,
+        "skipped": 0,
+        "failed": 0
+      },
+      "hits": {
+        "total": {
+          "value": 10000,
+          "relation": "gte"
+        },
+        "max_score": null,
+        "hits": []
+      }
+    }
+  },
+  "service4": {
+    "status": true,
+    "meta": {
+      "status": "ok"
+    }
+  }
+}
diff --git a/test/testdata/docker-compose.yml b/test/testdata/docker-compose.yml
new file mode 100644
index 0000000..cc3fab0
--- /dev/null
+++ b/test/testdata/docker-compose.yml
@@ -0,0 +1,7 @@
+services:
+  nginx:
+    image: nginx:1-alpine
+    ports:
+      - "8080:80"
+    volumes:
+      - ./:/usr/share/nginx/html

From afb2ef7b88d986c7882dc06c02026cd3e4995b6a Mon Sep 17 00:00:00 2001
From: Markus Opolka <markus.opolka@netways.de>
Date: Wed, 9 Apr 2025 17:15:19 +0200
Subject: [PATCH 06/10] Update README

- Improve structure a bit, moving the installation first and usage second
---
 README.md | 93 +++++++++++++++++++++++++------------------------------
 1 file changed, 42 insertions(+), 51 deletions(-)

diff --git a/README.md b/README.md
index 1b80eed..a6325ec 100644
--- a/README.md
+++ b/README.md
@@ -4,15 +4,50 @@
 
 This is a generic plugin for Nagios which checks json values from a given HTTP endpoint against argument specified rules and determines the status and performance data for that service.
 
-## Links
+## Installation
 
-* [CLI Usage](#cli-usage)
-* [Examples](#examples)
-    * [Riak Stats](docs/RIAK.md)
-    * [Docker](docs/DOCKER.md)
-* [Nagios Installation](#nagios-installation)
+Requirements:
 
-## CLI Usage
+* Python 3.6+
+
+### Nagios
+
+Assuming a standard installation of Nagios, the plugin can be executed from the machine that Nagios is running on.
+
+```bash
+cp check_http_json.py /usr/local/nagios/libexec/plugins/check_http_json.py
+chmod +x /usr/local/nagios/libexec/plugins/check_http_json.py
+```
+
+Add the following service definition to your server config (`localhost.cfg`):
+
+```
+
+define service {
+        use                             local-service
+        host_name                       localhost
+        service_description             <command_description>
+        check_command                   <command_name>
+        }
+
+```
+
+Add the following command definition to your commands config (`commands.config`):
+
+```
+
+define command{
+        command_name    <command_name>
+        command_line    /usr/bin/python /usr/local/nagios/libexec/plugins/check_http_json.py -H <host>:<port> -p <path> [-e|-q|-w|-c <rules>] [-m <metrics>]
+        }
+
+```
+
+### Icinga2
+
+An example Icinga2 command definition can be found here: (`contrib/icinga2_check_command_definition.conf`)
+
+## Usage
 
 Executing `./check_http_json.py -h` will yield the following details:
 
@@ -259,50 +294,6 @@ More info and examples the about Timestamp Format can be found at [https://docs.
 
 * `./check_http_json.py -H <host>:<port> -p <path> -A '{"content-type": "application/json"}' -w "metric,RANGE"`
 
-## Nagios Installation
-
-### Requirements
-
-* Python 3.6+
-
-### Configuration
-
-Assuming a standard installation of Nagios, the plugin can be executed from the machine that Nagios is running on.
-
-```bash
-cp check_http_json.py /usr/local/nagios/libexec/plugins/check_http_json.py
-chmod +x /usr/local/nagios/libexec/plugins/check_http_json.py
-```
-
-Add the following service definition to your server config (`localhost.cfg`):
-
-```
-
-define service {
-        use                             local-service
-        host_name                       localhost
-        service_description             <command_description>
-        check_command                   <command_name>
-        }
-
-```
-
-Add the following command definition to your commands config (`commands.config`):
-
-```
-
-define command{
-        command_name    <command_name>
-        command_line    /usr/bin/python /usr/local/nagios/libexec/plugins/check_http_json.py -H <host>:<port> -p <path> [-e|-q|-w|-c <rules>] [-m <metrics>]
-        }
-
-```
-
-## Icinga2 configuration
-
-The Icinga2 command definition can be found here: (contrib/icinga2_check_command_definition.conf)
-
-
 ## License
 
     Copyright 2014-2015 Drew Kerrigan.

From 3a1e7d90d09885308a3b23db4e615b5bf12479e2 Mon Sep 17 00:00:00 2001
From: Markus Opolka <markus.opolka@netways.de>
Date: Wed, 9 Apr 2025 17:18:34 +0200
Subject: [PATCH 07/10] Mention proxy variables in README

---
 README.md | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/README.md b/README.md
index a6325ec..dbb4e54 100644
--- a/README.md
+++ b/README.md
@@ -144,6 +144,8 @@ options:
                         (key[>alias],UnitOfMeasure), (key[>alias],UnitOfMeasure,WarnRange, CriticalRange).
 ```
 
+The check plugin respects the environment variables `HTTP_PROXY`, `HTTPS_PROXY`.
+
 ## Examples
 
 ### Key Naming

From c6daa09ba2c39b51917570a88a750ce6a4febdc8 Mon Sep 17 00:00:00 2001
From: Markus Opolka <markus.opolka@netways.de>
Date: Thu, 10 Apr 2025 16:52:59 +0200
Subject: [PATCH 08/10] Adds a CLI flag `invalid-json-state `to change exit
 code for invalid JSON

---
 README.md          |  4 +++-
 check_http_json.py | 12 +++++++++---
 2 files changed, 12 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index dbb4e54..da67522 100644
--- a/README.md
+++ b/README.md
@@ -93,7 +93,9 @@ options:
   -t TIMEOUT, --timeout TIMEOUT
                         Connection timeout (seconds)
   --unreachable-state UNREACHABLE_STATE
-                        Exit with specified code if URL unreachable. Examples: 1 for Warning, 2 for Critical, 3 for Unknown (default: 3)
+                        Exit with specified code when the URL is unreachable. Examples: 1 for Warning, 2 for Critical, 3 for Unknown (default: 3)
+  --invalid-json-state INVALID_JSON_STATE
+                        Exit with specified code when no valid JSON is returned. Examples: 1 for Warning, 2 for Critical, 3 for Unknown (default: 3)
   -B AUTH, --basic-auth AUTH
                         Basic auth string "username:password"
   -D DATA, --data DATA  The http payload to send as a POST
diff --git a/check_http_json.py b/check_http_json.py
index 1ff1718..cd47f4f 100755
--- a/check_http_json.py
+++ b/check_http_json.py
@@ -520,7 +520,9 @@ def parseArgs(args):
     parser.add_argument('-t', '--timeout', type=int,
                         help='Connection timeout (seconds)')
     parser.add_argument('--unreachable-state', type=int, default=3,
-                        help='Exit with specified code if URL unreachable. Examples: 1 for Warning, 2 for Critical, 3 for Unknown (default: 3)')
+                        help='Exit with specified code when the URL is unreachable. Examples: 1 for Warning, 2 for Critical, 3 for Unknown (default: 3)')
+    parser.add_argument('--invalid-json-state', type=int, default=3,
+                        help='Exit with specified code when no valid JSON is returned. Examples: 1 for Warning, 2 for Critical, 3 for Unknown (default: 3)')
     parser.add_argument('-B', '--basic-auth', dest='auth',
                         help='Basic auth string "username:password"')
     parser.add_argument('-D', '--data', dest='data',
@@ -728,7 +730,8 @@ def main(cliargs):
         if "json" in e.info().get_content_subtype():
             json_data = e.read()
         else:
-            nagios.append_message(UNKNOWN_CODE, " Could not find JSON in HTTP body. HTTPError[%s], url:%s" % (str(e.code), url))
+            exit_code = args.invalid_json_state
+            nagios.append_message(exit_code, " Could not find JSON in HTTP body. HTTPError[%s], url:%s" % (str(e.code), url))
     except URLError as e:
         # Some users might prefer another exit code if the URL wasn't reached
         exit_code = args.unreachable_state
@@ -741,8 +744,11 @@ def main(cliargs):
         # Loading the JSON data from the request
         data = json.loads(json_data)
     except ValueError as e:
+        exit_code = args.invalid_json_state
         debugPrint(args.debug, traceback.format_exc())
-        nagios.append_message(UNKNOWN_CODE, " JSON Parser error: %s" % str(e))
+        nagios.append_message(exit_code, " JSON Parser error: %s" % str(e))
+        print(nagios.getMessage())
+        sys.exit(nagios.getCode())
     else:
         verbosePrint(args.verbose, 1, json.dumps(data, indent=2))
 

From e15f0f01edf7ba61e0fe51d58cde085bf22592bb Mon Sep 17 00:00:00 2001
From: Markus Opolka <markus.opolka@netways.de>
Date: Fri, 11 Apr 2025 14:51:54 +0200
Subject: [PATCH 09/10] Update example data

---
 test/testdata/README.md | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/test/testdata/README.md b/test/testdata/README.md
index a563ac8..a95d778 100644
--- a/test/testdata/README.md
+++ b/test/testdata/README.md
@@ -45,7 +45,7 @@ OK: Status OK.
 python check_http_json.py -H localhost:8080 -p data3.json -q "company.employees.(0).role,Dev"
 WARNING: Status WARNING. Key company.employees.(0).role mismatch. Dev != Developer
 
-python check_http_json.py -H localhost:8080 -p data3.json -q "company.employees.(0).role,Developer" "company.employees.(1).role,Designer" 
+python check_http_json.py -H localhost:8080 -p data3.json -q "company.employees.(0).role,Developer" "company.employees.(1).role,Designer"
 OK: Status OK.
 ```
 
@@ -60,4 +60,6 @@ UNKNOWN: Status UNKNOWN. Key ratings(0) mismatch. 4.1 != 4.5
 ```bash
 python check_http_json.py -H localhost:8080 -p data5.json -q service1.status,True service2.status,True service3.status,True
 OK: Status OK.
+
+python check_http_json.py -H localhost:8080 -p data5.json -q "service1.status,True" -q "service2.status,True" -q "service3.status,False"
 ```

From 186f081cd72f6cab193cd0f29b2a04b53456e166 Mon Sep 17 00:00:00 2001
From: Markus Opolka <markus.opolka@netways.de>
Date: Fri, 11 Apr 2025 15:30:36 +0200
Subject: [PATCH 10/10] Bump version

---
 check_http_json.py | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/check_http_json.py b/check_http_json.py
index cd47f4f..4f49f62 100755
--- a/check_http_json.py
+++ b/check_http_json.py
@@ -25,8 +25,8 @@ WARNING_CODE = 1
 CRITICAL_CODE = 2
 UNKNOWN_CODE = 3
 
-__version__ = '2.2.0'
-__version_date__ = '2024-05-14'
+__version__ = '2.3.0'
+__version_date__ = '2025-04-11'
 
 class NagiosHelper:
     """