Added key_days_to_expire value to output

Author: laitco

.github/workflows/publish-image.yaml

@@ -27,14 +27,14 @@ jobs:
         run: |
           docker push laitco/tailscale-healthcheck:latest
 
-      - name: Build Docker image 1.2.1
+      - name: Build Docker image 1.2.2
         run: |
-          docker build -t laitco/tailscale-healthcheck:1.2.1 .
+          docker build -t laitco/tailscale-healthcheck:1.2.2 .
 
-      - name: Validate Docker image 1.2.1
+      - name: Validate Docker image 1.2.2
         run: |
-          docker run --rm laitco/tailscale-healthcheck:1.2.1 --help
+          docker run --rm laitco/tailscale-healthcheck:1.2.2 --help
 
-      - name: Push Docker image 1.2.1
+      - name: Push Docker image 1.2.2
         run: |
-          docker push laitco/tailscale-healthcheck:1.2.1
+          docker push laitco/tailscale-healthcheck:1.2.2

README.md

@@ -48,6 +48,7 @@ A Python-based Flask application to monitor the health of devices in a Tailscale
 - **Overall Health Status**: Combined health status based on:
   - Device online status (`online_healthy`)
   - Device key expiry status (`key_healthy`)
+  - Days until key expiry (`key_days_to_expire`)
 - **Global Health Metrics**: 
   - Global device health status (`global_healthy`)
   - Global online status (`global_online_healthy`)
@@ -61,6 +62,10 @@ A Python-based Flask application to monitor the health of devices in a Tailscale
 
 ## 📝 Release Notes
 
+### 1.2.2
+- Added `key_days_to_expire` field showing the number of days until a device's key expires
+- Set to `null` when key expiry is disabled
+
 ### 1.2.1
 - Added global health metrics with configurable thresholds
   - GLOBAL_HEALTHY_THRESHOLD (default: 100)
@@ -130,6 +135,7 @@ Returns the health status of all devices.
       "keyExpiryDisabled": false,
       "keyExpiryTimestamp": "2025-05-09T22:03:57+02:00",
       "key_healthy": true,
+      "key_days_to_expire": 25,
       "healthy": true
     }
   ],
@@ -323,7 +329,7 @@ endpoints:
     interval: 5m
     conditions:
       - "[STATUS] == 200"
-      - "[BODY].healthy == pat(*true*)"
+      - "[BODY].device.healthy == pat(*true*)"
     alerts:
       - type: email
         failure-threshold: 2
@@ -340,7 +346,7 @@ endpoints:
 - **`interval`**: The frequency of the healthcheck (e.g., every 5 minutes).
 - **`conditions`**:
   - `[STATUS] == 200`: Ensures the HTTP status code is `200`.
-  - `[BODY].healthy == pat(*true*)`: Checks if the `healthy` field in the response body is `true`.
+  - `[BODY].device.healthy == pat(*true*)`: Checks if the `healthy` field in the response body is `true`.
 - **`alerts`**:
   - **`type`**: The type of alert (e.g., `email`).
   - **`failure-threshold`**: The number of consecutive failures before triggering an alert.

healthcheck.py

@@ -161,11 +161,13 @@ def health_check():
             last_seen_local = last_seen.astimezone(tz)
             expires = None
             key_healthy = True if device.get("keyExpiryDisabled", False) else True
+            key_days_to_expire = None
             if not device.get("keyExpiryDisabled", False) and device.get("expires"):
                 expires = datetime.strptime(device["expires"], "%Y-%m-%dT%H:%M:%SZ").replace(tzinfo=pytz.UTC)
                 expires = expires.astimezone(tz)
                 time_until_expiry = expires - datetime.now(tz)
                 key_healthy = time_until_expiry.total_seconds() / 60 > KEY_THRESHOLD_MINUTES
+                key_days_to_expire = time_until_expiry.days
 
             online_is_healthy = last_seen_local >= threshold_time
             is_healthy = online_is_healthy and key_healthy
@@ -196,6 +198,7 @@ def health_check():
                 "online_healthy": online_is_healthy,
                 "keyExpiryDisabled": device.get("keyExpiryDisabled", False),
                 "key_healthy": key_healthy,
