Consolidate logging in its own module

Author: bowenwr

examples/chem-sync-local-flask/docker-compose.yaml

@@ -12,6 +12,8 @@ services:
     environment:
       # Don't set debug in production!
       - FLASK_DEBUG=1
+      # Enable debug logging for Python Benchling App. This is not native, specific to this example implementation
+      - BENCHLING_APP_LOG_LEVEL=DEBUG
       # Client ID is not sensitive and is the same across all tenants, so could be hard-coded
       # You might choose to have two different Apps for dev vs prod, which would have different client IDs
       - CLIENT_ID

examples/chem-sync-local-flask/local_app/app.py

@@ -1,14 +1,12 @@
-import logging
 from threading import Thread
 
 from benchling_sdk.apps.helpers.webhook_helpers import verify_app_installation
 from flask import Flask, request
 
 from local_app.benchling_app.handler import handle_webhook
+from local_app.lib.logger import get_logger
 
-# Enable basic logging for development debugging
-logging.basicConfig(format="%(name)s - %(asctime)s - %(message)s", level=logging.DEBUG)
-logger = logging.getLogger(__name__)
+logger = get_logger()
 
 
 def create_app() -> Flask:

examples/chem-sync-local-flask/local_app/benchling_app/canvas_interaction.py

@@ -1,4 +1,3 @@
-import logging
 import re
 from typing import cast
 from urllib.parse import quote
@@ -20,9 +19,10 @@
     SEARCH_BUTTON_ID,
     SEARCH_TEXT_ID,
 )
+from local_app.lib.logger import get_logger
 from local_app.lib.pub_chem import get_by_cid, search
 
-logger = logging.getLogger(__name__)
+logger = get_logger()
 
 
 class UnsupportedButtonError(Exception):

examples/chem-sync-local-flask/local_app/benchling_app/handler.py

@@ -1,4 +1,3 @@
-import logging
 from typing import Any
 
 from benchling_sdk.models.webhooks.v0 import (
@@ -10,8 +9,9 @@
 from local_app.benchling_app.canvas_interaction import route_interaction_webhook
 from local_app.benchling_app.setup import init_app_from_webhook
 from local_app.benchling_app.views.canvas_initialize import render_search_canvas
+from local_app.lib.logger import get_logger
 
-logger = logging.getLogger(__name__)
+logger = get_logger()
 
 
 class UnsupportedWebhookError(Exception):

examples/chem-sync-local-flask/local_app/benchling_app/molecules.py

@@ -1,4 +1,3 @@
-import logging
 from typing import Any
 
 from benchling_sdk.apps.framework import App
@@ -10,7 +9,9 @@
     MoleculeStructureStructureFormat,
 )
 
-logger = logging.getLogger(__name__)
+from local_app.lib.logger import get_logger
+
+logger = get_logger()
 
 
 def create_molecule(app: App, chemical_result: dict[str, Any]) -> Molecule:

examples/chem-sync-local-flask/local_app/lib/logger.py

@@ -0,0 +1,15 @@
+import logging
+import os
+
+# Enable basic logging for development debugging
+logging.basicConfig(format="%(name)s - %(asctime)s - {%(pathname)s:%(lineno)d} - %(message)s",
+                    level=logging.WARNING)
+
+
+# Get a logger for our App, with DEBUG enabled by default specifically for our logging
+# but not other libraries
+def get_logger(name: str = "benchling-app") -> logging.Logger:
+    level = os.environ.get("BENCHLING_APP_LOG_LEVEL", "INFO").upper()
+    logger = logging.getLogger(name)
+    logger.setLevel(level)
+    return logger