[logs-sdk] Remove LogData and extend SDK LogRecord to have instrumentation scope

CHANGELOG.md

@@ -57,6 +57,8 @@ can cause a deadlock to occur over `logging._lock` in some cases ([#4636](https:
   ([#4669](https://github.com/open-telemetry/opentelemetry-python/pull/4669))
 - Set expected User-Agent in HTTP headers for grpc OTLP exporter
   ([#4658](https://github.com/open-telemetry/opentelemetry-python/pull/4658))
+- Remove LogData and extend SDK LogRecord to have instrumentation scope
+  ([#4676](https://github.com/open-telemetry/opentelemetry-python/pull/4676))
 
 ## Version 1.34.0/0.55b0 (2025-06-04)
 

exporter/opentelemetry-exporter-otlp-proto-common/src/opentelemetry/exporter/otlp/proto/common/_internal/_log_encoder/__init__.py

@@ -30,47 +30,47 @@
     ResourceLogs,
     ScopeLogs,
 )
-from opentelemetry.sdk._logs import LogData
+from opentelemetry.sdk._logs import SDKLogRecord
 
 
-def encode_logs(batch: Sequence[LogData]) -> ExportLogsServiceRequest:
+def encode_logs(batch: Sequence[SDKLogRecord]) -> ExportLogsServiceRequest:
     return ExportLogsServiceRequest(resource_logs=_encode_resource_logs(batch))
 
 
-def _encode_log(log_data: LogData) -> PB2LogRecord:
+def _encode_log(sdk_log_record: SDKLogRecord) -> PB2LogRecord:
     span_id = (
         None
-        if log_data.log_record.span_id == 0
-        else _encode_span_id(log_data.log_record.span_id)
+        if sdk_log_record.log_record.span_id == 0
+        else _encode_span_id(sdk_log_record.log_record.span_id)
     )
     trace_id = (
         None
-        if log_data.log_record.trace_id == 0
-        else _encode_trace_id(log_data.log_record.trace_id)
+        if sdk_log_record.log_record.trace_id == 0
+        else _encode_trace_id(sdk_log_record.log_record.trace_id)
     )
-    body = log_data.log_record.body
+    body = sdk_log_record.log_record.body
     return PB2LogRecord(
-        time_unix_nano=log_data.log_record.timestamp,
-        observed_time_unix_nano=log_data.log_record.observed_timestamp,
+        time_unix_nano=sdk_log_record.log_record.timestamp,
+        observed_time_unix_nano=sdk_log_record.log_record.observed_timestamp,
         span_id=span_id,
         trace_id=trace_id,
-        flags=int(log_data.log_record.trace_flags),
+        flags=int(sdk_log_record.log_record.trace_flags),
         body=_encode_value(body, allow_null=True),
-        severity_text=log_data.log_record.severity_text,
+        severity_text=sdk_log_record.log_record.severity_text,
         attributes=_encode_attributes(
-            log_data.log_record.attributes, allow_null=True
+            sdk_log_record.log_record.attributes, allow_null=True
         ),
-        dropped_attributes_count=log_data.log_record.dropped_attributes,
-        severity_number=log_data.log_record.severity_number.value,
-        event_name=log_data.log_record.event_name,
+        dropped_attributes_count=sdk_log_record.dropped_attributes,
+        severity_number=sdk_log_record.log_record.severity_number.value,
+        event_name=sdk_log_record.log_record.event_name,
     )
 
 
-def _encode_resource_logs(batch: Sequence[LogData]) -> List[ResourceLogs]:
+def _encode_resource_logs(batch: Sequence[SDKLogRecord]) -> List[ResourceLogs]:
     sdk_resource_logs = defaultdict(lambda: defaultdict(list))
 
     for sdk_log in batch:
-        sdk_resource = sdk_log.log_record.resource
+        sdk_resource = sdk_log.resource
         sdk_instrumentation = sdk_log.instrumentation_scope or None
         pb2_log = _encode_log(sdk_log)
 

exporter/opentelemetry-exporter-otlp-proto-common/tests/test_log_encoder.py

@@ -15,7 +15,7 @@
 import unittest
 from typing import List, Tuple
 
-from opentelemetry._logs import SeverityNumber
+from opentelemetry._logs import LogRecord, SeverityNumber
 from opentelemetry.exporter.otlp.proto.common._internal import (
     _encode_attributes,
     _encode_span_id,
@@ -45,8 +45,7 @@
 from opentelemetry.proto.resource.v1.resource_pb2 import (
     Resource as PB2Resource,
 )
-from opentelemetry.sdk._logs import LogData, LogLimits
-from opentelemetry.sdk._logs import LogRecord as SDKLogRecord
+from opentelemetry.sdk._logs import LogLimits, SDKLogRecord
 from opentelemetry.sdk.resources import Resource as SDKResource
 from opentelemetry.sdk.util.instrumentation import InstrumentationScope
 from opentelemetry.trace import (
@@ -77,7 +76,7 @@ def test_encode_no_body(self):
     def test_dropped_attributes_count(self):
         sdk_logs = self._get_test_logs_dropped_attributes()
         encoded_logs = encode_logs(sdk_logs)
-        self.assertTrue(hasattr(sdk_logs[0].log_record, "dropped_attributes"))
+        self.assertTrue(hasattr(sdk_logs[0], "dropped_attributes"))
         self.assertEqual(
             # pylint:disable=no-member
             encoded_logs.resource_logs[0]
@@ -88,7 +87,7 @@ def test_dropped_attributes_count(self):
         )
 
     @staticmethod
-    def _get_sdk_log_data() -> List[LogData]:
+    def _get_sdk_log_data() -> List[SDKLogRecord]:
         ctx_log1 = set_span_in_context(
             NonRecordingSpan(
                 SpanContext(
@@ -99,35 +98,35 @@ def _get_sdk_log_data() -> List[LogData]:
                 )
             )
         )
-        log1 = LogData(
-            log_record=SDKLogRecord(
+        log1 = SDKLogRecord(
+            LogRecord(
                 timestamp=1644650195189786880,
                 observed_timestamp=1644650195189786881,
                 context=ctx_log1,
                 severity_text="WARN",
                 severity_number=SeverityNumber.WARN,
                 body="Do not go gentle into that good night. Rage, rage against the dying of the light",
-                resource=SDKResource(
-                    {"first_resource": "value"},
-                    "resource_schema_url",
-                ),
                 attributes={"a": 1, "b": "c"},
             ),
+            resource=SDKResource(
+                {"first_resource": "value"},
+                "resource_schema_url",
+            ),
             instrumentation_scope=InstrumentationScope(
                 "first_name", "first_version"
             ),
         )
 
-        log2 = LogData(
-            log_record=SDKLogRecord(
+        log2 = SDKLogRecord(
+            LogRecord(
                 timestamp=1644650249738562048,
                 observed_timestamp=1644650249738562049,
                 severity_text="WARN",
                 severity_number=SeverityNumber.WARN,
                 body="Cooper, this is no time for caution!",
-                resource=SDKResource({"second_resource": "CASE"}),
                 attributes={},
             ),
+            resource=SDKResource({"second_resource": "CASE"}),
             instrumentation_scope=InstrumentationScope(
                 "second_name", "second_version"
             ),
@@ -143,17 +142,17 @@ def _get_sdk_log_data() -> List[LogData]:
                 )
             )
         )
-        log3 = LogData(
-            log_record=SDKLogRecord(
+        log3 = SDKLogRecord(
+            LogRecord(
                 timestamp=1644650427658989056,
                 observed_timestamp=1644650427658989057,
                 context=ctx_log3,
                 severity_text="DEBUG",
                 severity_number=SeverityNumber.DEBUG,
                 body="To our galaxy",
-                resource=SDKResource({"second_resource": "CASE"}),
                 attributes={"a": 1, "b": "c"},
             ),
+            resource=SDKResource({"second_resource": "CASE"}),
             instrumentation_scope=None,
         )
 
@@ -167,20 +166,20 @@ def _get_sdk_log_data() -> List[LogData]:
                 )
             )
         )
-        log4 = LogData(
-            log_record=SDKLogRecord(
+        log4 = SDKLogRecord(
+            LogRecord(
                 timestamp=1644650584292683008,
                 observed_timestamp=1644650584292683009,
                 context=ctx_log4,
                 severity_text="INFO",
                 severity_number=SeverityNumber.INFO,
                 body="Love is the one thing that transcends time and space",
-                resource=SDKResource(
-                    {"first_resource": "value"},
-                    "resource_schema_url",
-                ),
                 attributes={"filename": "model.py", "func_name": "run_method"},
             ),
+            resource=SDKResource(
+                {"first_resource": "value"},
+                "resource_schema_url",
+            ),
             instrumentation_scope=InstrumentationScope(
                 "another_name", "another_version"
             ),
@@ -196,17 +195,17 @@ def _get_sdk_log_data() -> List[LogData]:
                 )
             )
         )
-        log5 = LogData(
-            log_record=SDKLogRecord(
+        log5 = SDKLogRecord(
+            LogRecord(
                 timestamp=1644650584292683009,
                 observed_timestamp=1644650584292683010,
                 context=ctx_log5,
                 severity_text="INFO",
                 severity_number=SeverityNumber.INFO,
                 body={"error": None, "array_with_nones": [1, None, 2]},
-                resource=SDKResource({}),
                 attributes={},
             ),
+            resource=SDKResource({}),
             instrumentation_scope=InstrumentationScope(
                 "last_name", "last_version"
             ),
@@ -222,20 +221,20 @@ def _get_sdk_log_data() -> List[LogData]:
                 )
             )
         )
-        log6 = LogData(
-            log_record=SDKLogRecord(
+        log6 = SDKLogRecord(
+            LogRecord(
                 timestamp=1644650584292683022,
                 observed_timestamp=1644650584292683022,
                 context=ctx_log6,
                 severity_text="ERROR",
                 severity_number=SeverityNumber.ERROR,
                 body="This instrumentation scope has a schema url",
-                resource=SDKResource(
-                    {"first_resource": "value"},
-                    "resource_schema_url",
-                ),
                 attributes={"filename": "model.py", "func_name": "run_method"},
             ),
+            resource=SDKResource(
+                {"first_resource": "value"},
+                "resource_schema_url",
+            ),
             instrumentation_scope=InstrumentationScope(
                 "scope_with_url",
                 "scope_with_url_version",
@@ -253,20 +252,20 @@ def _get_sdk_log_data() -> List[LogData]:
                 )
             )
         )
-        log7 = LogData(
-            log_record=SDKLogRecord(
+        log7 = SDKLogRecord(
+            LogRecord(
                 timestamp=1644650584292683033,
                 observed_timestamp=1644650584292683033,
                 context=ctx_log7,
                 severity_text="FATAL",
                 severity_number=SeverityNumber.FATAL,
                 body="This instrumentation scope has a schema url and attributes",
-                resource=SDKResource(
-                    {"first_resource": "value"},
-                    "resource_schema_url",
-                ),
                 attributes={"filename": "model.py", "func_name": "run_method"},
             ),
+            resource=SDKResource(
+                {"first_resource": "value"},
+                "resource_schema_url",
+            ),
             instrumentation_scope=InstrumentationScope(
                 "scope_with_attributes",
                 "scope_with_attributes_version",
@@ -285,21 +284,21 @@ def _get_sdk_log_data() -> List[LogData]:
                 )
             )
         )
-        log8 = LogData(
-            log_record=SDKLogRecord(
+        log8 = SDKLogRecord(
+            LogRecord(
                 timestamp=1644650584292683044,
                 observed_timestamp=1644650584292683044,
                 context=ctx_log8,
                 severity_text="INFO",
                 severity_number=SeverityNumber.INFO,
                 body="Test export of extended attributes",
-                resource=SDKResource({}),
                 attributes={
                     "extended": {
                         "sequence": [{"inner": "mapping", "none": None}]
                     }
                 },
             ),
+            resource=SDKResource({}),
             instrumentation_scope=InstrumentationScope(
                 "extended_name", "extended_version"
             ),
@@ -601,7 +600,7 @@ def get_test_logs(
         return sdk_logs, pb2_service_request
 
     @staticmethod
-    def _get_test_logs_dropped_attributes() -> List[LogData]:
+    def _get_test_logs_dropped_attributes() -> List[SDKLogRecord]:
         ctx_log1 = set_span_in_context(
             NonRecordingSpan(
                 SpanContext(
@@ -612,34 +611,34 @@ def _get_test_logs_dropped_attributes() -> List[LogData]:
                 )
             )
         )
-        log1 = LogData(
-            log_record=SDKLogRecord(
+        log1 = SDKLogRecord(
+            LogRecord(
                 timestamp=1644650195189786880,
                 context=ctx_log1,
                 severity_text="WARN",
                 severity_number=SeverityNumber.WARN,
                 body="Do not go gentle into that good night. Rage, rage against the dying of the light",
-                resource=SDKResource({"first_resource": "value"}),
                 attributes={"a": 1, "b": "c", "user_id": "B121092"},
-                limits=LogLimits(max_attributes=1),
             ),
+            resource=SDKResource({"first_resource": "value"}),
+            limits=LogLimits(max_attributes=1),
             instrumentation_scope=InstrumentationScope(
                 "first_name", "first_version"
             ),
         )
         ctx_log2 = set_span_in_context(
             NonRecordingSpan(SpanContext(0, 0, False))
         )
-        log2 = LogData(
-            log_record=SDKLogRecord(
+        log2 = SDKLogRecord(
+            LogRecord(
                 timestamp=1644650249738562048,
                 context=ctx_log2,
                 severity_text="WARN",
                 severity_number=SeverityNumber.WARN,
                 body="Cooper, this is no time for caution!",
-                resource=SDKResource({"second_resource": "CASE"}),
                 attributes={},
             ),
+            resource=SDKResource({"second_resource": "CASE"}),
             instrumentation_scope=InstrumentationScope(
                 "second_name", "second_version"
             ),

exporter/opentelemetry-exporter-otlp-proto-grpc/src/opentelemetry/exporter/otlp/proto/grpc/_log_exporter/__init__.py

@@ -28,8 +28,7 @@
 from opentelemetry.proto.collector.logs.v1.logs_service_pb2_grpc import (
     LogsServiceStub,
 )
-from opentelemetry.sdk._logs import LogData
-from opentelemetry.sdk._logs import LogRecord as SDKLogRecord
+from opentelemetry.sdk._logs import SDKLogRecord
 from opentelemetry.sdk._logs.export import LogExporter, LogExportResult
 from opentelemetry.sdk.environment_variables import (
     OTEL_EXPORTER_OTLP_LOGS_CERTIFICATE,
@@ -105,11 +104,11 @@ def __init__(
         )
 
     def _translate_data(
-        self, data: Sequence[LogData]
+        self, data: Sequence[SDKLogRecord]
     ) -> ExportLogsServiceRequest:
         return encode_logs(data)
 
-    def export(self, batch: Sequence[LogData]) -> LogExportResult:
+    def export(self, batch: Sequence[SDKLogRecord]) -> LogExportResult:
         return self._export(batch)
 
     def shutdown(self, timeout_millis: float = 30_000, **kwargs) -> None: