feat: Add a health check.

docker/Dockerfile

@@ -38,7 +38,7 @@ COPY --from=builder /opt/venv /opt/venv
 ENV PATH=/opt/venv/bin:$PATH
 
 # Download space models.
-RUN mkdir -p /opt/models && \
+RUN mkdir -p /var/log/uvicorn /opt/models  && \
   python3 -m spacy download en_core_web_sm && \
   python3 -m spacy download es_core_news_sm && \
   python3 -m spacy download fr_core_news_sm

html/app.py

@@ -121,6 +121,28 @@ class Response(BaseModel):
 
 #------------------------------------------------------------------------------#
 
+class HealthCheckResponse(BaseModel):
+    """
+    Health check response.
+
+    Attributes:
+        status (str): the health status of the app, defaults to "ok".
+    """
+    status: str
+
+# Health check endpoint.
+@app.get('/status', status_code=200)
+def health_status() -> HealthCheckResponse:
+    """
+    A very simple health check endpoint.
+
+    Returns:
+        HealthCheckResponse: the health check response.
+    """
+    return HealthCheckResponse(status="ok")
+
+#------------------------------------------------------------------------------#
+
 class TextSplitRequest(Request):
     """
     A text splitting request.

html/log_config.yaml

@@ -0,0 +1,38 @@
+version: 1
+disable_existing_loggers: False
+formatters:
+  default:
+    "()": uvicorn.logging.DefaultFormatter
+    format: '%(asctime)s - %(name)s - %(levelname)s - %(message)s'
+  access:
+    "()": uvicorn.logging.AccessFormatter
+    format: "[%(asctime)s %(process)d:%(threadName)s] %(name)s - %(levelname)s - %(message)s | %(filename)s:%(lineno)d"
+
+handlers:
+  default:
+    class: logging.FileHandler
+    level: INFO
+    formatter: default
+    filename: /var/log/uvicorn/uvicorn.log
+    encoding: utf8
+    mode: a
+
+  access:
+    formatter: access
+    class: logging.FileHandler
+    level: INFO
+    formatter: default
+    filename: /var/log/uvicorn/access.log
+    encoding: utf8
+    mode: a
+
+loggers:
+  uvicorn.error:
+    level: INFO
+    handlers: [default]
+    propagate: no
+
+  uvicorn.access:
+    level: INFO
+    handlers: [access]
+    propagate: no

html/server.sh

@@ -4,4 +4,5 @@
 uvicorn app:app \
   --host ${SERVER_HOST:-0.0.0.0} \
   --port ${SERVER_PORT:-80} \
+  --log-config=log_config.yaml \
   --reload