Implement customEvents via special microsoft marker (Azure#39886)

Author: lzchen

sdk/monitor/azure-monitor-opentelemetry-exporter/CHANGELOG.md

@@ -4,6 +4,9 @@
 
 ### Features Added
 
+- Support sending `customEvent` telemetry through special `microsoft` marker
+  ([#39886](https://github.com/Azure/azure-sdk-for-python/pull/39886))
+
 ### Breaking Changes
 
 ### Bugs Fixed

sdk/monitor/azure-monitor-opentelemetry-exporter/azure/monitor/opentelemetry/exporter/_constants.py

@@ -63,6 +63,7 @@
 # Feature constants
 _APPLICATION_INSIGHTS_EVENT_MARKER_ATTRIBUTE = "APPLICATION_INSIGHTS_EVENT_MARKER_ATTRIBUTE"
 _AZURE_MONITOR_DISTRO_VERSION_ARG = "distro_version"
+_MICROSOFT_CUSTOM_EVENT_NAME = "microsoft.custom_event.name"
 
 # Statsbeat
 

sdk/monitor/azure-monitor-opentelemetry-exporter/azure/monitor/opentelemetry/exporter/export/logs/_exporter.py

@@ -34,6 +34,7 @@
 )
 from azure.monitor.opentelemetry.exporter._constants import (
     _APPLICATION_INSIGHTS_EVENT_MARKER_ATTRIBUTE,
+    _MICROSOFT_CUSTOM_EVENT_NAME,
 )
 from azure.monitor.opentelemetry.exporter.statsbeat._state import (
     get_statsbeat_shutdown,
@@ -103,12 +104,13 @@ def from_connection_string(cls, conn_str: str, **kwargs: Any) -> "AzureMonitorLo
         return cls(connection_string=conn_str, **kwargs)
 
 
-def _log_data_is_event(log_data: LogData):
+def _log_data_is_event(log_data: LogData) -> bool:
     log_record = log_data.log_record
-    is_event = False
+    is_event = None
     if log_record.attributes:
-        is_event = log_record.attributes.get(_APPLICATION_INSIGHTS_EVENT_MARKER_ATTRIBUTE, False)  # type: ignore
-    return is_event is True
+        is_event = log_record.attributes.get(_MICROSOFT_CUSTOM_EVENT_NAME) or \
+            log_record.attributes.get(_APPLICATION_INSIGHTS_EVENT_MARKER_ATTRIBUTE)  # type: ignore
+    return is_event is not None
 
 
 # pylint: disable=protected-access
@@ -133,17 +135,8 @@ def _convert_log_to_envelope(log_data: LogData) -> TelemetryItem:
         stack_trace = log_record.attributes.get(EXCEPTION_STACKTRACE)
     severity_level = _get_severity_level(log_record.severity_number)
 
-    # Event telemetry
-    if _log_data_is_event(log_data):
-        _set_statsbeat_custom_events_feature()
-        envelope.name = "Microsoft.ApplicationInsights.Event"
-        data = TelemetryEventData(
-            name=_map_body_to_message(log_record.body),
-            properties=properties,
-        )
-        envelope.data = MonitorBase(base_data=data, base_type="EventData")
     # Exception telemetry
-    elif exc_type is not None or exc_message is not None:
+    if exc_type is not None or exc_message is not None:
         envelope.name = _EXCEPTION_ENVELOPE_NAME
         has_full_stack = stack_trace is not None
         if not exc_type:
@@ -167,6 +160,19 @@ def _convert_log_to_envelope(log_data: LogData) -> TelemetryItem:
             exceptions=[exc_details],
         )
         envelope.data = MonitorBase(base_data=data, base_type="ExceptionData")
+    elif _log_data_is_event(log_data):  # Event telemetry
+        _set_statsbeat_custom_events_feature()
+        envelope.name = "Microsoft.ApplicationInsights.Event"
+        event_name = ""
+        if log_record.attributes.get(_MICROSOFT_CUSTOM_EVENT_NAME):  # type: ignore
+            event_name = str(log_record.attributes.get(_MICROSOFT_CUSTOM_EVENT_NAME))  # type: ignore
+        else:
+            event_name = _map_body_to_message(log_record.body)
+        data = TelemetryEventData(  # type: ignore
+            name=event_name,
+            properties=properties,
+        )
+        envelope.data = MonitorBase(base_data=data, base_type="EventData")
     else:  # Message telemetry
         envelope.name = _MESSAGE_ENVELOPE_NAME
         # pylint: disable=line-too-long
@@ -223,6 +229,7 @@ def _is_ignored_attribute(key: str) -> bool:
         EXCEPTION_STACKTRACE,
         EXCEPTION_ESCAPED,
         _APPLICATION_INSIGHTS_EVENT_MARKER_ATTRIBUTE,
+        _MICROSOFT_CUSTOM_EVENT_NAME,
     )
 )
 

