feat: Implementation of Configurable Logging Control via Flag (#1966)

Author: AjitPadhi-Microsoft

.env.sample

@@ -38,6 +38,11 @@ AZURE_OPENAI_STREAM=True
 # Backend for processing the documents and application logging in the app
 AzureWebJobsStorage=
 BACKEND_URL=http://localhost:7071
+
+# Enhanced logging configuration (optional)
+LOGLEVEL=INFO
+PACKAGE_LOGGING_LEVEL=WARNING
+# AZURE_LOGGING_PACKAGES=azure.core,azure.identity
 DOCUMENT_PROCESSING_QUEUE_NAME=
 AZURE_BLOB_ACCOUNT_NAME=
 AZURE_BLOB_ACCOUNT_KEY=

code/app.py

@@ -8,10 +8,25 @@
 from opentelemetry.instrumentation.httpx import HTTPXClientInstrumentor
 
 logging.captureWarnings(True)
-logging.basicConfig(level=os.environ.get("LOGLEVEL", "INFO").upper())
-# Raising the azure log level to WARN as it is too verbose -
-# https://github.com/Azure/azure-sdk-for-python/issues/9422
-logging.getLogger("azure").setLevel(os.environ.get("LOGLEVEL_AZURE", "WARN").upper())
+
+# Logging configuration from environment variables
+AZURE_BASIC_LOGGING_LEVEL = os.environ.get("LOGLEVEL", "INFO")
+PACKAGE_LOGGING_LEVEL = os.environ.get("PACKAGE_LOGGING_LEVEL", "WARNING")
+AZURE_LOGGING_PACKAGES = os.environ.get("AZURE_LOGGING_PACKAGES", "")
+AZURE_LOGGING_PACKAGES = [pkg.strip() for pkg in AZURE_LOGGING_PACKAGES if pkg.strip()]
+
+# Configure logging levels from environment variables
+logging.basicConfig(
+    level=getattr(logging, AZURE_BASIC_LOGGING_LEVEL.upper(), logging.INFO)
+)
+
+# Configure Azure package logging levels
+azure_package_log_level = getattr(
+    logging, PACKAGE_LOGGING_LEVEL.upper(), logging.WARNING
+)
+for logger_name in AZURE_LOGGING_PACKAGES:
+    logging.getLogger(logger_name).setLevel(azure_package_log_level)
+
 # We cannot use EnvHelper here as Application Insights should be configured first
 # for instrumentation to work correctly
 if os.getenv("APPLICATIONINSIGHTS_ENABLED", "false").lower() == "true":

code/backend/Admin.py

@@ -11,10 +11,25 @@
 sys.path.append(os.path.join(os.path.dirname(__file__), ".."))
 
 logging.captureWarnings(True)
-logging.basicConfig(level=os.getenv("LOGLEVEL", "INFO").upper())
-# Raising the azure log level to WARN as it is too verbose
-# https://github.com/Azure/azure-sdk-for-python/issues/9422
-logging.getLogger("azure").setLevel(os.environ.get("LOGLEVEL_AZURE", "WARN").upper())
+
+# Logging configuration from environment variables
+AZURE_BASIC_LOGGING_LEVEL = os.environ.get("LOGLEVEL", "INFO")
+PACKAGE_LOGGING_LEVEL = os.environ.get("PACKAGE_LOGGING_LEVEL", "WARNING")
+AZURE_LOGGING_PACKAGES = os.environ.get("AZURE_LOGGING_PACKAGES", "")
+AZURE_LOGGING_PACKAGES = [pkg.strip() for pkg in AZURE_LOGGING_PACKAGES if pkg.strip()]
+
+# Configure logging levels from environment variables
+logging.basicConfig(
+    level=getattr(logging, AZURE_BASIC_LOGGING_LEVEL.upper(), logging.INFO)
+)
+
+# Configure Azure package logging levels
+azure_package_log_level = getattr(
+    logging, PACKAGE_LOGGING_LEVEL.upper(), logging.WARNING
+)
+for logger_name in AZURE_LOGGING_PACKAGES:
+    logging.getLogger(logger_name).setLevel(azure_package_log_level)
+
 # We cannot use EnvHelper here as Application Insights needs to be configured first
 # for instrumentation to work correctly
 if os.getenv("APPLICATIONINSIGHTS_ENABLED", "false").lower() == "true":

code/backend/batch/function_app.py

@@ -9,8 +9,25 @@
 from azure.monitor.opentelemetry import configure_azure_monitor
 
 logging.captureWarnings(True)
-# Raising the azure log level to WARN as it is too verbose - https://github.com/Azure/azure-sdk-for-python/issues/9422
-logging.getLogger("azure").setLevel(os.environ.get("LOGLEVEL_AZURE", "WARN").upper())
+
+# Logging configuration from environment variables
+AZURE_BASIC_LOGGING_LEVEL = os.environ.get("LOGLEVEL", "INFO")
+PACKAGE_LOGGING_LEVEL = os.environ.get("PACKAGE_LOGGING_LEVEL", "WARNING")
+AZURE_LOGGING_PACKAGES = os.environ.get("AZURE_LOGGING_PACKAGES", "")
+AZURE_LOGGING_PACKAGES = [pkg.strip() for pkg in AZURE_LOGGING_PACKAGES if pkg.strip()]
+
+# Configure logging levels from environment variables
+logging.basicConfig(
+    level=getattr(logging, AZURE_BASIC_LOGGING_LEVEL.upper(), logging.INFO)
+)
+
+# Configure Azure package logging levels
+azure_package_log_level = getattr(
+    logging, PACKAGE_LOGGING_LEVEL.upper(), logging.WARNING
+)
+for logger_name in AZURE_LOGGING_PACKAGES:
+    logging.getLogger(logger_name).setLevel(azure_package_log_level)
+
 if os.getenv("APPLICATIONINSIGHTS_ENABLED", "false").lower() == "true":
     configure_azure_monitor()
 

docs/LOCAL_DEPLOYMENT.md

@@ -298,6 +298,8 @@ Execute the above [shell command](#L81) to run the function locally. You may nee
 |DOCUMENT_PROCESSING_QUEUE_NAME|doc-processing|The name of the Azure Queue to handle the Batch processing|
 |FUNCTION_KEY | | The function key for accessing the backend Azure Function|
 |LOGLEVEL | INFO | The log level for application logging (CRITICAL, ERROR, WARN, INFO, DEBUG)|
+|PACKAGE_LOGGING_LEVEL | WARNING | Enhanced: Azure SDK package logging level (CRITICAL, ERROR, WARN, INFO, DEBUG)|
+|AZURE_LOGGING_PACKAGES | (optional) | Enhanced: Comma-separated list of Azure logger packages to configure. If not provided, no Azure SDK logging is configured.|
 |MANAGED_IDENTITY_CLIENT_ID | | The client ID of the user-assigned managed identity|
 |MANAGED_IDENTITY_RESOURCE_ID | | The resource ID of the user-assigned managed identity|
 |OPEN_AI_FUNCTIONS_SYSTEM_PROMPT | | System prompt for OpenAI functions orchestration|

infra/main.bicep

@@ -1276,6 +1276,8 @@ module web 'modules/app/web.bicep' = {
         ORCHESTRATION_STRATEGY: orchestrationStrategy
         CONVERSATION_FLOW: conversationFlow
         LOGLEVEL: logLevel
+        PACKAGE_LOGGING_LEVEL: 'WARNING'
+        AZURE_LOGGING_PACKAGES: ''
         DATABASE_TYPE: databaseType
         OPEN_AI_FUNCTIONS_SYSTEM_PROMPT: openAIFunctionsSystemPrompt
         SEMANTIC_KERNEL_SYSTEM_PROMPT: semanticKernelSystemPrompt
@@ -1374,6 +1376,8 @@ module adminweb 'modules/app/adminweb.bicep' = {
         ORCHESTRATION_STRATEGY: orchestrationStrategy
         CONVERSATION_FLOW: conversationFlow
         LOGLEVEL: logLevel
+        PACKAGE_LOGGING_LEVEL: 'WARNING'
+        AZURE_LOGGING_PACKAGES: ''
         DATABASE_TYPE: databaseType
         USE_KEY_VAULT: 'true'
         MANAGED_IDENTITY_CLIENT_ID: managedIdentityModule.outputs.clientId
@@ -1469,6 +1473,8 @@ module function 'modules/app/function.bicep' = {
         DOCUMENT_PROCESSING_QUEUE_NAME: queueName
         ORCHESTRATION_STRATEGY: orchestrationStrategy
         LOGLEVEL: logLevel
+        PACKAGE_LOGGING_LEVEL: 'WARNING'
+        AZURE_LOGGING_PACKAGES: ''
         AZURE_OPENAI_SYSTEM_MESSAGE: azureOpenAISystemMessage
         DATABASE_TYPE: databaseType
         MANAGED_IDENTITY_CLIENT_ID: managedIdentityModule.outputs.clientId