Update datadog exporter error tagging (#459)

CHANGELOG.md

@@ -40,6 +40,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   ([#415](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/415))
 - `opentelemetry-instrumentation-tornado` Add request/response hooks.
   ([#426](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/426))
+- `opentelemetry-exporter-datadog` Add parsing exception events for error tags.
+  ([#459](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/459))
 - `opentelemetry-instrumenation-django` now supports trace response headers.
   ([#436](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/436))
 - `opentelemetry-instrumenation-tornado` now supports trace response headers.

exporter/opentelemetry-exporter-datadog/src/opentelemetry/exporter/datadog/constants.py

@@ -7,3 +7,10 @@ SAMPLING_PRIORITY_KEY = "_sampling_priority_v1"
 ENV_KEY = "env"
 VERSION_KEY = "version"
 SERVICE_NAME_TAG = "service.name"
+EVENT_NAME_EXCEPTION = "exception"
+EXCEPTION_TYPE_ATTR_KEY = "exception.type"
+EXCEPTION_MSG_ATTR_KEY = "exception.message"
+EXCEPTION_STACK_ATTR_KEY = "exception.stacktrace"
+DD_ERROR_TYPE_TAG_KEY = "error.type"
+DD_ERROR_MSG_TAG_KEY = "error.msg"
+DD_ERROR_STACK_TAG_KEY = "error.stack"

exporter/opentelemetry-exporter-datadog/src/opentelemetry/exporter/datadog/exporter.py

@@ -22,8 +22,15 @@ from ddtrace.span import Span as DatadogSpan
 
 import opentelemetry.trace as trace_api
 from opentelemetry.exporter.datadog.constants import (
+    DD_ERROR_MSG_TAG_KEY,
+    DD_ERROR_STACK_TAG_KEY,
+    DD_ERROR_TYPE_TAG_KEY,
     DD_ORIGIN,
     ENV_KEY,
+    EVENT_NAME_EXCEPTION,
+    EXCEPTION_MSG_ATTR_KEY,
+    EXCEPTION_STACK_ATTR_KEY,
+    EXCEPTION_TYPE_ATTR_KEY,
     SAMPLE_RATE_METRIC_KEY,
     SERVICE_NAME_TAG,
     VERSION_KEY,
@@ -145,11 +152,12 @@ class DatadogSpanExporter(SpanExporter):
 
             if not span.status.is_ok:
                 datadog_span.error = 1
-                if span.status.description:
+                # loop over events and look for exception events, extract info.
-                    exc_type, exc_val = _get_exc_info(span)
+                # https://github.com/open-telemetry/opentelemetry-python/blob/71e3a7a192c0fc8a7503fac967ada36a74b79e58/opentelemetry-sdk/src/opentelemetry/sdk/trace/__init__.py#L810-L819
-                    # no mapping for error.stack since traceback not recorded
+                if span.events:
-                    datadog_span.set_tag("error.msg", exc_val)
+                    _extract_tags_from_exception_events(
-                    datadog_span.set_tag("error.type", exc_type)
+                        span.events, datadog_span
+                    )
 
             # combine resource attributes and span attributes, don't modify existing span attributes
             combined_span_tags = {}
@@ -178,7 +186,7 @@ class DatadogSpanExporter(SpanExporter):
             if sampling_rate is not None:
                 datadog_span.set_metric(SAMPLE_RATE_METRIC_KEY, sampling_rate)
 
-            # span events and span links are not supported
+            # span events and span links are not supported except for extracting exception event context
 
             datadog_spans.append(datadog_span)
 
@@ -318,3 +326,17 @@ def _extract_tags_from_resource(resource):
         else:
             tags[attribute_key] = attribute_value
     return [tags, service_name]
+
+
+def _extract_tags_from_exception_events(events, datadog_span):
+    """Parse error tags from exception events, error.msg error.type
+    and error.stack have special significance within datadog"""
+    for event in events:
+        if event.name is not None and event.name == EVENT_NAME_EXCEPTION:
+            for key, value in event.attributes.items():
+                if key == EXCEPTION_TYPE_ATTR_KEY:
+                    datadog_span.set_tag(DD_ERROR_TYPE_TAG_KEY, value)
+                elif key == EXCEPTION_MSG_ATTR_KEY:
+                    datadog_span.set_tag(DD_ERROR_MSG_TAG_KEY, value)
+                elif key == EXCEPTION_STACK_ATTR_KEY:
+                    datadog_span.set_tag(DD_ERROR_STACK_TAG_KEY, value)

exporter/opentelemetry-exporter-datadog/tests/test_datadog_exporter.py

@@ -388,6 +388,7 @@ class TestDatadogSpanExporter(unittest.TestCase):
         self.assertEqual(span["error"], 1)
         self.assertEqual(span["meta"]["error.msg"], "bar")
         self.assertEqual(span["meta"]["error.type"], "ValueError")
+        self.assertTrue(span["meta"]["error.stack"] is not None)
 
     def test_shutdown(self):
         span_names = ["xxx", "bar", "foo"]