Make opentelemetry.environment_variables a single namespace

Fixes #1968

Author: ocelotl

CHANGELOG.md

@@ -5,6 +5,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased](https://github.com/open-telemetry/opentelemetry-python/compare/v1.4.0-0.23b0...HEAD)
+- Automatically load OTEL environment variables as options for `opentelemetry-instrument`
+  ([#1969](https://github.com/open-telemetry/opentelemetry-python/pull/1969))
 - Fix documentation on well known exporters and variable OTEL_TRACES_EXPORTER which were misnamed
   ([#2023](https://github.com/open-telemetry/opentelemetry-python/pull/2023))
 - `opentelemetry-sdk` `get_aggregated_resource()` returns default resource and service name

opentelemetry-api/setup.cfg

@@ -56,6 +56,8 @@ opentelemetry_tracer_provider =
 opentelemetry_propagator =
     tracecontext = opentelemetry.trace.propagation.tracecontext:TraceContextTextMapPropagator
     baggage = opentelemetry.baggage.propagation:W3CBaggagePropagator
+opentelemetry_environment_variables =
+    api = opentelemetry.environment_variables.environment_variables
 
 [options.extras_require]
 test =

opentelemetry-api/src/opentelemetry/context/__init__.py

@@ -11,6 +11,7 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
+# pylint: disable=no-name-in-module
 
 import logging
 import threading
@@ -22,7 +23,9 @@
 from pkg_resources import iter_entry_points
 
 from opentelemetry.context.context import Context, _RuntimeContext
-from opentelemetry.environment_variables import OTEL_PYTHON_CONTEXT
+from opentelemetry.environment_variables import (  # type: ignore
+    OTEL_PYTHON_CONTEXT,
+)
 
 logger = logging.getLogger(__name__)
 _RUNTIME_CONTEXT = None  # type: typing.Optional[_RuntimeContext]
@@ -52,7 +55,7 @@ def wrapper(  # type: ignore[misc]
                 default_context = "contextvars_context"
 
                 configured_context = environ.get(
-                    OTEL_PYTHON_CONTEXT, default_context
+                    OTEL_PYTHON_CONTEXT, default_context  # type: ignore
                 )  # type: str
                 try:
                     _RUNTIME_CONTEXT = next(

opentelemetry-api/src/opentelemetry/environment_variables/__init__.py

@@ -11,33 +11,44 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
+# type: ignore
 
-OTEL_PROPAGATORS = "OTEL_PROPAGATORS"
-"""
-.. envvar:: OTEL_PROPAGATORS
-"""
-
-OTEL_PYTHON_CONTEXT = "OTEL_PYTHON_CONTEXT"
-"""
-.. envvar:: OTEL_PYTHON_CONTEXT
-"""
-
-OTEL_PYTHON_DISABLED_INSTRUMENTATIONS = "OTEL_PYTHON_DISABLED_INSTRUMENTATIONS"
-"""
-.. envvar:: OTEL_PYTHON_DISABLED_INSTRUMENTATIONS
-"""
-
-OTEL_PYTHON_ID_GENERATOR = "OTEL_PYTHON_ID_GENERATOR"
-"""
-.. envvar:: OTEL_PYTHON_ID_GENERATOR
-"""
-
-OTEL_TRACES_EXPORTER = "OTEL_TRACES_EXPORTER"
-"""
-.. envvar:: OTEL_TRACES_EXPORTER
-"""
-
-OTEL_PYTHON_TRACER_PROVIDER = "OTEL_PYTHON_TRACER_PROVIDER"
-"""
-.. envvar:: OTEL_PYTHON_TRACER_PROVIDER
-"""
+from logging import getLogger
+from sys import modules
+
+from pkg_resources import iter_entry_points
+
+_logger = getLogger(__name__)
+
+_loaded = False
+
+_current_module = modules[__name__]
+_current_module_attributes = set(dir(_current_module))
+
+if not _loaded:
+    for entry_point in iter_entry_points(
+        "opentelemetry_environment_variables"
+    ):
+
+        other_module = entry_point.load()
+
+        for attribute in dir(other_module):
+
+            if attribute.startswith("OTEL_"):
+
+                value = getattr(other_module, attribute)
+
+                if attribute in _current_module_attributes:
+                    # pylint: disable=logging-not-lazy
+                    # pylint: disable=logging-format-interpolation
+                    _logger.warning(
+                        "Overriding value of {} with {}".format(
+                            attribute, value
+                        )
+                    )
+
+                setattr(_current_module, attribute, value)
+
+                _current_module_attributes.add(attribute)
+
+_loaded = True

opentelemetry-api/src/opentelemetry/environment_variables/environment_variables.py

@@ -0,0 +1,38 @@
+# Copyright The OpenTelemetry Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+OTEL_PROPAGATORS = "OTEL_PROPAGATORS"
+"""
+.. envvar:: OTEL_PROPAGATORS
+"""
+
+OTEL_PYTHON_CONTEXT = "OTEL_PYTHON_CONTEXT"
+"""
+.. envvar:: OTEL_PYTHON_CONTEXT
+"""
+
+OTEL_PYTHON_ID_GENERATOR = "OTEL_PYTHON_ID_GENERATOR"
+"""
+.. envvar:: OTEL_PYTHON_ID_GENERATOR
+"""
+
+OTEL_TRACES_EXPORTER = "OTEL_TRACES_EXPORTER"
+"""
+.. envvar:: OTEL_TRACES_EXPORTER
+"""
+
+OTEL_PYTHON_TRACER_PROVIDER = "OTEL_PYTHON_TRACER_PROVIDER"
+"""
+.. envvar:: OTEL_PYTHON_TRACER_PROVIDER
+"""

opentelemetry-api/src/opentelemetry/propagate/__init__.py

@@ -11,6 +11,7 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
+# pylint: disable=no-name-in-module
 
 """
 API for propagation of context.
@@ -75,7 +76,9 @@ def example_route():
 from pkg_resources import iter_entry_points
 
 from opentelemetry.context.context import Context
-from opentelemetry.environment_variables import OTEL_PROPAGATORS
+from opentelemetry.environment_variables import (  # type: ignore
+    OTEL_PROPAGATORS,
+)
 from opentelemetry.propagators import composite, textmap
 
 logger = getLogger(__name__)
@@ -127,7 +130,7 @@ def inject(
 
     # Single use variable here to hack black and make lint pass
     environ_propagators = environ.get(
-        OTEL_PROPAGATORS,
+        OTEL_PROPAGATORS,  # type: ignore
         "tracecontext,baggage",
     )
 

opentelemetry-api/src/opentelemetry/trace/__init__.py

@@ -11,6 +11,7 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
+# pylint: disable=no-name-in-module
 
 """
 The OpenTelemetry tracing API describes the classes used to generate
@@ -84,7 +85,9 @@
 from opentelemetry import context as context_api
 from opentelemetry.attributes import BoundedAttributes  # type: ignore
 from opentelemetry.context.context import Context
-from opentelemetry.environment_variables import OTEL_PYTHON_TRACER_PROVIDER
+from opentelemetry.environment_variables import (  # type: ignore
+    OTEL_PYTHON_TRACER_PROVIDER,
+)
 from opentelemetry.trace.propagation import (
     _SPAN_KEY,
     get_current_span,
@@ -486,14 +489,14 @@ def get_tracer_provider() -> TracerProvider:
     if _TRACER_PROVIDER is None:
         # if a global tracer provider has not been set either via code or env
         # vars, return a proxy tracer provider
-        if OTEL_PYTHON_TRACER_PROVIDER not in os.environ:
+        if OTEL_PYTHON_TRACER_PROVIDER not in os.environ:  # type: ignore
             if not _PROXY_TRACER_PROVIDER:
                 _PROXY_TRACER_PROVIDER = ProxyTracerProvider()
             return _PROXY_TRACER_PROVIDER
 
         _TRACER_PROVIDER = cast(  # type: ignore
             "TracerProvider",
-            _load_provider(OTEL_PYTHON_TRACER_PROVIDER, "tracer_provider"),
+            _load_provider(OTEL_PYTHON_TRACER_PROVIDER, "tracer_provider"),  # type: ignore
         )
     return _TRACER_PROVIDER
 

opentelemetry-distro/src/opentelemetry/distro/__init__.py

@@ -11,7 +11,8 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
-#
+# pylint: disable=no-name-in-module
+
 import os
 
 from opentelemetry.environment_variables import OTEL_TRACES_EXPORTER

opentelemetry-distro/tests/test_distro.py

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 # type: ignore
+# pylint: disable=no-name-in-module
 
 import os
 from unittest import TestCase

opentelemetry-instrumentation/setup.cfg

@@ -51,6 +51,8 @@ where = src
 console_scripts =
     opentelemetry-instrument = opentelemetry.instrumentation.auto_instrumentation:run
     opentelemetry-bootstrap = opentelemetry.instrumentation.bootstrap:run
+opentelemetry_environment_variables =
+    instrumentation = opentelemetry.instrumentation.environment_variables
 
 [options.extras_require]
 test =

opentelemetry-instrumentation/src/opentelemetry/instrumentation/auto_instrumentation/__init__.py

@@ -13,6 +13,7 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
+# pylint: disable=no-name-in-module
 
 import argparse
 from logging import getLogger

opentelemetry-instrumentation/src/opentelemetry/instrumentation/auto_instrumentation/sitecustomize.py

@@ -11,6 +11,7 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
+# pylint: disable=no-name-in-module
 
 import sys
 from logging import getLogger

opentelemetry-instrumentation/src/opentelemetry/instrumentation/environment_variables.py

@@ -0,0 +1,18 @@
+# Copyright The OpenTelemetry Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+OTEL_PYTHON_DISABLED_INSTRUMENTATIONS = "OTEL_PYTHON_DISABLED_INSTRUMENTATIONS"
+"""
+.. envvar:: OTEL_PYTHON_DISABLED_INSTRUMENTATIONS
+"""

opentelemetry-instrumentation/tests/test_distro.py

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 # type: ignore
+# pylint: disable=no-name-in-module
 
 from unittest import TestCase
 

opentelemetry-instrumentation/tests/test_run.py

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 # type: ignore
+# pylint: disable=no-name-in-module
 
 from os import environ, getcwd
 from os.path import abspath, dirname, pathsep

opentelemetry-sdk/setup.cfg

@@ -56,6 +56,8 @@ opentelemetry_exporter =
     console_span = opentelemetry.sdk.trace.export:ConsoleSpanExporter
 opentelemetry_id_generator =
     random = opentelemetry.sdk.trace.id_generator:RandomIdGenerator
+opentelemetry_environment_variables =
+    sdk = opentelemetry.sdk.environment_variables
 
 [options.extras_require]
 test =

opentelemetry-sdk/src/opentelemetry/sdk/environment_variables/__init__.py renamed to opentelemetry-sdk/src/opentelemetry/sdk/environment_variables.py

@@ -11,6 +11,7 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
+# pylint: disable=no-name-in-module
 
 from os import environ
 

opentelemetry-sdk/tests/conftest.py

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 # type: ignore
+# pylint: disable=no-name-in-module
 
 from os import environ
 from unittest import TestCase