Added docker healthcheck route, and updated logging filter

Author: nb-programmer

Dockerfile

@@ -53,4 +53,4 @@ RUN chmod +x ./entrypoint.sh ./dependencies.sh
 
 ENTRYPOINT ["./entrypoint.sh"]
 
-HEALTHCHECK --interval=30s --timeout=30s --start-period=30s --retries=20 CMD curl --include --request GET http://localhost:8000/health || exit 1
+HEALTHCHECK --interval=30s --timeout=30s --start-period=30s --retries=20 CMD curl --include --request GET http://localhost:8000/health/healthcheck || exit 1

config/debug-logger.yml

@@ -43,6 +43,13 @@ formatters:
     use_colors: false
 
 
+filters:
+  healthcheck_filter:
+    # Filter for the `/health/healthcheck` endpoint.
+    "()": sample_fastapi.app.resources.docker_health.HealthCheckFilter
+    name: "uvicorn.access"
+
+
 handlers:
   # Root logger
   global_console:
@@ -85,6 +92,9 @@ handlers:
   uvicorn_access_console:
     class: logging.StreamHandler
     formatter: uvicorn_access_console_fmt
+    filters:
+      # Filters out annoying healthcheck pings
+      - healthcheck_filter
 
     # Arguments
     stream: ext://sys.stdout
@@ -104,6 +114,9 @@ handlers:
   uvicorn_access_file:
     class: logging.handlers.TimedRotatingFileHandler
     formatter: uvicorn_access_file_fmt
+    filters:
+      # Filters out annoying healthcheck pings
+      - healthcheck_filter
 
     # Arguments
     filename: *uvicorn_access_log_file

examples/deploy/config/server-logger-config.yml

@@ -43,6 +43,13 @@ formatters:
     use_colors: false
 
 
+filters:
+  healthcheck_filter:
+    # Filter for the `/health/healthcheck` endpoint.
+    "()": sample_fastapi.app.resources.docker_health.HealthCheckFilter
+    name: "uvicorn.access"
+
+
 handlers:
   # Root logger
   global_console:
@@ -85,6 +92,9 @@ handlers:
   uvicorn_access_console:
     class: logging.StreamHandler
     formatter: uvicorn_access_console_fmt
+    filters:
+      # Filters out annoying healthcheck pings
+      - healthcheck_filter
 
     # Arguments
     stream: ext://sys.stdout
@@ -104,6 +114,9 @@ handlers:
   uvicorn_access_file:
     class: logging.handlers.TimedRotatingFileHandler
     formatter: uvicorn_access_file_fmt
+    filters:
+      # Filters out annoying healthcheck pings
+      - healthcheck_filter
 
     # Arguments
     filename: *uvicorn_access_log_file

examples/deploy/docker-compose.yml

@@ -1,6 +1,6 @@
 services:
   server:
-    image: ghcr.io/nb-programmer/sample-fastapi:latest
+    image: sample-fastapi:latest
 
     command:
       - "--host=0.0.0.0"

sample_fastapi/app/resources/docker_health/__init__.py

@@ -0,0 +1,4 @@
+from .logging import HealthCheckFilter
+from .routes import init_app, init_routes
+
+__all__ = ["init_app", "init_routes", "HealthCheckFilter"]

sample_fastapi/app/resources/docker_health/logging.py

@@ -0,0 +1,17 @@
+import logging
+from collections.abc import Mapping
+
+
+class HealthCheckFilter(logging.Filter):
+    """Filter out healthcheck access logs from uvicorn.access module"""
+
+    HEALTHCHECK_ROUTE = "/health/healthcheck"
+
+    def filter(self, record: logging.LogRecord) -> bool:
+        # Check if the log message arguments contain our healthcheck route
+        if isinstance(record.args, tuple):
+            return self.HEALTHCHECK_ROUTE not in record.args
+        elif isinstance(record.args, Mapping):
+            return self.HEALTHCHECK_ROUTE not in record.args.values()
+
+        return True

sample_fastapi/app/resources/docker_health/models.py

@@ -0,0 +1,11 @@
+from enum import Enum
+
+from pydantic import BaseModel
+
+
+class HealthCheckStatus(str, Enum):
+    OK = "ok"
+
+
+class HealthcheckResponse(BaseModel):
+    status: HealthCheckStatus = HealthCheckStatus.OK

sample_fastapi/app/resources/docker_health/routes.py

@@ -0,0 +1,15 @@
+from fastapi import APIRouter, FastAPI
+
+from .views import respond_healthcheck
+
+
+def init_routes():
+    router = APIRouter(prefix="/health", tags=["health"])
+
+    router.add_api_route("/healthcheck", respond_healthcheck, methods={"GET"})
+
+    return router
+
+
+def init_app(app: FastAPI):
+    app.include_router(init_routes())

sample_fastapi/app/resources/docker_health/views.py

@@ -0,0 +1,6 @@
+from .models import HealthcheckResponse, HealthCheckStatus
+
+
+async def respond_healthcheck() -> HealthcheckResponse:
+    """Docker healthcheck response to validate if the app is up"""
+    return HealthcheckResponse(status=HealthCheckStatus.OK)

sample_fastapi/app/resources/routes.py

@@ -3,7 +3,8 @@
 
 def init_app(app: FastAPI):
     """Initialize routes, middleware, sub-apps, etc. to the given Application"""
-    from . import calculator, hello, user
+    from . import calculator, docker_health, hello, user
+    docker_health.init_app(app)
     hello.init_app(app)
     calculator.init_app(app)
     user.init_app(app)