Update LogRecord API; simplify test

Author: tammy-baylis-swi

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

@@ -37,7 +37,9 @@
 from logging import getLogger
 from os import environ
 from time import time_ns
-from typing import Optional, cast
+from typing import Optional, cast, overload
+
+from typing_extensions import deprecated
 
 from opentelemetry._logs.severity import SeverityNumber
 from opentelemetry.context.context import Context
@@ -58,6 +60,35 @@ class LogRecord(ABC):
     pertinent to the event being logged.
     """
 
+    @overload
+    def __init__(
+        self,
+        timestamp: Optional[int] = None,
+        observed_timestamp: Optional[int] = None,
+        context: Optional[Context] = None,
+        severity_text: Optional[str] = None,
+        severity_number: Optional[SeverityNumber] = None,
+        body: AnyValue = None,
+        attributes: Optional[_ExtendedAttributes] = None,
+    ): ...
+
+    @overload
+    @deprecated(
+        "LogRecord init with `trace_id`, `span_id`, and/or `trace_flags` is deprecated. Use `context` instead."
+    )
+    def __init__(
+        self,
+        timestamp: Optional[int] = None,
+        observed_timestamp: Optional[int] = None,
+        trace_id: Optional[int] = None,
+        span_id: Optional[int] = None,
+        trace_flags: Optional["TraceFlags"] = None,
+        severity_text: Optional[str] = None,
+        severity_number: Optional[SeverityNumber] = None,
+        body: AnyValue = None,
+        attributes: Optional[_ExtendedAttributes] = None,
+    ): ...
+
     def __init__(
         self,
         timestamp: Optional[int] = None,

opentelemetry-sdk/tests/logs/test_handler.py

@@ -20,7 +20,6 @@
 from opentelemetry._logs import NoOpLoggerProvider, SeverityNumber
 from opentelemetry._logs import get_logger as APIGetLogger
 from opentelemetry.attributes import BoundedAttributes
-from opentelemetry.context.context import Context
 from opentelemetry.sdk import trace
 from opentelemetry.sdk._logs import (
     LogData,
@@ -95,6 +94,8 @@ def test_log_flush_noop(self):
 
     def test_log_record_no_span_context(self):
         processor, logger = set_up_test_logging(logging.WARNING)
+
+        # Assert emit gets called for warning message
         with self.assertLogs(level=logging.WARNING):
             logger.warning("Warning message")
 
@@ -299,35 +300,23 @@ def test_log_record_trace_correlation(self):
                     log_record.trace_flags, span_context.trace_flags
                 )
 
-    def test_log_record_trace_correlation_backwards_compatibility(self):
+    def test_log_record_trace_correlation_deprecated(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:
-            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
-                )
+            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)
+            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_warning_without_formatter(self):
         processor, logger = set_up_test_logging(logging.WARNING)