Add LogRecord init priority for context's span over old span info

Author: tammy-baylis-swi

opentelemetry-sdk/src/opentelemetry/sdk/_logs/_internal/__init__.py

@@ -189,6 +189,17 @@ def __init__(
         attributes: _ExtendedAttributes | None = None,
         limits: LogLimits | None = _UnsetLogLimits,
     ):
+        # Prioritizes context over trace_id / span_id / trace_flags.
+        # If context provided and its current span valid, then uses that span info.
+        # Otherwise, uses provided trace_id etc for backwards compatibility.
+        if context is not None:
+            span = get_current_span(context)
+            span_context = span.get_span_context()
+            if span_context.is_valid:
+                trace_id = span_context.trace_id
+                span_id = span_context.span_id
+                trace_flags = span_context.trace_flags
+
         super().__init__(
             **{
                 "timestamp": timestamp,

opentelemetry-sdk/tests/logs/test_handler.py

@@ -30,7 +30,10 @@
 )
 from opentelemetry.semconv._incubating.attributes import code_attributes
 from opentelemetry.semconv.attributes import exception_attributes
-from opentelemetry.trace import INVALID_SPAN_CONTEXT
+from opentelemetry.trace import (
+    INVALID_SPAN_CONTEXT,
+    set_span_in_context,
+)
 
 
 class TestLoggingHandler(unittest.TestCase):
@@ -92,19 +95,26 @@ def test_log_flush_noop(self):
 
     def test_log_record_no_span_context(self):
         processor, logger = set_up_test_logging(logging.WARNING)
+        mock_context = Context()
 
-        # Assert emit gets called for warning message
-        with self.assertLogs(level=logging.WARNING):
-            logger.warning("Warning message")
+        with patch(
+            "opentelemetry.sdk._logs._internal.get_current",
+            return_value=mock_context,
+        ):
+            # Assert emit gets called for warning message
+            with self.assertLogs(level=logging.WARNING):
+                logger.warning("Warning message")
 
-        log_record = processor.get_log_record(0)
+            log_record = processor.get_log_record(0)
 
-        self.assertIsNotNone(log_record)
-        self.assertEqual(log_record.trace_id, INVALID_SPAN_CONTEXT.trace_id)
-        self.assertEqual(log_record.span_id, INVALID_SPAN_CONTEXT.span_id)
-        self.assertEqual(
-            log_record.trace_flags, INVALID_SPAN_CONTEXT.trace_flags
-        )
+            self.assertIsNotNone(log_record)
+            self.assertEqual(
+                log_record.trace_id, INVALID_SPAN_CONTEXT.trace_id
+            )
+            self.assertEqual(log_record.span_id, INVALID_SPAN_CONTEXT.span_id)
+            self.assertEqual(
+                log_record.trace_flags, INVALID_SPAN_CONTEXT.trace_flags
+            )
 
     def test_log_record_observed_timestamp(self):
         processor, logger = set_up_test_logging(logging.WARNING)
@@ -269,7 +279,38 @@ def __str__(self):
 
     def test_log_record_trace_correlation(self):
         processor, logger = set_up_test_logging(logging.WARNING)
-        mock_context = Context()
+
+        tracer = trace.TracerProvider().get_tracer(__name__)
+        with tracer.start_as_current_span("test") as span:
+            mock_context = set_span_in_context(span)
+
+            with patch(
+                "opentelemetry.sdk._logs._internal.get_current",
+                return_value=mock_context,
+            ):
+                with self.assertLogs(level=logging.CRITICAL):
+                    logger.critical("Critical message within span")
+
+                log_record = processor.get_log_record(0)
+
+                self.assertEqual(
+                    log_record.body, "Critical message within span"
+                )
+                self.assertEqual(log_record.severity_text, "CRITICAL")
+                self.assertEqual(
+                    log_record.severity_number, SeverityNumber.FATAL
+                )
+                self.assertEqual(log_record.context, mock_context)
+                span_context = span.get_span_context()
+                self.assertEqual(log_record.trace_id, span_context.trace_id)
+                self.assertEqual(log_record.span_id, span_context.span_id)
+                self.assertEqual(
+                    log_record.trace_flags, span_context.trace_flags
+                )
+
+    def test_log_record_trace_correlation_backwards_compatibility(self):
+        processor, logger = set_up_test_logging(logging.WARNING)
+        mock_context = Context()  # no span in context
 
         tracer = trace.TracerProvider().get_tracer(__name__)
         with tracer.start_as_current_span("test") as span: