move log_exporter to _log_exporter as it's still experimental (#2252)

Author: Alex Boten

docs/examples/logs/example.py

@@ -1,7 +1,9 @@
 import logging
 
 from opentelemetry import trace
-from opentelemetry.exporter.otlp.proto.grpc.log_exporter import OTLPLogExporter
+from opentelemetry.exporter.otlp.proto.grpc._log_exporter import (
+    OTLPLogExporter,
+)
 from opentelemetry.sdk._logs import (
     LogEmitterProvider,
     OTLPHandler,

docs/sdk/logs.rst

@@ -1,6 +1,13 @@
 opentelemetry.sdk._logs package
 ===============================
 
+.. 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 compatability guarantees at this time.
+
+   Once logs become stable, this package will be be renamed to ``opentelemetry.sdk.logs``.
+
 Submodules
 ----------
 

…otlp/proto/grpc/log_exporter/__init__.py …tlp/proto/grpc/_log_exporter/__init__.pyexporter/opentelemetry-exporter-otlp-proto-grpc/src/opentelemetry/exporter/otlp/proto/grpc/log_exporter/__init__.py renamed to exporter/opentelemetry-exporter-otlp-proto-grpc/src/opentelemetry/exporter/otlp/proto/grpc/_log_exporter/__init__.py exporter/opentelemetry-exporter-otlp-proto-grpc/src/opentelemetry/exporter/otlp/proto/grpc/log_exporter/__init__.py renamed to exporter/opentelemetry-exporter-otlp-proto-grpc/src/opentelemetry/exporter/otlp/proto/grpc/_log_exporter/__init__.py

@@ -21,8 +21,10 @@
 from google.rpc.error_details_pb2 import RetryInfo
 from grpc import StatusCode, server
 
+from opentelemetry.exporter.otlp.proto.grpc._log_exporter import (
+    OTLPLogExporter,
+)
 from opentelemetry.exporter.otlp.proto.grpc.exporter import _translate_value
-from opentelemetry.exporter.otlp.proto.grpc.log_exporter import OTLPLogExporter
 from opentelemetry.proto.collector.logs.v1.logs_service_pb2 import (
     ExportLogsServiceRequest,
     ExportLogsServiceResponse,
@@ -168,7 +170,7 @@ def tearDown(self):
     )
     @patch("opentelemetry.exporter.otlp.proto.grpc.exporter.secure_channel")
     @patch(
-        "opentelemetry.exporter.otlp.proto.grpc.log_exporter.OTLPLogExporter._stub"
+        "opentelemetry.exporter.otlp.proto.grpc._log_exporter.OTLPLogExporter._stub"
     )
     # pylint: disable=unused-argument
     def test_no_credentials_error(

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

@@ -23,7 +23,7 @@
 
 from opentelemetry.sdk._logs.severity import SeverityNumber, std_to_otlp
 from opentelemetry.sdk.environment_variables import (
-    OTEL_PYTHON_LOG_EMITTER_PROVIDER,
+    _OTEL_PYTHON_LOG_EMITTER_PROVIDER,
 )
 from opentelemetry.sdk.resources import Resource
 from opentelemetry.sdk.util import ns_to_iso_str
@@ -450,14 +450,14 @@ def get_log_emitter_provider() -> LogEmitterProvider:
     """Gets the current global :class:`~.LogEmitterProvider` object."""
     global _LOG_EMITTER_PROVIDER  # pylint: disable=global-statement
     if _LOG_EMITTER_PROVIDER is None:
-        if OTEL_PYTHON_LOG_EMITTER_PROVIDER not in os.environ:
+        if _OTEL_PYTHON_LOG_EMITTER_PROVIDER not in os.environ:
             _LOG_EMITTER_PROVIDER = LogEmitterProvider()
             return _LOG_EMITTER_PROVIDER
 
         _LOG_EMITTER_PROVIDER = cast(
             "LogEmitterProvider",
             _load_provider(
-                OTEL_PYTHON_LOG_EMITTER_PROVIDER, "log_emitter_provider"
+                _OTEL_PYTHON_LOG_EMITTER_PROVIDER, "log_emitter_provider"
             ),
         )
 

opentelemetry-sdk/src/opentelemetry/sdk/_logs/__init__.py

@@ -370,7 +370,7 @@
 If both are set, :envvar:`OTEL_SERVICE_NAME` takes precedence.
 """
 
-OTEL_PYTHON_LOG_EMITTER_PROVIDER = "OTEL_PYTHON_LOG_EMITTER_PROVIDER"
+_OTEL_PYTHON_LOG_EMITTER_PROVIDER = "OTEL_PYTHON_LOG_EMITTER_PROVIDER"
 """
 .. envvar:: OTEL_PYTHON_LOG_EMITTER_PROVIDER
 

opentelemetry-sdk/src/opentelemetry/sdk/environment_variables.py

@@ -25,7 +25,7 @@
     set_log_emitter_provider,
 )
 from opentelemetry.sdk.environment_variables import (
-    OTEL_PYTHON_LOG_EMITTER_PROVIDER,
+    _OTEL_PYTHON_LOG_EMITTER_PROVIDER,
 )
 
 
@@ -62,13 +62,13 @@ def test_tracer_provider_override_warning(self):
 
     @patch.dict(
         "os.environ",
-        {OTEL_PYTHON_LOG_EMITTER_PROVIDER: "sdk_log_emitter_provider"},
+        {_OTEL_PYTHON_LOG_EMITTER_PROVIDER: "sdk_log_emitter_provider"},
     )
     def test_sdk_log_emitter_provider(self):
         reload(_logs)
         self.check_override_not_allowed()
 
-    @patch.dict("os.environ", {OTEL_PYTHON_LOG_EMITTER_PROVIDER: "unknown"})
+    @patch.dict("os.environ", {_OTEL_PYTHON_LOG_EMITTER_PROVIDER: "unknown"})
     def test_unknown_log_emitter_provider(self):
         reload(_logs)
         with self.assertRaises(Exception):