opentelemetry-sdk: stabilize logs signal

.changelog/5732.changed

@@ -0,0 +1 @@
+`opentelemetry-sdk`: stabilize the logs SDK as `opentelemetry.sdk.logs`

.changelog/5732.deprecated

@@ -0,0 +1 @@
+`opentelemetry-sdk`: deprecate `opentelemetry.sdk._logs` in favor of `opentelemetry.sdk.logs`

.changelog/5732.removed

@@ -0,0 +1 @@
+`opentelemetry-sdk`: remove deprecated `LoggingHandler` and `OTEL_PYTHON_LOGGING_AUTO_INSTRUMENTATION_ENABLED`

.changelog/5732.removed.1

@@ -0,0 +1 @@
+`opentelemetry-sdk`: remove deprecated `Log*` aliases of the `LogRecord*` logs classes

docs/conf.py

@@ -153,10 +153,10 @@
         "py:class",
         "opentelemetry.proto.collector.metrics.v1.metrics_service_pb2.ExportMetricsServiceRequest",
     ),
-    ("py:class", "opentelemetry.sdk._logs._internal.export.LogRecordExporter"),
+    ("py:class", "opentelemetry.sdk.logs._internal.export.LogRecordExporter"),
     (
         "py:class",
-        "opentelemetry.sdk._logs._internal.export.LogRecordExportResult",
+        "opentelemetry.sdk.logs._internal.export.LogRecordExportResult",
     ),
     (
         "py:class",

docs/examples/logs/README.rst

@@ -1,11 +1,6 @@
 OpenTelemetry Logs SDK
 ======================
 
-.. warning::
-   OpenTelemetry Python logs are in an experimental state. The APIs within
-   :mod:`opentelemetry.sdk._logs` are subject to change in minor/patch releases and make no
-   backward compatibility guarantees at this time.
-
 The source files of these examples are available :scm_web:`here <docs/examples/logs/>`.
 
 .. note::

docs/examples/logs/example.py

@@ -11,8 +11,8 @@
 # this is available in the opentelemetry-instrumentation-logging package
 from opentelemetry.instrumentation.logging.handler import LoggingHandler
 from opentelemetry.logs import set_logger_provider
-from opentelemetry.sdk._logs import LoggerProvider
-from opentelemetry.sdk._logs.export import BatchLogRecordProcessor
+from opentelemetry.sdk.logs import LoggerProvider
+from opentelemetry.sdk.logs.export import BatchLogRecordProcessor
 from opentelemetry.sdk.resources import Resource
 from opentelemetry.sdk.trace import TracerProvider
 from opentelemetry.sdk.trace.export import (

docs/examples/metrics/sdk-metrics/sdk_metrics.py

@@ -14,8 +14,8 @@
 from opentelemetry.exporter.otlp.proto.http.trace_exporter import (
     OTLPSpanExporter,
 )
-from opentelemetry.sdk._logs import LoggerProvider
-from opentelemetry.sdk._logs.export import SimpleLogRecordProcessor
+from opentelemetry.sdk.logs import LoggerProvider
+from opentelemetry.sdk.logs.export import SimpleLogRecordProcessor
 from opentelemetry.sdk.metrics import MeterProvider
 from opentelemetry.sdk.metrics.export import PeriodicExportingMetricReader
 from opentelemetry.sdk.resources import Resource

docs/examples/multi-destination-exporting/README.rst

@@ -20,7 +20,7 @@ or reader per destination:
   ``metric_readers`` parameter.
 
 * **Logs**: Use one ``BatchLogRecordProcessor`` per destination, each
-  wrapping its own ``LogExporter``. Add each processor to the
+  wrapping its own ``LogRecordExporter``. Add each processor to the
   ``LoggerProvider`` via ``add_log_record_processor()``.
 
 .. note::

docs/examples/multi-destination-exporting/multi_destination_logs.py

@@ -19,8 +19,8 @@
 # this is available in the opentelemetry-instrumentation-logging package
 from opentelemetry.instrumentation.logging.handler import LoggingHandler
 from opentelemetry.logs import set_logger_provider
-from opentelemetry.sdk._logs import LoggerProvider
-from opentelemetry.sdk._logs.export import (
+from opentelemetry.sdk.logs import LoggerProvider
+from opentelemetry.sdk.logs.export import (
     BatchLogRecordProcessor,
     ConsoleLogRecordExporter,
 )

docs/sdk/configuration.rst

@@ -144,7 +144,6 @@ Behavior notes
   components the file enables (for example resource detectors) and via
   ``${env:VAR}`` substitution.
 * Python-implementation extensions (``OTEL_PYTHON_*`` variables such as
-  ``OTEL_PYTHON_LOGGING_AUTO_INSTRUMENTATION_ENABLED`` or
   ``OTEL_PYTHON_TRACER_CONFIGURATOR``) are **not** applied when
   ``OTEL_CONFIG_FILE`` is set: the env-var initialisation path is skipped
   entirely. If your app currently relies on one of these and you are

docs/sdk/index.rst

@@ -14,7 +14,7 @@ processed, and exported.
 .. toctree::
     :maxdepth: 1
 
-    _logs
+    logs
     resources
     trace
     metrics

docs/sdk/logs.export.rst

@@ -0,0 +1,7 @@
+opentelemetry.sdk.logs.export
+=============================
+
+.. automodule:: opentelemetry.sdk.logs.export
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/sdk/_logs.rst → docs/sdk/logs.rst

@@ -1,17 +1,17 @@
-opentelemetry.sdk._logs package
-===============================
+opentelemetry.sdk.logs package
+==============================
 
 Submodules
 ----------
 
 .. toctree::
 
-   _logs.export
+   logs.export
 
 Module contents
 ---------------
 
-.. automodule:: opentelemetry.sdk._logs
+.. automodule:: opentelemetry.sdk.logs
     :members:
     :undoc-members:
     :show-inheritance:

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

@@ -27,7 +27,7 @@
 from opentelemetry.proto_json.logs.v1.logs import (
     ScopeLogs as JSONScopeLogs,
 )
-from opentelemetry.sdk._logs import ReadableLogRecord
+from opentelemetry.sdk.logs import ReadableLogRecord
 from opentelemetry.util.types import Attributes
 
 

exporter/opentelemetry-exporter-otlp-json-common/tests/__init__.py

@@ -5,7 +5,7 @@
 import unittest
 
 from opentelemetry.logs import LogRecord, SeverityNumber
-from opentelemetry.sdk._logs import ReadableLogRecord
+from opentelemetry.sdk.logs import ReadableLogRecord
 from opentelemetry.sdk.metrics.export import (
     AggregationTemporality,
     Buckets,

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

@@ -27,7 +27,7 @@
 from opentelemetry.proto.resource.v1.resource_pb2 import (
     Resource as PB2Resource,
 )
-from opentelemetry.sdk._logs import LogRecordLimits, 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 (

exporter/opentelemetry-exporter-otlp-json-file/src/opentelemetry/exporter/otlp/json/file/_log_exporter.py

@@ -8,12 +8,12 @@
 
 from opentelemetry.exporter.otlp.json.common._log_encoder import encode_logs
 from opentelemetry.exporter.otlp.json.file._internal import _FileExporter
-from opentelemetry.sdk._logs import ReadableLogRecord
-from opentelemetry.sdk._logs.export import (
+from opentelemetry.sdk._shared_internal import DuplicateFilter
+from opentelemetry.sdk.logs import ReadableLogRecord
+from opentelemetry.sdk.logs.export import (
     LogRecordExporter,
     LogRecordExportResult,
 )
-from opentelemetry.sdk._shared_internal import DuplicateFilter
 
 _logger = logging.getLogger(__name__)
 _logger.addFilter(DuplicateFilter())

exporter/opentelemetry-exporter-otlp-json-file/tests/test_log_exporter.py

@@ -17,11 +17,11 @@
 )
 from opentelemetry.logs import LogRecord, SeverityNumber
 from opentelemetry.proto_json.logs.v1.logs import LogsData
-from opentelemetry.sdk._logs import (
+from opentelemetry.sdk.logs import (
     LoggerProvider,
     ReadableLogRecord,
 )
-from opentelemetry.sdk._logs.export import (
+from opentelemetry.sdk.logs.export import (
     InMemoryLogRecordExporter,
     LogRecordExportResult,
     SimpleLogRecordProcessor,

exporter/opentelemetry-exporter-otlp-json-http/src/opentelemetry/exporter/otlp/json/http/_log_exporter.py

@@ -20,11 +20,6 @@
     _resolve_headers,
     _resolve_timeout,
 )
-from opentelemetry.sdk._logs import ReadableLogRecord
-from opentelemetry.sdk._logs.export import (
-    LogRecordExporter,
-    LogRecordExportResult,
-)
 from opentelemetry.sdk._shared_internal import DuplicateFilter
 from opentelemetry.sdk.environment_variables import (
     OTEL_EXPORTER_OTLP_LOGS_CERTIFICATE,
@@ -35,6 +30,11 @@
     OTEL_EXPORTER_OTLP_LOGS_HEADERS,
     OTEL_EXPORTER_OTLP_LOGS_TIMEOUT,
 )
+from opentelemetry.sdk.logs import ReadableLogRecord
+from opentelemetry.sdk.logs.export import (
+    LogRecordExporter,
+    LogRecordExportResult,
+)
 
 _DEFAULT_LOGS_EXPORT_PATH = "v1/logs"
 

exporter/opentelemetry-exporter-otlp-json-http/tests/test_log_exporter.py

@@ -27,12 +27,6 @@
     OTLPLogExporter,
 )
 from opentelemetry.logs import LogRecord, SeverityNumber
-from opentelemetry.sdk._logs import LoggerProvider
-from opentelemetry.sdk._logs.export import (
-    InMemoryLogRecordExporter,
-    LogRecordExportResult,
-    SimpleLogRecordProcessor,
-)
 from opentelemetry.sdk.environment_variables import (
     OTEL_EXPORTER_OTLP_ENDPOINT,
     OTEL_EXPORTER_OTLP_HEADERS,
@@ -44,6 +38,12 @@
     OTEL_EXPORTER_OTLP_LOGS_TIMEOUT,
     OTEL_EXPORTER_OTLP_TIMEOUT,
 )
+from opentelemetry.sdk.logs import LoggerProvider
+from opentelemetry.sdk.logs.export import (
+    InMemoryLogRecordExporter,
+    LogRecordExportResult,
+    SimpleLogRecordProcessor,
+)
 from opentelemetry.sdk.resources import Resource
 from opentelemetry.trace import (
     NonRecordingSpan,

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

@@ -19,7 +19,7 @@
     ResourceLogs,
     ScopeLogs,
 )
-from opentelemetry.sdk._logs import ReadableLogRecord
+from opentelemetry.sdk.logs import ReadableLogRecord
 
 
 def encode_logs(

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

@@ -12,9 +12,9 @@
     encode_metrics,
 )
 from opentelemetry.exporter.otlp.proto.common.trace_encoder import encode_spans
-from opentelemetry.sdk._logs import LoggerProvider
-from opentelemetry.sdk._logs.export import (
-    InMemoryLogExporter,
+from opentelemetry.sdk.logs import LoggerProvider
+from opentelemetry.sdk.logs.export import (
+    InMemoryLogRecordExporter,
     SimpleLogRecordProcessor,
 )
 from opentelemetry.sdk.metrics import MeterProvider
@@ -52,7 +52,7 @@ def test_encode_metrics(self):
         provider.shutdown()
 
     def test_encode_logs(self):
-        exporter = InMemoryLogExporter()
+        exporter = InMemoryLogRecordExporter()
         provider = LoggerProvider(resource=self.resource, shutdown_on_exit=False)
         provider.add_log_record_processor(SimpleLogRecordProcessor(exporter))
         provider.get_logger(__name__).emit(body="body")

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

@@ -27,7 +27,7 @@
 from opentelemetry.proto.resource.v1.resource_pb2 import (
     Resource as PB2Resource,
 )
-from opentelemetry.sdk._logs import LogRecordLimits, 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 (

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

@@ -20,11 +20,6 @@
 from opentelemetry.proto.collector.logs.v1.logs_service_pb2_grpc import (
     LogsServiceStub,
 )
-from opentelemetry.sdk._logs import ReadableLogRecord
-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,
@@ -36,6 +31,11 @@
     OTEL_EXPORTER_OTLP_LOGS_INSECURE,
     OTEL_EXPORTER_OTLP_LOGS_TIMEOUT,
 )
+from opentelemetry.sdk.logs import ReadableLogRecord
+from opentelemetry.sdk.logs.export import (
+    LogRecordExporter,
+    LogRecordExportResult,
+)
 from opentelemetry.semconv._incubating.attributes.otel_attributes import (
     OtelComponentTypeValues,
 )

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

@@ -78,8 +78,6 @@
     KeyValue,
 )
 from opentelemetry.proto.resource.v1.resource_pb2 import Resource  # noqa: F401
-from opentelemetry.sdk._logs import ReadableLogRecord
-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,
@@ -94,6 +92,8 @@
     OTEL_EXPORTER_OTLP_TIMEOUT,
     OTEL_PYTHON_SDK_INTERNAL_METRICS_ENABLED,
 )
+from opentelemetry.sdk.logs import ReadableLogRecord
+from opentelemetry.sdk.logs.export import LogRecordExportResult
 from opentelemetry.sdk.metrics.export import MetricExportResult, MetricsData
 from opentelemetry.sdk.resources import Resource as SDKResource
 from opentelemetry.sdk.trace import ReadableSpan

exporter/opentelemetry-exporter-otlp-proto-grpc/tests/logs/test_otlp_logs_exporter.py

@@ -28,7 +28,6 @@
 from opentelemetry.proto.resource.v1.resource_pb2 import (
     Resource as OTLPResource,
 )
-from opentelemetry.sdk._logs import ReadWriteLogRecord
 from opentelemetry.sdk.environment_variables import (
     OTEL_EXPORTER_OTLP_LOGS_CERTIFICATE,
     OTEL_EXPORTER_OTLP_LOGS_CLIENT_CERTIFICATE,
@@ -38,6 +37,7 @@
     OTEL_EXPORTER_OTLP_LOGS_HEADERS,
     OTEL_EXPORTER_OTLP_LOGS_TIMEOUT,
 )
+from opentelemetry.sdk.logs import ReadWriteLogRecord
 from opentelemetry.sdk.resources import Resource as SDKResource
 from opentelemetry.sdk.util.instrumentation import InstrumentationScope
 from opentelemetry.trace import (

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

@@ -27,11 +27,6 @@
     _resolve_timeout,
 )
 from opentelemetry.metrics import MeterProvider
-from opentelemetry.sdk._logs import ReadableLogRecord
-from opentelemetry.sdk._logs.export import (
-    LogRecordExporter,
-    LogRecordExportResult,
-)
 from opentelemetry.sdk._shared_internal import DuplicateFilter
 from opentelemetry.sdk.environment_variables import (
     _OTEL_PYTHON_EXPORTER_OTLP_HTTP_LOGS_CREDENTIAL_PROVIDER,
@@ -44,6 +39,11 @@
     OTEL_EXPORTER_OTLP_LOGS_TIMEOUT,
     OTEL_PYTHON_SDK_INTERNAL_METRICS_ENABLED,
 )
+from opentelemetry.sdk.logs import ReadableLogRecord
+from opentelemetry.sdk.logs.export import (
+    LogRecordExporter,
+    LogRecordExportResult,
+)
 from opentelemetry.semconv._incubating.attributes.otel_attributes import (
     OtelComponentTypeValues,
 )

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

@@ -39,8 +39,6 @@
 from opentelemetry.proto.collector.logs.v1.logs_service_pb2 import (
     ExportLogsServiceRequest,
 )
-from opentelemetry.sdk._logs import ReadWriteLogRecord
-from opentelemetry.sdk._logs.export import LogRecordExportResult
 from opentelemetry.sdk.environment_variables import (
     _OTEL_PYTHON_EXPORTER_OTLP_HTTP_LOGS_CREDENTIAL_PROVIDER,
     OTEL_EXPORTER_OTLP_COMPRESSION,
@@ -56,6 +54,8 @@
     OTEL_EXPORTER_OTLP_TIMEOUT,
     OTEL_PYTHON_SDK_INTERNAL_METRICS_ENABLED,
 )
+from opentelemetry.sdk.logs import ReadWriteLogRecord
+from opentelemetry.sdk.logs.export import LogRecordExportResult
 from opentelemetry.sdk.metrics import MeterProvider
 from opentelemetry.sdk.metrics.export import InMemoryMetricReader
 from opentelemetry.sdk.resources import Resource as SDKResource

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

@@ -470,7 +470,7 @@ def get_logger(
     """Returns a `Logger` for use within a python process.
 
     This function is a convenience wrapper for
-    opentelemetry.sdk._logs.LoggerProvider.get_logger.
+    opentelemetry.sdk.logs.LoggerProvider.get_logger.
 
     If logger_provider param is omitted the current configured one is used.
     """