Rename environment variable

open-telemetry · Feb 24, 2023 · 2cef304 · 2cef304
1 parent 24a92c1
commit 2cef304
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 9 deletions.
diff --git a/opentelemetry-sdk/src/opentelemetry/sdk/environment_variables.py b/opentelemetry-sdk/src/opentelemetry/sdk/environment_variables.py
@@ -634,11 +634,13 @@
 The :envvar:`OTEL_EXPORTER_OTLP_METRICS_CLIENT_CERTIFICATE` is the client certificate/chain trust for clients private key to use in mTLS communication in PEM format.
 """
 
-_OTEL_RESOURCE_DETECTORS = "_OTEL_RESOURCE_DETECTORS"
+OTEL_EXPERIMENTAL_RESOURCE_DETECTORS = "OTEL_EXPERIMENTALRESOURCE_DETECTORS"
 """
-.. envvar:: _OTEL_RESOURCE_DETECTORS
+.. envvar:: OTEL_EXPERIMENTAL_RESOURCE_DETECTORS
 
-The :envvar:`_OTEL_RESOURCE_DETECTORS` is a comma-separated string of names of
-resource detectors. These names must be the same as the names of entry points
-for the `opentelemetry-resource-detectors` entry point.
+The :envvar:`OTEL_EXPERIMENTAL_RESOURCE_DETECTORS` is a comma-separated string
+of names of resource detectors. These names must be the same as the names of
+entry points for the `opentelemetry-resource-detectors` entry point. This is an
+experimental feature and the name of this variable and its behavior can change
+in a non-backwards compatible way.
 """
diff --git a/opentelemetry-sdk/src/opentelemetry/sdk/resources/__init__.py b/opentelemetry-sdk/src/opentelemetry/sdk/resources/__init__.py
@@ -66,7 +66,7 @@
 
 from opentelemetry.attributes import BoundedAttributes
 from opentelemetry.sdk.environment_variables import (
-    _OTEL_RESOURCE_DETECTORS,
+    OTEL_EXPERIMENTAL_RESOURCE_DETECTORS,
     OTEL_RESOURCE_ATTRIBUTES,
     OTEL_SERVICE_NAME,
 )
@@ -170,7 +170,7 @@ def create(
         resource = _DEFAULT_RESOURCE
 
         for resource_detector in environ.get(
-            _OTEL_RESOURCE_DETECTORS, "otel"
+            OTEL_EXPERIMENTAL_RESOURCE_DETECTORS, "otel"
         ).split(","):
 
             resource = resource.merge(

diff --git a/opentelemetry-sdk/tests/resources/test_resources.py b/opentelemetry-sdk/tests/resources/test_resources.py
@@ -21,7 +21,9 @@
 from unittest.mock import Mock, patch
 from urllib import parse
 
-from opentelemetry.sdk.environment_variables import _OTEL_RESOURCE_DETECTORS
+from opentelemetry.sdk.environment_variables import (
+    OTEL_EXPERIMENTAL_RESOURCE_DETECTORS,
+)
 from opentelemetry.sdk.resources import (
     _DEFAULT_RESOURCE,
     _EMPTY_RESOURCE,
@@ -566,7 +568,9 @@ def test_resource_detector_entry_points_default(self):
         self.assertEqual(resource.attributes["c"], "d")
         self.assertEqual(resource.schema_url, "")
 
-    @patch.dict(environ, {_OTEL_RESOURCE_DETECTORS: "mock"}, clear=True)
+    @patch.dict(
+        environ, {OTEL_EXPERIMENTAL_RESOURCE_DETECTORS: "mock"}, clear=True
+    )
     @patch(
         "opentelemetry.sdk.resources.entry_points",
         Mock(