Merge branch 'main' into otlp-http-metrics-export-max-batch

Author: tammy-baylis-swi

CHANGELOG.md

@@ -21,6 +21,53 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   ([#4760](https://github.com/open-telemetry/opentelemetry-python/pull/4760))
 - semantic-conventions: Bump to 1.38.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:**
+  
+  `LogData` has been removed. Users should update their code as follows:
+  
+  - **For Log Exporters:** Change from `Sequence[LogData]` to `Sequence[ReadableLogRecord]`
+    ```python
+    # Before
+    from opentelemetry.sdk._logs import LogData
+    def export(self, batch: Sequence[LogData]) -> LogRecordExportResult:
+        ...
+    
+    # After
+    from opentelemetry.sdk._logs import ReadableLogRecord
+    def export(self, batch: Sequence[ReadableLogRecord]) -> LogRecordExportResult:
+        ...
+    ```
+  
+  - **For Log Processors:** Use `ReadWriteLogRecord` for processing, `ReadableLogRecord` for exporting
+    ```python
+    # Before
+    from opentelemetry.sdk._logs import LogData
+    def on_emit(self, log_data: LogData):
+        ...
+    
+    # After
+    from opentelemetry.sdk._logs import ReadWriteLogRecord, ReadableLogRecord
+    def on_emit(self, log_record: ReadWriteLogRecord):
+        # Convert to ReadableLogRecord before exporting
+        readable = ReadableLogRecord(
+            log_record=log_record.log_record,
+            resource=log_record.resource or Resource.create({}),
+            instrumentation_scope=log_record.instrumentation_scope,
+            limits=log_record.limits,
+        )
+        ...
+    ```
+  
+  - **Accessing log data:** Use the same attributes on `ReadableLogRecord`/`ReadWriteLogRecord`
+    - `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 LogRecordLimits
 - Add configurable `max_export_batch_size` to OTLP HTTP metrics exporter
   ([#4576](https://github.com/open-telemetry/opentelemetry-python/pull/4576))
 

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/src/opentelemetry/exporter/otlp/proto/common/_internal/_log_encoder/__init__.py

@@ -30,51 +30,55 @@
     ResourceLogs,
     ScopeLogs,
 )
-from opentelemetry.sdk._logs import LogData
+from opentelemetry.sdk._logs import ReadableLogRecord
 
 
-def encode_logs(batch: Sequence[LogData]) -> ExportLogsServiceRequest:
+def encode_logs(
+    batch: Sequence[ReadableLogRecord],
+) -> ExportLogsServiceRequest:
     return ExportLogsServiceRequest(resource_logs=_encode_resource_logs(batch))
 
 
-def _encode_log(log_data: LogData) -> PB2LogRecord:
+def _encode_log(readable_log_record: ReadableLogRecord) -> PB2LogRecord:
     span_id = (
         None
-        if log_data.log_record.span_id == 0
-        else _encode_span_id(log_data.log_record.span_id)
+        if readable_log_record.log_record.span_id == 0
+        else _encode_span_id(readable_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 readable_log_record.log_record.trace_id == 0
+        else _encode_trace_id(readable_log_record.log_record.trace_id)
     )
-    body = log_data.log_record.body
+    body = readable_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=readable_log_record.log_record.timestamp,
+        observed_time_unix_nano=readable_log_record.log_record.observed_timestamp,
         span_id=span_id,
         trace_id=trace_id,
-        flags=int(log_data.log_record.trace_flags),
+        flags=int(readable_log_record.log_record.trace_flags),
         body=_encode_value(body, allow_null=True),
-        severity_text=log_data.log_record.severity_text,
+        severity_text=readable_log_record.log_record.severity_text,
         attributes=_encode_attributes(
-            log_data.log_record.attributes, allow_null=True
+            readable_log_record.log_record.attributes, allow_null=True
         ),
-        dropped_attributes_count=log_data.log_record.dropped_attributes,
+        dropped_attributes_count=readable_log_record.dropped_attributes,
         severity_number=getattr(
-            log_data.log_record.severity_number, "value", None
+            readable_log_record.log_record.severity_number, "value", None
         ),
-        event_name=log_data.log_record.event_name,
+        event_name=readable_log_record.log_record.event_name,
     )
 
 
-def _encode_resource_logs(batch: Sequence[LogData]) -> List[ResourceLogs]:
+def _encode_resource_logs(
+    batch: Sequence[ReadableLogRecord],
+) -> List[ResourceLogs]:
     sdk_resource_logs = defaultdict(lambda: defaultdict(list))
 
-    for sdk_log in batch:
-        sdk_resource = sdk_log.log_record.resource
-        sdk_instrumentation = sdk_log.instrumentation_scope or None
-        pb2_log = _encode_log(sdk_log)
+    for readable_log in batch:
+        sdk_resource = readable_log.resource
+        sdk_instrumentation = readable_log.instrumentation_scope or None
+        pb2_log = _encode_log(readable_log)
 
         sdk_resource_logs[sdk_resource][sdk_instrumentation].append(pb2_log)