Disable app insights when running locally (#619)

* Disable app insights when running locally

* Rename to `APPINSIGHTS_ENABLED`

* Fix `TokenLogger.py` for App Insights

* Add comment to env var

Author: cecheta

code/app.py

@@ -1,8 +1,12 @@
+import os
 from azure.monitor.opentelemetry import configure_azure_monitor
 from opentelemetry.instrumentation.httpx import HTTPXClientInstrumentor
 
-configure_azure_monitor()
-HTTPXClientInstrumentor().instrument()  # httpx is used by openai
+# We cannot use EnvHelper here as Application Insights should be configured first
+# for instrumentation to work correctly
+if os.getenv("APPINSIGHTS_ENABLED", "false").lower() == "true":
+    configure_azure_monitor()
+    HTTPXClientInstrumentor().instrument()  # httpx is used by openai
 
 from create_app import create_app  # noqa: E402
 

code/backend/Admin.py

@@ -10,7 +10,10 @@
 
 sys.path.append(os.path.join(os.path.dirname(__file__), ".."))
 
-configure_azure_monitor()
+# We cannot use EnvHelper here as Application Insights needs to be configured first
+# for instrumentation to work correctly
+if os.getenv("APPINSIGHTS_ENABLED", "false").lower() == "true":
+    configure_azure_monitor()
 
 logger = logging.getLogger("azure.core.pipeline.policies.http_logging_policy").setLevel(
     logging.WARNING

code/backend/batch/utilities/helpers/EnvHelper.py

@@ -128,7 +128,8 @@ def __init__(self, **kwargs) -> None:
             "AZURE_FORM_RECOGNIZER_KEY"
         )
         # Azure App Insights
-        self.APPINSIGHTS_ENABLED = self.get_env_var_bool("APPINSIGHTS_ENABLED")
+        # APPINSIGHTS_ENABLED will be True when the application runs in App Service
+        self.APPINSIGHTS_ENABLED = self.get_env_var_bool("APPINSIGHTS_ENABLED", "False")
 
         self.APPINSIGHTS_CONNECTION_STRING = os.getenv(
             "APPINSIGHTS_CONNECTION_STRING", ""

code/backend/batch/utilities/loggers/TokenLogger.py

@@ -1,24 +1,15 @@
 import logging
-from opencensus.ext.azure.log_exporter import AzureLogHandler
-from ..helpers.EnvHelper import EnvHelper
 
 
+# TODO: We probably don't need a separate class for this
 class TokenLogger:
     def __init__(self, name: str = __name__):
-        env_helper: EnvHelper = EnvHelper()
         self.logger = logging.getLogger(name)
-        if env_helper.APPINSIGHTS_ENABLED:
-            self.logger.addHandler(
-                AzureLogHandler(
-                    connection_string=env_helper.APPINSIGHTS_CONNECTION_STRING
-                )
-            )
         self.logger.setLevel(logging.INFO)
 
     def get_logger(self):
         return self.logger
 
     def log(self, message: str, custom_dimensions: dict):
         # Setting log properties
-        log_properties = {"custom_dimensions": custom_dimensions}
-        self.logger.info(message, extra=log_properties)
+        self.logger.info(message, extra=custom_dimensions)

code/tests/utilities/test_EnvHelper.py

@@ -47,7 +47,7 @@ def test_load_config_from_blob_storage(monkeypatch: MonkeyPatch, value, expected
 
 @pytest.mark.parametrize(
     "value,expected",
-    [("true", True), ("false", False), ("this is the way", False), (None, True)],
+    [("true", True), ("false", False), ("this is the way", False), (None, False)],
 )
 def test_app_insights_enabled(monkeypatch: MonkeyPatch, value, expected):
     # given

infra/core/host/appservice.bicep

@@ -90,6 +90,7 @@ module configAppSettings 'appservice-appsettings.bicep' = {
     name: appService.name
     appSettings: union(appSettings,
       {
+        APPINSIGHTS_ENABLED: string(!empty(applicationInsightsName))
         SCM_DO_BUILD_DURING_DEPLOYMENT: string(scmDoBuildDuringDeployment)
         ENABLE_ORYX_BUILD: string(enableOryxBuild)
       },

infra/main.json

@@ -30,7 +30,6 @@ beautifulsoup4 = "4.12.3"
 fake-useragent = "1.5.1"
 chardet = "5.2.0"
 azure-search-documents = "11.4.0"
-opencensus-ext-azure = "1.1.13"
 azure-ai-contentsafety = "1.0.0"
 python-docx = "1.1.0"
 azure-keyvault-secrets = "4.8.0"