Merge pull request #45 from Azure-Samples/m-hietala/tracing_and_file_logging_related_updates

tracing and file logging related updates

Author: M-Hietala

src/api/main.py

@@ -18,52 +18,16 @@
 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)
-
-# 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)
-
-enable_trace_string = os.getenv("ENABLE_AZURE_MONITOR_TRACING", "")
+from logging_config import configure_logging
+
 enable_trace = False
-if enable_trace_string != "":
-    enable_trace = False
-else:
-    enable_trace = str(enable_trace_string).lower() == "true"
-if enable_trace:
-    logger.info("Tracing is enabled.")
-    try:
-        from azure.monitor.opentelemetry import configure_azure_monitor
-    except ModuleNotFoundError:
-        logger.error("Required libraries for tracing not installed.")
-        logger.error("Please make sure azure-monitor-opentelemetry is installed.")
-        exit()
-else:
-    logger.info("Tracing is not enabled")
+logger = None
 
 @contextlib.asynccontextmanager
 async def lifespan(app: fastapi.FastAPI):
     agent = None
 
     try:
-        if not os.getenv("RUNNING_IN_PRODUCTION"):
-            logger.info("Loading .env file")
-            load_dotenv(override=True)
-
         ai_client = AIProjectClient.from_connection_string(
             credential=DefaultAzureCredential(exclude_shared_token_cache_credential=True),
             conn_str=os.environ["AZURE_AIPROJECT_CONNECTION_STRING"],
@@ -82,7 +46,10 @@ async def lifespan(app: fastapi.FastAPI):
                 logger.error("Enable it via the 'Tracing' tab in your AI Foundry project page.")
                 exit()
             else:
+                from azure.monitor.opentelemetry import configure_azure_monitor
                 configure_azure_monitor(connection_string=application_insights_connection_string)
+                # Do not instrument the code yet, before trace fix is available.
+                #ai_client.telemetry.enable()
 
         if os.environ.get("AZURE_AI_AGENT_ID"):
             try: 
@@ -125,6 +92,30 @@ async def lifespan(app: fastapi.FastAPI):
 
 
 def create_app():
+    if not os.getenv("RUNNING_IN_PRODUCTION"):
+        load_dotenv(override=True)
+
+    global logger
+    logger = configure_logging(os.getenv("APP_LOG_FILE", ""))
+
+    enable_trace_string = os.getenv("ENABLE_AZURE_MONITOR_TRACING", "")
+    global enable_trace
+    enable_trace = False
+    if enable_trace_string == "":
+        enable_trace = False
+    else:
+        enable_trace = str(enable_trace_string).lower() == "true"
+    if enable_trace:
+        logger.info("Tracing is enabled.")
+        try:
+            from azure.monitor.opentelemetry import configure_azure_monitor
+        except ModuleNotFoundError:
+            logger.error("Required libraries for tracing not installed.")
+            logger.error("Please make sure azure-monitor-opentelemetry is installed.")
+            exit()
+    else:
+        logger.info("Tracing is not enabled")
+
     directory = os.path.join(os.path.dirname(__file__), "static")
     app = fastapi.FastAPI(lifespan=lifespan)
     app.mount("/static", StaticFiles(directory=directory), name="static")

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