logging update

Author: Marko Hietala

src/api/main.py

@@ -18,18 +18,10 @@
 from fastapi.responses import JSONResponse
 from dotenv import load_dotenv
 
-# Create a central logger for the application
-logger = logging.getLogger("azureaiapp")
-logger.setLevel(logging.INFO)
-
-# Configure the stream handler (stdout)
-stream_handler = logging.StreamHandler(sys.stdout)
-stream_handler.setLevel(logging.INFO)
-stream_formatter = logging.Formatter("%(asctime)s [%(levelname)s] %(name)s: %(message)s")
-stream_handler.setFormatter(stream_formatter)
-logger.addHandler(stream_handler)
+from logging_config import configure_logging
 
 enable_trace = False
+logger = None
 
 @contextlib.asynccontextmanager
 async def lifespan(app: fastapi.FastAPI):
@@ -103,14 +95,8 @@ def create_app():
     if not os.getenv("RUNNING_IN_PRODUCTION"):
         load_dotenv(override=True)
 
-    # Configure logging to file, if log file name is provided
-    log_file_name = os.getenv("APP_LOG_FILE", "")
-    if log_file_name != "":
-        file_handler = logging.FileHandler(log_file_name)
-        file_handler.setLevel(logging.INFO)
-        file_formatter = logging.Formatter("%(asctime)s [%(levelname)s] %(name)s: %(message)s")
-        file_handler.setFormatter(file_formatter)
-        logger.addHandler(file_handler)
+    global logger
+    logger = configure_logging(os.getenv("APP_LOG_FILE", ""))
 
     enable_trace_string = os.getenv("ENABLE_AZURE_MONITOR_TRACING", "")
     global enable_trace

src/gunicorn.conf.py

@@ -11,27 +11,11 @@
 
 from dotenv import load_dotenv
 
+from logging_config import configure_logging
+
 load_dotenv()
 
-# Create a central logger for the application
-logger = logging.getLogger("azureaiapp")
-logger.setLevel(logging.INFO)
-
-# Configure the stream handler (stdout)
-stream_handler = logging.StreamHandler(sys.stdout)
-stream_handler.setLevel(logging.INFO)
-stream_formatter = logging.Formatter("%(asctime)s [%(levelname)s] %(name)s: %(message)s")
-stream_handler.setFormatter(stream_formatter)
-logger.addHandler(stream_handler)
-
-# Configure logging to file, if log file name is provided
-log_file_name = os.getenv("APP_LOG_FILE", "")
-if log_file_name != "":
-    file_handler = logging.FileHandler(log_file_name)
-    file_handler.setLevel(logging.INFO)
-    file_formatter = logging.Formatter("%(asctime)s [%(levelname)s] %(name)s: %(message)s")
-    file_handler.setFormatter(file_formatter)
-    logger.addHandler(file_handler)
+logger = configure_logging(os.getenv("APP_LOG_FILE", ""))
 
 FILES_NAMES = ["product_info_1.md", "product_info_2.md"]
 

src/logging_config.py

@@ -0,0 +1,37 @@
+# Copyright (c) Microsoft. All rights reserved.
+# Licensed under the MIT license. See LICENSE.md file in the project root for full license information.
+
+import logging
+import sys
+from typing import Optional
+
+def configure_logging(log_file_name: Optional[str] = None, logger_name: str = "azureaiapp") -> logging.Logger:
+    """
+    Configure and return a logger with both stream (stdout) and optional file handlers.
+
+    :param log_file_name: The path to the log file. If provided, logs will also be written to this file.
+    :type log_file_name: Optional[str]
+    :param logger_name: The name of the logger to configure.
+    :type logger_name: str
+    :return: The configured logger instance.
+    :rtype: logging.Logger
+    """
+    logger = logging.getLogger(logger_name)
+    logger.setLevel(logging.INFO)
+
+    # Stream handler (stdout)
+    stream_handler = logging.StreamHandler(sys.stdout)
+    stream_handler.setLevel(logging.INFO)
+    stream_formatter = logging.Formatter("%(asctime)s [%(levelname)s] %(name)s: %(message)s")
+    stream_handler.setFormatter(stream_formatter)
+    logger.addHandler(stream_handler)
+
+    # File handler if a log file is specified
+    if log_file_name:
+        file_handler = logging.FileHandler(log_file_name)
+        file_handler.setLevel(logging.INFO)
+        file_formatter = logging.Formatter("%(asctime)s [%(levelname)s] %(name)s: %(message)s")
+        file_handler.setFormatter(file_formatter)
+        logger.addHandler(file_handler)
+
+    return logger