fix(tracer): use active context in get_log_correlation_context (#3532) (#3561)

Formerly only the active span would be considered for
get_log_correlation_context. This would break log-trace correlation
when tracing across execution boundaries as the context is propagated
and activated.

(cherry picked from commit 9d67013)

Co-authored-by: Kyle Verhoog <[email protected]>

Author: mergify[bot]

ddtrace/tracer.py

@@ -291,18 +291,18 @@ def get_log_correlation_context(self):
         span id of the current active span, as well as the configured service, version, and environment names.
         If there is no active span, a dictionary with an empty string for each value will be returned.
         """
-        span = None
+        active = None  # type: Optional[Union[Context, Span]]
         if self.enabled:
-            span = self.current_span()
+            active = self.context_provider.active()
 
-        if span and span.service:
-            service = span.service
+        if isinstance(active, Span) and active.service:
+            service = active.service
         else:
             service = config.service
 
         return {
-            "trace_id": str(span.trace_id) if span else "0",
-            "span_id": str(span.span_id) if span else "0",
+            "trace_id": str(active.trace_id) if active else "0",
+            "span_id": str(active.span_id) if active else "0",
             "service": service or "",
             "version": config.version or "",
             "env": config.env or "",

releasenotes/notes/log-correlation-context-0ca54b5caf687b2d.yaml

@@ -0,0 +1,6 @@
+---
+fixes:
+  - |
+    ``tracer.get_log_correlation_context()``: use active context in addition to
+      active span. Formerly just the span was used and this would break cross
+      execution log correlation as a context object is used for the propagation.

tests/tracer/test_correlation_log_context.py

@@ -4,6 +4,7 @@
 from ddtrace import Tracer
 from ddtrace import config
 from ddtrace import tracer
+from ddtrace.context import Context
 from ddtrace.opentracer.tracer import Tracer as OT_Tracer
 from tests.utils import override_global_config
 
@@ -71,6 +72,20 @@ def test_get_log_correlation_context(self, global_config):
             "version": "test-version",
         }
 
+        tracer.context_provider.activate(
+            Context(
+                span_id=234,
+                trace_id=4321,
+            )
+        )
+        assert test_tracer.get_log_correlation_context() == {
+            "span_id": "234",
+            "trace_id": "4321",
+            "service": "test-service",
+            "env": "test-env",
+            "version": "test-version",
+        }
+
     def test_get_log_correlation_context_opentracer(self, global_config):
         """Ensure expected DDLogRecord generated via get_correlation_log_record with an opentracing Tracer."""
         ot_tracer = OT_Tracer(service_name="test-service")