implemented simple logging (#14)

* implemented simple logging

* added helm values for logging information, which get set as environment variables in the created container. These then get picked up by pydantic BaseSettings and used to set logging config, with a try/except block to catch invalid settings and set a default logger.

* fixed typo logging-> logger inside middleware

Author: rosesyrett

helm/diffcalc-api/templates/deployment.yaml

@@ -36,6 +36,10 @@ spec:
           env: 
             - name: mongo_url
               value: {{ include "diffcalc-api.mongoUrl" . }}
+            - name: logging_level
+              value: {{ .Values.logging.level }}
+            - name: logging_format
+              value: {{ .Values.logging.format }}
           ports:
             - name: http
               containerPort: 8000

helm/diffcalc-api/values.yaml

@@ -94,3 +94,7 @@ mongodb:
       cpu: 2
     requests:
       cpu: 1
+
+logging:
+  level: "WARN"
+  format: "[%(asctime)s] %(levelname)s:%(message)s"

src/diffcalc_API/config.py

@@ -1,7 +1,36 @@
+import logging
+
 from pydantic import BaseSettings
 
 from ._version_git import __version__
 
+release = __version__
+
+# The short X.Y version.
+if "+" in release:
+    # Not on a tag
+    version = "master"
+else:
+    version = release
+
+
+class Settings(BaseSettings):
+    mongo_url: str = "localhost:27017"
+    api_version = version
+    logging_level: str = "WARN"
+    logging_format: str = "[%(asctime)s] %(levelname)s:%(message)s"
+
+
+settings = Settings()
+try:
+    logging.basicConfig(level=settings.logging_level, format=settings.logging_format)
+except ValueError:
+    logging.basicConfig(level="WARN")
+    logging.warn(
+        f"{settings.logging_level} is not a valid logging level "
+        + "(See logging python library for details). Initializing basic logging."
+    )
+
 SAVE_PICKLES_FOLDER = "/"
 VECTOR_PROPERTIES = ["n_hkl", "n_phi", "surf_nhkl", "surf_nphi"]
 CONSTRAINTS_WITH_NO_VALUE = {"a_eq_b", "bin_eq_bout", "mu_is_gam", "bisect"}
@@ -26,17 +55,3 @@
     "bisect",
     "omega",
 }
-
-release = __version__
-
-# The short X.Y version.
-if "+" in release:
-    # Not on a tag
-    version = "master"
-else:
-    version = release
-
-
-class Settings(BaseSettings):
-    mongo_url: str = "localhost:27017"
-    api_version = version

src/diffcalc_API/server.py

@@ -1,3 +1,4 @@
+import logging
 import traceback
 from typing import Optional
 
@@ -12,8 +13,8 @@
 from diffcalc_API.errors.ub import responses as ub_responses
 from diffcalc_API.stores.protocol import get_store, setup_store
 
+logger = logging.getLogger(__name__)
 config = Settings()
-
 setup_store("diffcalc_API.stores.mongo.MongoHklCalcStore")
 
 app = FastAPI(
@@ -31,6 +32,9 @@
 
 @app.exception_handler(DiffcalcException)
 async def diffcalc_exception_handler(request: Request, exc: DiffcalcException):
+    tb = traceback.format_exc()
+    logger.warn(f"Diffcalc Exception caught by middleware: {tb}")
+
     return responses.JSONResponse(
         status_code=400,
         content={"message": str(exc), "type": str(type(exc))},
@@ -39,6 +43,9 @@ async def diffcalc_exception_handler(request: Request, exc: DiffcalcException):
 
 @app.exception_handler(DiffcalcAPIException)
 async def http_exception_handler(request: Request, exc: DiffcalcAPIException):
+    tb = traceback.format_exc()
+    logger.error(f"Diffcalc API Exception caught by middleware: {tb}")
+
     return responses.JSONResponse(
         status_code=exc.status_code,
         content={"message": exc.detail, "type": str(type(exc))},
@@ -50,9 +57,8 @@ async def server_exceptions_middleware(request: Request, call_next):
     try:
         return await call_next(request)
     except Exception as e:
-        # TODO: implement proper logging
         tb = traceback.format_exc()
-        print(tb)
+        logger.error(f"General Exception caught by middleware: {tb}")
 
         return responses.JSONResponse(
             status_code=500,