feat: healthz health check

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## [2.0.4] - 2024-11-20
+### Added
+- Added `/healthz` endpoint to check the health of the server for use in Kubernetes liveness and readiness probes
+
 ## [2.0.3] - 2024-11-18
 ### Added
 - Added ability to back up persistent data to AWS S3 compatible storage

Dockerfile

@@ -34,5 +34,8 @@ COPY backend/ /app/
 EXPOSE 8000
 EXPOSE 19132/udp
 
+# Healthcheck to ensure the container is healthy
+HEALTHCHECK --interval=30s --timeout=30s --start-period=5s --retries=3 CMD wget --quiet --tries=1 --spider http://localhost:8000/healthz || exit 1
+
 # Define the entry point for the container
-CMD ["python", "main.py"]
+CMD ["python", "main.py"]

backend/web_server.py

@@ -138,6 +138,12 @@ async def save_data():
     except Exception as e:
         logging.error(f"Error saving data: {e}")
         raise HTTPException(status_code=500, detail=str(e))
+
+
+# Health check liveliness and readiness probe for k8s compatibility
+@app.get('/healthz')
+async def health_check():
+    return {'status': 'ok'}
 
 
 # WebSocket endpoint for data streaming