feat: create healthchecks api (#133)

create a new api route /health which return in json the status of the different services

Fixes: #67 Add a health endpoint

app/api.py

@@ -5,7 +5,7 @@
 
 import elasticsearch
 from elasticsearch_dsl import Search
-from fastapi import FastAPI, HTTPException, Query, Request
+from fastapi import FastAPI, HTTPException, Query, Request, Response
 from fastapi.middleware.cors import CORSMiddleware
 from fastapi.responses import HTMLResponse, PlainTextResponse
 from fastapi.templating import Jinja2Templates
@@ -319,3 +319,12 @@ def html_search(
 @app.get("/robots.txt", response_class=PlainTextResponse)
 def robots_txt():
     return """User-agent: *\nDisallow: /"""
+
+
+@app.get("/health")
+def healthcheck():
+    from app.health import health
+
+    message, status, _ = health.run()
+    logger.warning("HEALTH:", message, status)
+    return Response(content=message, status_code=status, media_type="application/json")

app/health.py

@@ -0,0 +1,27 @@
+from healthcheck import HealthCheck
+
+from app.utils import connection, get_logger
+
+logger = get_logger(__name__)
+
+health = HealthCheck()
+
+
+def test_connect_redis():
+    logger.debug("health: testing redis connection")
+    client = connection.get_redis_client(socket_connect_timeout=5)
+    if client.ping():
+        return True, "Redis connection check succedded!"
+    return False, "Redis connection check failed!"
+
+
+def test_connect_es():
+    logger.debug("health: testing es connection")
+    es = connection.get_es_client(timeout=5)
+    if es.ping():
+        return True, "es0 connection check succedded!"
+    return False, "es0 connection check failed!"
+
+
+health.add_check(test_connect_redis)
+health.add_check(test_connect_es)

app/utils/connection.py

@@ -11,9 +11,10 @@ def get_es_client(**kwargs):
     )
 
 
-def get_redis_client() -> Redis:
+def get_redis_client(**kwargs) -> Redis:
     return Redis(
         host=settings.redis_host,
         port=settings.redis_port,
         decode_responses=True,
+        **kwargs,
     )