ran validations and fixed formatting issues

Author: yuanqu72

featuremanagement/azuremonitor/_send_telemetry.py

@@ -28,11 +28,10 @@
     SpanProcessor = object  # type: ignore
 
 
-_events_logger_initialized = False
+_EVENTS_LOGGER_INITIALIZED: list[bool] = []
 
 def _initialize_event_logger() -> None:
-    global _events_logger_initialized
-    if _events_logger_initialized:
+    if _EVENTS_LOGGER_INITIALIZED:
         return
 
     if not HAS_OPENTELEMETRY_LOGGING:
@@ -43,7 +42,8 @@ def _initialize_event_logger() -> None:
 
     _event_logger.addHandler(LoggingHandler())
     _event_logger.setLevel(INFO)
-    _events_logger_initialized = True
+    _EVENTS_LOGGER_INITIALIZED.append(True)
+
 
 FEATURE_NAME = "FeatureName"
 ENABLED = "Enabled"
@@ -80,11 +80,16 @@ def track_event(event_name: str, user: str, event_properties: Optional[Dict[str,
         event_properties[TARGETING_ID] = user
 
     # Azure Monitor exporter maps this attribute to customEvent telemetry name.
-    custom_event_attributes = {
-        **event_properties,
-        "microsoft.custom_event.name": event_name,
-    }
-    _event_logger.info(event_name, extra=custom_event_attributes)
+    custom_event_attributes = {**event_properties, "microsoft.custom_event.name": event_name}
+
+    # logging raises KeyError if an `extra` key overwrites a built-in LogRecord attribute (e.g. "name", "message").
+    reserved = logging.makeLogRecord({}).__dict__
+    safe_attributes: Dict[str, Optional[str]] = {}
+    for key, value in custom_event_attributes.items():
+        safe_key = key if key not in reserved else f"telemetry.{key}"
+        safe_attributes[safe_key] = value
+
+    _event_logger.info(event_name, extra=safe_attributes)
 
 
 def publish_telemetry(evaluation_event: EvaluationEvent) -> None:

pyproject.toml

@@ -58,9 +58,10 @@ Homepage = "https://github.com/microsoft/FeatureManagement-Python"
 Issues = "https://github.com/microsoft/FeatureManagement-Python/issues"
 
 [project.optional-dependencies]
-AzureMonitor = ["azure-monitor-opentelemetry < 2.0.0"]
+AzureMonitor = ["azure-monitor-opentelemetry < 2.0.0", "opentelemetry-instrumentation-logging >= 0.40b0, < 1.0.0"]
 test = [
     "azure-monitor-opentelemetry < 2.0.0",
+    "opentelemetry-instrumentation-logging >= 0.40b0, < 1.0.0",
 ]
 dev = [
     "pytest >= 7.0.0, < 10.0.0",

samples/requirements.txt

@@ -1,6 +1,5 @@
 featuremanagement
 azure-appconfiguration-provider
 azure-monitor-opentelemetry
-azure-monitor-events-extension
 quart
 azure-identity

tests/test_send_telemetry_appinsights.py

@@ -57,17 +57,14 @@ def test_send_telemetry_appinsights(self):
             assert event_properties["Enabled"] == "True"
             assert event_properties["Variant"] == "TestVariant"
             assert event_properties["ETag"] == "cmwBRcIAq1jUyKL3Kj8bvf9jtxBrFg-R-ayExStMC90"
-            assert (
-                event_properties["FeatureFlagReference"]
-                == "fake-store-uri/kv/.appconfig.featureflag/TestFeature"
-            )
+            assert event_properties["FeatureFlagReference"] == "fake-store-uri/kv/.appconfig.featureflag/TestFeature"
             assert event_properties["FeatureFlagId"] == "fake-feature-flag-id"
 
     def test_track_event_preserves_reserved_custom_event_name(self):
-        with patch("featuremanagement.azuremonitor._send_telemetry._initialize_event_logger"), patch(
-            "featuremanagement.azuremonitor._send_telemetry._event_logger.info"
-        ) as mock_event_logger_info, patch(
-            "featuremanagement.azuremonitor._send_telemetry.HAS_OPENTELEMETRY_LOGGING", True
+        with (
+            patch("featuremanagement.azuremonitor._send_telemetry._initialize_event_logger"),
+            patch("featuremanagement.azuremonitor._send_telemetry._event_logger.info") as mock_event_logger_info,
+            patch("featuremanagement.azuremonitor._send_telemetry.HAS_OPENTELEMETRY_LOGGING", True),
         ):
             featuremanagement.azuremonitor._send_telemetry.track_event(
                 "FeatureEvaluation",
@@ -80,7 +77,9 @@ def test_track_event_preserves_reserved_custom_event_name(self):
 
             mock_event_logger_info.assert_called_once()
             assert mock_event_logger_info.call_args[0][0] == "FeatureEvaluation"
-            assert mock_event_logger_info.call_args.kwargs["extra"]["microsoft.custom_event.name"] == "FeatureEvaluation"
+            assert (
+                mock_event_logger_info.call_args.kwargs["extra"]["microsoft.custom_event.name"] == "FeatureEvaluation"
+            )
             assert mock_event_logger_info.call_args.kwargs["extra"]["CustomProperty"] == "custom_value"
             assert mock_event_logger_info.call_args.kwargs["extra"]["TargetingId"] == "test_user"