Merge pull request #7 from sophia-ramsey/m-hietala/adding_telemetry_support

adding telemetry support

Author: M-Hietala

infra/core/security/appinsights-access.bicep

@@ -0,0 +1,19 @@
+metadata description = 'Assigns MonitoringMetricsContributor role to Application Insights.'
+param appInsightsName string
+param principalId string
+
+resource appInsights 'Microsoft.Insights/components@2020-02-02' existing = {
+  name: appInsightsName
+}
+
+//var monitoringMetricsPublisherRole = subscriptionResourceId('Microsoft.Authorization/roleDefinitions', '3913510d-42f4-4e42-8a64-420c390055eb')
+var monitoringMetricsContributorRole = subscriptionResourceId('Microsoft.Authorization/roleDefinitions', '749f88d5-cbae-40b8-bcfc-e573ddc772fa')
+
+resource monitoringMetricsContributorRoleAssignment 'Microsoft.Authorization/roleAssignments@2022-04-01' = {
+  scope: appInsights // Use when specifying a scope that is different than the deployment scope
+  name: guid(subscription().id, resourceGroup().id, principalId, monitoringMetricsContributorRole)
+  properties: {
+    roleDefinitionId: monitoringMetricsContributorRole
+    principalId: principalId
+  }
+}

infra/main.bicep

@@ -276,6 +276,19 @@ module backendRoleAzureAIDeveloperRG 'core/security/role.bicep' = {
   }
 }
 
+var resolvedApplicationInsightsName = !useApplicationInsights || !empty(aiExistingProjectConnectionString)
+  ? ''
+  : !empty(applicationInsightsName) ? applicationInsightsName : '${abbrs.insightsComponents}${resourceToken}'
+
+module monitoringMetricsContribuitorRoleAzureAIDeveloperRG 'core/security/appinsights-access.bicep' = if (!empty(resolvedApplicationInsightsName)) {
+  name: 'monitoringmetricscontributor-role-azureai-developer-rg'
+  scope: rg
+  params: {
+    appInsightsName: resolvedApplicationInsightsName
+    principalId: api.outputs.SERVICE_API_IDENTITY_PRINCIPAL_ID
+  }
+}
+
 resource existingProjectRG 'Microsoft.Resources/resourceGroups@2021-04-01' existing = if (!empty(aiExistingProjectConnectionString)) {
   name: split(aiExistingProjectConnectionString, ';')[2]
 }

src/Dockerfile

@@ -6,6 +6,12 @@ WORKDIR /code
 
 COPY . .
 
+ENV ENABLE_AZURE_MONITOR_TRACING=false
+
+ENV AZURE_TRACING_GEN_AI_CONTENT_RECORDING_ENABLED=false
+
+#ENV APP_LOG_FILE=app.log
+
 RUN pip install --no-cache-dir --upgrade -r requirements.txt
 
 EXPOSE 50505

src/api/main.py

@@ -28,14 +28,31 @@
 stream_handler.setFormatter(stream_formatter)
 logger.addHandler(stream_handler)
 
-# Configure the file handler
-log_file_path = os.getenv("APP_LOG_FILE", "app.log")
-file_handler = logging.FileHandler(log_file_path)
-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)
-
+# Configure logging to file, if log file name is provided
+log_file_name = os.getenv("APP_LOG_FILE")
+if log_file_name is not None:
+    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")
+enable_trace = False
+if enable_trace_string is None:
+    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")
 
 @contextlib.asynccontextmanager
 async def lifespan(app: fastapi.FastAPI):
@@ -54,6 +71,20 @@ async def lifespan(app: fastapi.FastAPI):
         )
         logger.info("Created AIProjectClient")
 
+        if enable_trace:
+            application_insights_connection_string = ""
+            try:
+                application_insights_connection_string = await ai_client.telemetry.get_connection_string()
+            except Exception as e:
+                e_string = str(e)
+                logger.error("Failed to get Application Insights connection string, error: %s", e_string)
+            if not application_insights_connection_string:
+                logger.error("Application Insights was not enabled for this project.")
+                logger.error("Enable it via the 'Tracing' tab in your AI Foundry project page.")
+                exit()
+            else:
+                configure_azure_monitor(connection_string=application_insights_connection_string)
+
         file_names = ["product_info_1.md", "product_info_2.md"] #TODO: can we get the file names from the folder so customers can upload? 
         for file_name in file_names:
             file_path = os.path.abspath(os.path.join(os.path.dirname(__file__), '..', 'files', file_name))

src/requirements.txt

@@ -3,4 +3,7 @@ uvicorn[standard]==0.29.0
 gunicorn==22.0.0
 azure-identity==1.19.0
 aiohttp==3.11.1
-azure-ai-projects
+azure-ai-projects
+azure-core-tracing-opentelemetry
+azure-monitor-opentelemetry
+opentelemetry-sdk