Add a DependencyConflictError Exception To Allow For Instrumentation To Stop When Dependcies Are Not Installed

Author: rjduffner

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

@@ -18,6 +18,7 @@
 
 from opentelemetry.instrumentation.dependencies import (
     get_dist_dependency_conflicts,
+    DependencyConflictError
 )
 from opentelemetry.instrumentation.distro import BaseDistro, DefaultDistro
 from opentelemetry.instrumentation.environment_variables import (
@@ -100,19 +101,15 @@ def _load_instrumentors(distro):
             continue
 
         try:
-            entry_point_dist = entry_point_finder.dist_for(entry_point)
-            conflict = get_dist_dependency_conflicts(entry_point_dist)
-            if conflict:
-                _logger.debug(
-                    "Skipping instrumentation %s: %s",
-                    entry_point.name,
-                    conflict,
-                )
-                continue
-
-            # tell instrumentation to not run dep checks again as we already did it above
-            distro.load_instrumentor(entry_point, skip_dep_check=True)
+            distro.load_instrumentor(entry_point)
             _logger.debug("Instrumented %s", entry_point.name)
+        except DependencyConflictError as exc:
+            _logger.debug(
+                "Skipping instrumentation %s: %s",
+                entry_point.name,
+                exc.conflict,
+            )
+            continue
         except ImportError:
             # in scenarios using the kubernetes operator to do autoinstrumentation some
             # instrumentors (usually requiring binary extensions) may fail to load

opentelemetry-instrumentation/src/opentelemetry/instrumentation/dependencies.py

@@ -38,6 +38,13 @@ def __init__(self, required: str | None, found: str | None = None):
 
     def __str__(self):
         return f'DependencyConflict: requested: "{self.required}" but found: "{self.found}"'
+    
+class DependencyConflictError(Exception):
+    def __init__(self, conflict: DependencyConflict):
+        self.conflict = conflict
+
+    def __str__(self):
+        return str(self.conflict)
 
 
 def get_dist_dependency_conflicts(

opentelemetry-instrumentation/src/opentelemetry/instrumentation/instrumentor.py

@@ -28,6 +28,7 @@
 )
 from opentelemetry.instrumentation.dependencies import (
     DependencyConflict,
+    DependencyConflictError,
     get_dependency_conflicts,
 )
 
@@ -108,7 +109,7 @@ def instrument(self, **kwargs: Any):
             conflict = self._check_dependency_conflicts()
             if conflict:
                 _LOG.error(conflict)
-                return None
+                raise DependencyConflictError(conflict)
 
         # initialize semantic conventions opt-in if needed
         _OpenTelemetrySemanticConventionStability._initialize()