Commit changes

Author: DylanRussell

dev-requirements.txt

@@ -18,3 +18,4 @@ GitPython==3.1.41
 pre-commit==3.7.0; python_version >= '3.9'
 pre-commit==3.5.0; python_version < '3.9'
 ruff==0.6.9
+grpcio==1.66.2

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

@@ -25,10 +25,18 @@
 import os
 from abc import ABC, abstractmethod
 from os import environ
-from typing import Any, Callable, Mapping, Optional, Sequence, Type, Union
+from typing import (
+    Any,
+    Callable,
+    Mapping,
+    MutableMapping,
+    Optional,
+    Sequence,
+    Type,
+    TypeVar,
+    Union,
+)
 
-from grpc import ChannelCredentials  # pylint: disable=import-error
-from requests import Session
 from typing_extensions import Literal
 
 from opentelemetry._events import set_event_logger_provider
@@ -71,6 +79,22 @@
 from opentelemetry.trace import set_tracer_provider
 from opentelemetry.util._importlib_metadata import entry_points
 
+try:
+    from grpc import ChannelCredentials
+
+    _GRPC_IMPORTED = True
+except ImportError:
+    _GRPC_IMPORTED = False
+
+try:
+    from requests import Session
+
+    _REQUESTS_IMPORTED = True
+except ImportError:
+    _REQUESTS_IMPORTED = False
+
+T = TypeVar("T")
+
 _EXPORTER_OTLP = "otlp"
 _EXPORTER_OTLP_PROTO_GRPC = "otlp_proto_grpc"
 _EXPORTER_OTLP_PROTO_HTTP = "otlp_proto_http"
@@ -112,30 +136,32 @@
         Type[MetricReader],
         Type[LogExporter],
     ],
-    Mapping[str, Any],
+    MutableMapping[str, Any],
 ]
 
 
 def _load_credential_from_envvar(
     environment_variable: str,
 ) -> Optional[
     tuple[
-        Literal["credentials", "session"], Union[ChannelCredentials, Session]
+        Literal["credentials", "session"],
+        Union["ChannelCredentials", "Session"],
     ]
 ]:
     credential_env = os.getenv(environment_variable)
     if credential_env:
         credentials = _import_config_component(
             credential_env, "opentelemetry_otlp_credential_provider"
         )()
-        if isinstance(credentials, ChannelCredentials):
+        if _GRPC_IMPORTED and isinstance(credentials, ChannelCredentials):
             return ("credentials", credentials)
-        elif isinstance(credentials, Session):
+
+        if _REQUESTS_IMPORTED and isinstance(credentials, Session):
             return ("session", credentials)