sdk/monitor/azure-monitor-opentelemetry-exporter/samples/logs/sample_custom_event.py

@@ -0,0 +1,38 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+"""
+An example to show an application using Opentelemetry logging sdk. Logging calls to the standard Python
+logging library are tracked and telemetry is exported to application insights with the AzureMonitorLogExporter.
+"""
+# mypy: disable-error-code="attr-defined"
+import os
+import logging
+
+from opentelemetry._logs import (
+    get_logger_provider,
+    set_logger_provider,
+)
+from opentelemetry.sdk._logs import (
+    LoggerProvider,
+    LoggingHandler,
+)
+from opentelemetry.sdk._logs.export import BatchLogRecordProcessor
+
+from azure.monitor.opentelemetry.exporter import AzureMonitorLogExporter
+
+logger_provider = LoggerProvider()
+set_logger_provider(logger_provider)
+exporter = AzureMonitorLogExporter.from_connection_string(os.environ["APPLICATIONINSIGHTS_CONNECTION_STRING"])
+get_logger_provider().add_log_record_processor(BatchLogRecordProcessor(exporter, schedule_delay_millis=60000))
+
+# Attach LoggingHandler to namespaced logger
+handler = LoggingHandler()
+logger = logging.getLogger(__name__)
+logger.addHandler(handler)
+logger.setLevel(logging.INFO)
+
+# You can send `customEvent`` telemetry using a special `microsoft` attribute key through logging
+# The name of the `customEvent` will correspond to the value of the attribute` 
+logger.info("Hello World!", extra={"microsoft.custom_event.name": "test-event-name", "additional_attrs": "val1"})
+
+input()

sdk/monitor/azure-monitor-opentelemetry-exporter/tests/logs/test_logs.py

@@ -28,6 +28,7 @@
 )
 from azure.monitor.opentelemetry.exporter._constants import (
     _APPLICATION_INSIGHTS_EVENT_MARKER_ATTRIBUTE,
+    _MICROSOFT_CUSTOM_EVENT_NAME,
 )
 from azure.monitor.opentelemetry.exporter._generated.models import ContextTagKeys
 from azure.monitor.opentelemetry.exporter._utils import (
@@ -181,6 +182,23 @@ def setUpClass(cls):
             ),
             InstrumentationScope("test_name"),
         )
+        cls._log_data_custom_event = _logs.LogData(
+            _logs.LogRecord(
+                timestamp=1646865018558419456,
+                trace_id=125960616039069540489478540494783893221,
+                span_id=2909973987304607650,
+                severity_text="INFO",
+                trace_flags=None,
+                severity_number=SeverityNumber.INFO,
+                body="Test Event",
+                resource=Resource.create(attributes={"asd": "test_resource"}),
+                attributes={
+                    "event_key": "event_attribute",
+                    _MICROSOFT_CUSTOM_EVENT_NAME: "event_name",
+                },
+            ),
+            InstrumentationScope("test_name"),
+        )
         cls._exc_data = _logs.LogData(
             _logs.LogRecord(
                 timestamp=1646865018558419456,
@@ -515,6 +533,16 @@ def test_log_to_envelope_event_complex_body_not_serializeable(self):
         self.assertEqual(envelope.data.base_data.name, str(record.body))
         self.assertEqual(envelope.data.base_data.properties["event_key"], "event_attribute")
 
+    def test_log_to_envelope_custom_event(self):
+        exporter = self._exporter
+        envelope = exporter._log_to_envelope(self._log_data_custom_event)
+        record = self._log_data_custom_event.log_record
+        self.assertEqual(envelope.name, "Microsoft.ApplicationInsights.Event")
+        self.assertEqual(envelope.time, ns_to_iso_str(record.timestamp))
+        self.assertEqual(envelope.data.base_type, "EventData")
+        self.assertEqual(envelope.data.base_data.name, "event_name")
+        self.assertEqual(envelope.data.base_data.properties["event_key"], "event_attribute")
+
     def test_log_to_envelope_timestamp(self):
         exporter = self._exporter
         old_record = self._log_data.log_record