+                "key_days_to_expire": key_days_to_expire,
                 "healthy": is_healthy
             }
 
@@ -277,11 +280,13 @@ def health_check_by_identifier(identifier):
                 last_seen_local = last_seen.astimezone(tz)  # Convert lastSeen to the specified timezone
                 expires = None
                 key_healthy = True if device.get("keyExpiryDisabled", False) else True
+                key_days_to_expire = None
                 if not device.get("keyExpiryDisabled", False) and device.get("expires"):
                     expires = datetime.strptime(device["expires"], "%Y-%m-%dT%H:%M:%SZ").replace(tzinfo=pytz.UTC)
                     expires = expires.astimezone(tz)
                     time_until_expiry = expires - datetime.now(tz)
                     key_healthy = time_until_expiry.total_seconds() / 60 > KEY_THRESHOLD_MINUTES
+                    key_days_to_expire = time_until_expiry.days
 
                 logging.debug(f"Device {device['name']} last seen (local): {last_seen_local.isoformat()}")
                 online_is_healthy = last_seen_local >= threshold_time
@@ -304,6 +309,7 @@ def health_check_by_identifier(identifier):
                     "online_healthy": online_is_healthy,
                     "keyExpiryDisabled": device.get("keyExpiryDisabled", False),
                     "key_healthy": key_healthy,
+                    "key_days_to_expire": key_days_to_expire,
                     "healthy": online_is_healthy and key_healthy
                 }
 
@@ -373,11 +379,13 @@ def health_check_unhealthy():
             last_seen_local = last_seen.astimezone(tz)  # Convert lastSeen to the specified timezone
             expires = None
             key_healthy = True if device.get("keyExpiryDisabled", False) else True
+            key_days_to_expire = None
             if not device.get("keyExpiryDisabled", False) and device.get("expires"):
                 expires = datetime.strptime(device["expires"], "%Y-%m-%dT%H:%M:%SZ").replace(tzinfo=pytz.UTC)
                 expires = expires.astimezone(tz)
                 time_until_expiry = expires - datetime.now(tz)
                 key_healthy = time_until_expiry.total_seconds() / 60 > KEY_THRESHOLD_MINUTES
+                key_days_to_expire = time_until_expiry.days
 
             logging.debug(f"Device {device['name']} last seen (local): {last_seen_local.isoformat()}")
             online_is_healthy = last_seen_local >= threshold_time
@@ -405,6 +413,7 @@ def health_check_unhealthy():
                     "online_healthy": online_is_healthy,
                     "keyExpiryDisabled": device.get("keyExpiryDisabled", False),
                     "key_healthy": key_healthy,
+                    "key_days_to_expire": key_days_to_expire,
                     "healthy": online_is_healthy and key_healthy
                 }
 
@@ -472,11 +481,13 @@ def health_check_healthy():
             last_seen_local = last_seen.astimezone(tz)  # Convert lastSeen to the specified timezone
             expires = None
             key_healthy = True if device.get("keyExpiryDisabled", False) else True
+            key_days_to_expire = None
             if not device.get("keyExpiryDisabled", False) and device.get("expires"):
                 expires = datetime.strptime(device["expires"], "%Y-%m-%dT%H:%M:%SZ").replace(tzinfo=pytz.UTC)
                 expires = expires.astimezone(tz)
                 time_until_expiry = expires - datetime.now(tz)
                 key_healthy = time_until_expiry.total_seconds() / 60 > KEY_THRESHOLD_MINUTES
+                key_days_to_expire = time_until_expiry.days
 
             logging.debug(f"Device {device['name']} last seen (local): {last_seen_local.isoformat()}")
             online_is_healthy = last_seen_local >= threshold_time
@@ -498,6 +509,7 @@ def health_check_healthy():
                     "online_healthy": online_is_healthy,
                     "keyExpiryDisabled": device.get("keyExpiryDisabled", False),
                     "key_healthy": key_healthy,
+                    "key_days_to_expire": key_days_to_expire,
                     "healthy": online_is_healthy and key_healthy
                 }