-        else:
-            raise RuntimeError(
-                f"{credential_env} is neither a grpc.ChannelCredentials or requests.Session type."
-            )
+        raise RuntimeError(
+            f"{credential_env} is neither a grpc.ChannelCredentials or requests.Session type."
+        )
+    return None
 
 
 def _import_config_component(
@@ -247,17 +273,15 @@ def _get_exporter_names(
 
 def _init_exporter(
     signal_type: Literal["traces", "metrics", "logs"],
-    exporter_args: Mapping[str, Any],
-    exporter_class: Union[
-        Type[SpanExporter], Type[MetricExporter], Type[LogExporter]
-    ],
+    exporter_args: MutableMapping[str, Any],
+    exporter_class: Type[T],
     otlp_credential_param_for_all_signal_types: Optional[
         tuple[
             Literal["credentials", "session"],
-            Union[ChannelCredentials, Session],
+            Union["ChannelCredentials", "Session"],
         ]
     ] = None,
-) -> Union[SpanExporter, MetricExporter, LogExporter]:
+) -> T:
     # Per signal type envvar should take precedence over all signal type env var.
     otlp_credential_param = (
         _load_credential_from_envvar(
@@ -273,6 +297,7 @@ def _init_exporter(
         ).parameters and (
             "opentelemetry.exporter.otlp.proto.http" in str(exporter_class)
             or "opentelemetry.exporter.otlp.proto.grpc" in str(exporter_class)
+            or "tests.test_configurator" in str(exporter_class)
         ):
             exporter_args[credential_key] = credential
     return exporter_class(**exporter_args)
@@ -285,7 +310,10 @@ def _init_tracing(
     resource: Resource | None = None,
     exporter_args_map: ExporterArgsMap | None = None,
     otlp_credential_param: Optional[
-        tuple[str, Union[ChannelCredentials, Session]]
+        tuple[
+            Literal["credentials", "session"],
+            Union["ChannelCredentials", "Session"],
+        ]
     ] = None,
 ):
     provider = TracerProvider(
@@ -314,10 +342,13 @@ def _init_metrics(
     exporters_or_readers: dict[
         str, Union[Type[MetricExporter], Type[MetricReader]]
     ],
-    resource: Resource = None,
+    resource: Resource | None = None,
     exporter_args_map: ExporterArgsMap | None = None,
     otlp_credential_param: Optional[
-        tuple[str, Union[ChannelCredentials, Session]]
+        tuple[
+            Literal["credentials", "session"],
+            Union["ChannelCredentials", "Session"],
+        ]
     ] = None,
 ):
     metric_readers = []
@@ -349,7 +380,10 @@ def _init_logging(
     setup_logging_handler: bool = True,
     exporter_args_map: ExporterArgsMap | None = None,
     otlp_credential_param: Optional[
-        tuple[str, Union[ChannelCredentials, Session]]
+        tuple[
+            Literal["credentials", "session"],
+            Union["ChannelCredentials", "Session"],
+        ]
     ] = None,
 ):
     provider = LoggerProvider(resource=resource)
@@ -510,7 +544,7 @@ def _import_id_generator(id_generator_name: str) -> IdGenerator:
     raise RuntimeError(f"{id_generator_name} is not an IdGenerator")
 
 
-def _initialize_components(
+def _initialize_components(  # pylint: disable=too-many-locals
     auto_instrumentation_version: str | None = None,
     trace_exporter_names: list[str] | None = None,
     metric_exporter_names: list[str] | None = None,

opentelemetry-sdk/tests/test_configurator.py

@@ -435,13 +435,15 @@ def test_trace_init_custom_id_generator(self, mock_entry_points):
     )
     @patch("opentelemetry.sdk._configuration.entry_points")
     def test_that_session_gets_passed_to_exporter(self, mock_entry_points):
-        # Should not be used, trace specific version should override.
-        session_for_all_signals = Session()
+        # Should not be used, metric specific version should override.
         session_for_metrics_only = Session()
+        session_for_all_signals = Session()
+
+        def f():
+            return session_for_metrics_only
+
         mock_entry_points.configure_mock(
-            return_value=[
-                IterEntryPoint("custom_session", session_for_metrics_only)
-            ]
+            return_value=[IterEntryPoint("custom_session", f)]
         )
         exporter = _init_exporter(
             "metrics",
@@ -464,20 +466,22 @@ def test_that_session_gets_passed_to_exporter(self, mock_entry_points):
     @patch("opentelemetry.sdk._configuration.entry_points")
     def test_that_credential_gets_passed_to_exporter(self, mock_entry_points):
         # Should not be used, trace specific version should override.
+        credential_for_traces_only = ChannelCredentials(None)
         credential_for_all_signals = ChannelCredentials(None)
-        credential_for_trace_only = ChannelCredentials(None)
+
+        def f():
+            return credential_for_traces_only
+
         mock_entry_points.configure_mock(
-            return_value=[
-                IterEntryPoint("custom_credential", credential_for_trace_only)
-            ]
+            return_value=[IterEntryPoint("custom_credential", f)]
         )
         exporter = _init_exporter(
             "traces",
             {},
             OTLPSpanExporter,
             otlp_credential_param_for_all_signal_types=credential_for_all_signals,
         )
-        assert exporter.credentials is credential_for_trace_only
+        assert exporter.credentials is credential_for_traces_only
         assert exporter.credentials is not credential_for_all_signals
 
     @patch.dict(

tox.ini

@@ -342,11 +342,14 @@ deps =
   -c {toxinidir}/dev-requirements.txt
   pyright
   psutil
+  requests
+  grpcio
   -e {toxinidir}/opentelemetry-api
   -e {toxinidir}/opentelemetry-semantic-conventions
   -e {toxinidir}/opentelemetry-sdk
   -e {toxinidir}/tests/opentelemetry-test-utils
 commands =
+  pip freeze
   pyright --version
   pyright