[logs-api/sdk] Rename several classes from Log to LogRecord (#4647)

* Rename several classes from Log to LogRecord

* Format and changelog

* Addressing comments

* ruff

* Add exports

* Fix test

* Fix test

* Update changelog

* Add deprecated classes back

---------

Co-authored-by: Riccardo Magliocchetti <[email protected]>
Co-authored-by: Tammy Baylis <[email protected]>

Author: 3 people

CHANGELOG.md

@@ -23,6 +23,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   ([#4791](https://github.com/open-telemetry/opentelemetry-python/pull/4791))
 - [BREAKING] Remove LogData and extend SDK LogRecord to have instrumentation scope
   ([#4676](https://github.com/open-telemetry/opentelemetry-python/pull/4676))
+- [BREAKING] Rename several classes from Log to LogRecord
+  ([#4647](https://github.com/open-telemetry/opentelemetry-python/pull/4647))
 
   **Migration Guide:**
 
@@ -32,12 +34,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
     ```python
     # Before
     from opentelemetry.sdk._logs import LogData
-    def export(self, batch: Sequence[LogData]) -> LogExportResult:
+    def export(self, batch: Sequence[LogData]) -> LogRecordExportResult:
         ...
 
     # After
     from opentelemetry.sdk._logs import ReadableLogRecord
-    def export(self, batch: Sequence[ReadableLogRecord]) -> LogExportResult:
+    def export(self, batch: Sequence[ReadableLogRecord]) -> LogRecordExportResult:
         ...
     ```
 
@@ -65,7 +67,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
     - `log_record.log_record` - The API LogRecord (contains body, severity, attributes, etc.)
     - `log_record.resource` - The Resource
     - `log_record.instrumentation_scope` - The InstrumentationScope (now included, was in LogData before)
-    - `log_record.limits` - The LogLimits
+    - `log_record.limits` - The LogRecordLimits
 
 ## Version 1.38.0/0.59b0 (2025-10-16)
 

docs/conf.py

@@ -145,8 +145,11 @@
         "py:class",
         "opentelemetry.proto.collector.metrics.v1.metrics_service_pb2.ExportMetricsServiceRequest",
     ),
-    ("py:class", "opentelemetry.sdk._logs._internal.export.LogExporter"),
-    ("py:class", "opentelemetry.sdk._logs._internal.export.LogExportResult"),
+    ("py:class", "opentelemetry.sdk._logs._internal.export.LogRecordExporter"),
+    (
+        "py:class",
+        "opentelemetry.sdk._logs._internal.export.LogRecordExportResult",
+    ),
     (
         "py:class",
         "opentelemetry.proto.collector.logs.v1.logs_service_pb2.ExportLogsServiceRequest",

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

@@ -45,7 +45,7 @@
 from opentelemetry.proto.resource.v1.resource_pb2 import (
     Resource as PB2Resource,
 )
-from opentelemetry.sdk._logs import LogLimits, ReadWriteLogRecord
+from opentelemetry.sdk._logs import LogRecordLimits, ReadWriteLogRecord
 from opentelemetry.sdk.resources import Resource as SDKResource
 from opentelemetry.sdk.util.instrumentation import InstrumentationScope
 from opentelemetry.trace import (
@@ -667,7 +667,7 @@ def _get_test_logs_dropped_attributes() -> List[ReadWriteLogRecord]:
                 attributes={"a": 1, "b": "c", "user_id": "B121092"},
             ),
             resource=SDKResource({"first_resource": "value"}),
-            limits=LogLimits(max_attributes=1),
+            limits=LogRecordLimits(max_attributes=1),
             instrumentation_scope=InstrumentationScope(
                 "first_name", "first_version"
             ),

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

@@ -29,7 +29,10 @@
     LogsServiceStub,
 )
 from opentelemetry.sdk._logs import ReadableLogRecord
-from opentelemetry.sdk._logs.export import LogExporter, LogExportResult
+from opentelemetry.sdk._logs.export import (
+    LogRecordExporter,
+    LogRecordExportResult,
+)
 from opentelemetry.sdk.environment_variables import (
     _OTEL_PYTHON_EXPORTER_OTLP_GRPC_LOGS_CREDENTIAL_PROVIDER,
     OTEL_EXPORTER_OTLP_LOGS_CERTIFICATE,
@@ -44,11 +47,11 @@
 
 
 class OTLPLogExporter(
-    LogExporter,
+    LogRecordExporter,
     OTLPExporterMixin[
         Sequence[ReadableLogRecord],
         ExportLogsServiceRequest,
-        LogExportResult,
+        LogRecordExportResult,
         LogsServiceStub,
     ],
 ):
@@ -100,7 +103,7 @@ def __init__(
             timeout=timeout or environ_timeout,
             compression=compression,
             stub=LogsServiceStub,
-            result=LogExportResult,
+            result=LogRecordExportResult,
             channel_options=channel_options,
         )
 
@@ -112,7 +115,7 @@ def _translate_data(
     def export(  # type: ignore [reportIncompatibleMethodOverride]
         self,
         batch: Sequence[ReadableLogRecord],
-    ) -> Literal[LogExportResult.SUCCESS, LogExportResult.FAILURE]:
+    ) -> Literal[LogRecordExportResult.SUCCESS, LogRecordExportResult.FAILURE]:
         return OTLPExporterMixin._export(self, batch)
 
     def shutdown(self, timeout_millis: float = 30_000, **kwargs) -> None:

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

@@ -81,7 +81,7 @@
 )
 from opentelemetry.proto.resource.v1.resource_pb2 import Resource  # noqa: F401
 from opentelemetry.sdk._logs import ReadableLogRecord
-from opentelemetry.sdk._logs.export import LogExportResult
+from opentelemetry.sdk._logs.export import LogRecordExportResult
 from opentelemetry.sdk._shared_internal import DuplicateFilter
 from opentelemetry.sdk.environment_variables import (
     _OTEL_PYTHON_EXPORTER_OTLP_GRPC_CREDENTIAL_PROVIDER,
@@ -132,7 +132,7 @@
 )
 ExportResultT = TypeVar(
     "ExportResultT",
-    LogExportResult,
+    LogRecordExportResult,
     MetricExportResult,
     SpanExportResult,
 )

exporter/opentelemetry-exporter-otlp-proto-grpc/tests/test_otlp_exporter_mixin.py

@@ -63,7 +63,7 @@
 
 
 # The below tests use this test SpanExporter and Spans, but are testing the
-# underlying behavior in the mixin. A MetricExporter or LogExporter could
+# underlying behavior in the mixin. A MetricExporter or LogRecordExporter could
 # just as easily be used.
 class OTLPSpanExporterForTesting(
     SpanExporter,

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

@@ -36,8 +36,8 @@
 )
 from opentelemetry.sdk._logs import ReadableLogRecord
 from opentelemetry.sdk._logs.export import (
-    LogExporter,
-    LogExportResult,
+    LogRecordExporter,
+    LogRecordExportResult,
 )
 from opentelemetry.sdk._shared_internal import DuplicateFilter
 from opentelemetry.sdk.environment_variables import (
@@ -71,7 +71,7 @@
 _MAX_RETRYS = 6
 
 
-class OTLPLogExporter(LogExporter):
+class OTLPLogExporter(LogRecordExporter):
     def __init__(
         self,
         endpoint: Optional[str] = None,
@@ -176,17 +176,19 @@ def _export(
             )
         return resp
 
-    def export(self, batch: Sequence[ReadableLogRecord]) -> LogExportResult:
+    def export(
+        self, batch: Sequence[ReadableLogRecord]
+    ) -> LogRecordExportResult:
         if self._shutdown:
             _logger.warning("Exporter already shutdown, ignoring batch")
-            return LogExportResult.FAILURE
+            return LogRecordExportResult.FAILURE
 
         serialized_data = encode_logs(batch).SerializeToString()
         deadline_sec = time() + self._timeout
         for retry_num in range(_MAX_RETRYS):
             resp = self._export(serialized_data, deadline_sec - time())
             if resp.ok:
-                return LogExportResult.SUCCESS
+                return LogRecordExportResult.SUCCESS
             # multiplying by a random number between .8 and 1.2 introduces a +/20% jitter to each backoff.
             backoff_seconds = 2**retry_num * random.uniform(0.8, 1.2)
             if (
@@ -200,7 +202,7 @@ def export(self, batch: Sequence[ReadableLogRecord]) -> LogExportResult:
                     resp.status_code,
                     resp.text,
                 )
-                return LogExportResult.FAILURE
+                return LogRecordExportResult.FAILURE
             _logger.warning(
                 "Transient error %s encountered while exporting logs batch, retrying in %.2fs.",
                 resp.reason,
@@ -210,7 +212,7 @@ def export(self, batch: Sequence[ReadableLogRecord]) -> LogExportResult:
             if shutdown:
                 _logger.warning("Shutdown in progress, aborting retry.")
                 break
-        return LogExportResult.FAILURE
+        return LogRecordExportResult.FAILURE
 
     def force_flush(self, timeout_millis: float = 10_000) -> bool:
         """Nothing is buffered in this exporter, so this method does nothing."""

exporter/opentelemetry-exporter-otlp-proto-http/tests/test_proto_log_exporter.py

@@ -40,7 +40,7 @@
     ExportLogsServiceRequest,
 )
 from opentelemetry.sdk._logs import ReadWriteLogRecord
-from opentelemetry.sdk._logs.export import LogExportResult
+from opentelemetry.sdk._logs.export import LogRecordExportResult
 from opentelemetry.sdk.environment_variables import (
     _OTEL_PYTHON_EXPORTER_OTLP_HTTP_LOGS_CREDENTIAL_PROVIDER,
     OTEL_EXPORTER_OTLP_CERTIFICATE,
@@ -454,7 +454,8 @@ def test_2xx_status_code(self, mock_otlp_metric_exporter):
         """
 
         self.assertEqual(
-            OTLPLogExporter().export(MagicMock()), LogExportResult.SUCCESS
+            OTLPLogExporter().export(MagicMock()),
+            LogRecordExportResult.SUCCESS,
         )
 
     @patch.object(Session, "post")
@@ -470,7 +471,7 @@ def test_retry_timeout(self, mock_post):
             # Set timeout to 1.5 seconds
             self.assertEqual(
                 exporter.export(self._get_sdk_log_data()),
-                LogExportResult.FAILURE,
+                LogRecordExportResult.FAILURE,
             )
             after = time.time()
             # First call at time 0, second at time 1, then an early return before the second backoff sleep b/c it would exceed timeout.

opentelemetry-sdk/benchmarks/logs/test_benchmark_logging_handler.py

@@ -4,14 +4,14 @@
 
 from opentelemetry.sdk._logs import LoggerProvider, LoggingHandler
 from opentelemetry.sdk._logs.export import (
-    InMemoryLogExporter,
+    InMemoryLogRecordExporter,
     SimpleLogRecordProcessor,
 )
 
 
 def _set_up_logging_handler(level):
     logger_provider = LoggerProvider()
-    exporter = InMemoryLogExporter()
+    exporter = InMemoryLogRecordExporter()
     processor = SimpleLogRecordProcessor(exporter=exporter)
     logger_provider.add_log_record_processor(processor)
     handler = LoggingHandler(level=level, logger_provider=logger_provider)

opentelemetry-sdk/pyproject.toml

@@ -49,7 +49,7 @@ parentbased_traceidratio = "opentelemetry.sdk.trace.sampling:ParentBasedTraceIdR
 sdk_logger_provider = "opentelemetry.sdk._logs:LoggerProvider"
 
 [project.entry-points.opentelemetry_logs_exporter]
-console = "opentelemetry.sdk._logs.export:ConsoleLogExporter"
+console = "opentelemetry.sdk._logs.export:ConsoleLogRecordExporter"
 
 [project.entry-points.opentelemetry_meter_provider]
 sdk_meter_provider = "opentelemetry.sdk.metrics:MeterProvider"