Merge pull request #975 from julep-ai/c/healthz-endpoint

chore(agents-api): Add `/healthz` endpoint

agents-api/agents_api/routers/healthz/__init__.py

@@ -0,0 +1,3 @@
+# ruff: noqa: F401
+from .check_health import check_health
+from .router import router

agents-api/agents_api/routers/healthz/check_health.py

@@ -0,0 +1,20 @@
+import logging
+from uuid import UUID
+
+from ...autogen.openapi_model import Agent, ListResponse
+from ...models.agent.list_agents import list_agents as list_agents_query
+from .router import router
+
+
+@router.get("/healthz", tags=["healthz"])
+async def check_health() -> dict:
+    try:
+        # Check if the database is reachable
+        agents = list_agents_query(
+            developer_id=UUID("00000000-0000-0000-0000-000000000000"),
+        )
+    except Exception as e:
+        logging.error("An error occurred while checking health: %s", str(e))
+        return {"status": "error", "message": "An internal error has occurred."}
+
+    return {"status": "ok"}

agents-api/agents_api/routers/healthz/router.py

@@ -0,0 +1,3 @@
+from fastapi import APIRouter
+
+router: APIRouter = APIRouter()

agents-api/agents_api/web.py

@@ -28,6 +28,7 @@
     agents,
     docs,
     files,
+    healthz,
     internal,
     jobs,
     sessions,
@@ -188,6 +189,7 @@ async def scalar_html():
 app.include_router(docs.router, dependencies=[Depends(get_api_key)])
 app.include_router(tasks.router, dependencies=[Depends(get_api_key)])
 app.include_router(internal.router)
+app.include_router(healthz.router)
 
 # TODO: CORS should be enabled only for JWT auth
 #

gateway/traefik.yml.template

@@ -46,8 +46,17 @@ http:
       middlewares:
         - agents-api-strip-prefix-api
       service: service-agents-api
-      priority: 2 
-
+      priority: 2
+
+    agents-api-healthz:
+      entryPoints:
+        - web
+      rule: Path(`/api/healthz`)
+      middlewares:
+        - agents-api-strip-prefix-api
+      service: service-agents-api
+      priority: 3
+
     agents-api-redirect-to-docs:
       entryPoints:
         - web