Support synthetic source in exporter

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

@@ -4,6 +4,9 @@
 
 ### Features Added
 
+- Support `syntheticSource` from `user_agent.synthetic.type` semantic convention
+  ([#40004](https://github.com/Azure/azure-sdk-for-python/pull/40004))
+
 ### Breaking Changes
 
 ### Bugs Fixed

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

@@ -256,6 +256,12 @@ def _populate_part_a_fields(resource: Resource):
     return tags
 
 
+def _is_synthetic_source(properties: Attributes) -> bool:
+    # TODO: Use semconv symbol when released in upstream
+    synthetic_type = properties.get("user_agent.synthetic.type")  # type: ignore
+    return synthetic_type in ("bot", "test")
+
+
 # pylint: disable=W0622
 def _filter_custom_properties(properties: Attributes, filter=None) -> Dict[str, str]:
     truncated_properties: Dict[str, str] = {}

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

@@ -40,6 +40,7 @@
 )
 from azure.monitor.opentelemetry.exporter import _utils
 from azure.monitor.opentelemetry.exporter._generated.models import (
+    ContextTagKeys,
     MetricDataPoint,
     MetricsData,
     MonitorBase,
@@ -182,6 +183,8 @@ def _convert_point_to_envelope(
     envelope = _utils._create_telemetry_item(point.time_unix_nano)
     envelope.name = _METRIC_ENVELOPE_NAME
     envelope.tags.update(_utils._populate_part_a_fields(resource))  # type: ignore
+    if _utils._is_synthetic_source(point.attributes):
+        envelope.tags[ContextTagKeys.AI_OPERATION_SYNTHETIC_SOURCE] = "True"  # type: ignore
     namespace = None
     if scope is not None and _is_metric_namespace_opted_in():
         namespace = str(scope.name)[:256]

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

@@ -221,6 +221,8 @@ def _convert_span_to_envelope(span: ReadableSpan) -> TelemetryItem:
     envelope.tags[ContextTagKeys.AI_OPERATION_ID] = "{:032x}".format(span.context.trace_id)
     if SpanAttributes.ENDUSER_ID in span.attributes:
         envelope.tags[ContextTagKeys.AI_USER_ID] = span.attributes[SpanAttributes.ENDUSER_ID]
+    if _utils._is_synthetic_source(span.attributes):
+        envelope.tags[ContextTagKeys.AI_OPERATION_SYNTHETIC_SOURCE] = "True"
     if span.parent and span.parent.span_id:
         envelope.tags[ContextTagKeys.AI_OPERATION_PARENT_ID] = "{:016x}".format(span.parent.span_id)
     if span.kind in (SpanKind.CONSUMER, SpanKind.SERVER):

sdk/monitor/azure-monitor-opentelemetry-exporter/tests/metrics/test_metrics.py

@@ -171,6 +171,7 @@ def test_point_to_envelope_partA(self):
         point = NumberDataPoint(
             attributes={
                 "test": "attribute",
+                "user_agent.synthetic.type": "bot",
             },
             start_time_unix_nano=1646865018558419456,
             time_unix_nano=1646865018558419457,
@@ -197,7 +198,7 @@ def test_point_to_envelope_partA(self):
             envelope.tags.get(ContextTagKeys.AI_INTERNAL_SDK_VERSION),
             azure_monitor_context[ContextTagKeys.AI_INTERNAL_SDK_VERSION],
         )
-
+        self.assertEqual(envelope.tags.get(ContextTagKeys.AI_OPERATION_SYNTHETIC_SOURCE), "True")
         self.assertEqual(envelope.tags.get(ContextTagKeys.AI_CLOUD_ROLE), "testServiceNamespace.testServiceName")
         self.assertEqual(envelope.tags.get(ContextTagKeys.AI_CLOUD_ROLE_INSTANCE), "testServiceInstanceId")
         self.assertEqual(envelope.tags.get(ContextTagKeys.AI_INTERNAL_NODE_NAME), "testServiceInstanceId")

sdk/monitor/azure-monitor-opentelemetry-exporter/tests/test_utils.py

@@ -289,3 +289,21 @@ def test_attach_app_service_disabled(self, mock_isdir):
     def test_attach_off_app_service_with_agent(self, mock_isdir):
         # This is not an expected scenario and just tests the default
         self.assertEqual(_utils._is_attach_enabled(), False)
+
+    # Synthetic
+
+    def test_is_synthetic_source_bot(self):
+        properties = {"user_agent.synthetic.type": "bot"}
+        self.assertTrue(_utils._is_synthetic_source(properties))
+
+    def test_is_synthetic_source_test(self):
+        properties = {"user_agent.synthetic.type": "test"}
+        self.assertTrue(_utils._is_synthetic_source(properties))
+
+    def test_is_synthetic_source_none(self):
+        properties = {}
+        self.assertFalse(_utils._is_synthetic_source(properties))
+
+    def test_is_synthetic_source_other(self):
+        properties = {"user_agent.synthetic.type": "user"}
+        self.assertFalse(_utils._is_synthetic_source(properties))

sdk/monitor/azure-monitor-opentelemetry-exporter/tests/trace/test_trace.py

@@ -272,7 +272,10 @@ def test_span_to_envelope_partA(self):
             name="test",
             context=context,
             resource=resource,
-            attributes={"enduser.id": "testId"},
+            attributes={
+                "enduser.id": "testId",
+                "user_agent.synthetic.type": "bot",
+            },
             parent=context,
         )
         test_span.start()
@@ -304,6 +307,7 @@ def test_span_to_envelope_partA(self):
         self.assertEqual(envelope.tags.get(ContextTagKeys.AI_INTERNAL_NODE_NAME), "testServiceInstanceId")
         self.assertEqual(envelope.tags.get(ContextTagKeys.AI_OPERATION_ID), "{:032x}".format(context.trace_id))
         self.assertEqual(envelope.tags.get(ContextTagKeys.AI_USER_ID), "testId")
+        self.assertEqual(envelope.tags.get(ContextTagKeys.AI_OPERATION_SYNTHETIC_SOURCE), "True")
         self.assertEqual(envelope.tags.get(ContextTagKeys.AI_OPERATION_PARENT_ID), "{:016x}".format(context.span_id))
 
     def test_span_to_envelope_partA_default(self):