clean up

Author: jeremydvoss

CHANGELOG.md

@@ -17,7 +17,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   ([#3567](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3567))
 - `opentelemetry-resource-detector-containerid`: make it more quiet on platforms without cgroups
   ([#3579](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3579))
-- `opentelemetry-instrumentation`: Fix dependency conflict detection when instrumented packages are not installed. Add "instruments_either" feature for instrumentations that target multiple packages.
+- `opentelemetry-instrumentation`: Fix dependency conflict detection when instrumented packages are not installed by moving check back to before instrumentors are loaded. Add "instruments_either" feature for instrumentations that target multiple packages.
   ([#3610](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3610))
 
 ### Added

instrumentation/opentelemetry-instrumentation-psycopg2/tests/test_psycopg2_instrumentation.py

@@ -146,7 +146,6 @@ def _instrumentation_loaded_successfully_call():
             return call("Instrumented %s", "psycopg2")
 
         mock_distro = Mock()
-        # TODO: This test previously did nothing. By mocking the distro, it blocked any possibility of a dependency conflict. Mocking no dependency conflict for no. But, in the future, update this package toml with the instruemnts_either field. See https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3610
         mock_dep.return_value = None
         mock_distro.load_instrumentor.return_value = None
         _load_instrumentors(mock_distro)

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

@@ -115,7 +115,10 @@ def _load_instrumentors(distro):
             distro.load_instrumentor(entry_point, skip_dep_check=True)
             _logger.debug("Instrumented %s", entry_point.name)
         except DependencyConflictError as exc:
-            # DependencyConflicts will generally arise without exception from the get_dist_dependency_conflicts call before instrumentation is attempted. Keeping this exception in case of custom distro and instrumentor behavior. See https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3610 for details.
+            # Dependency conflicts are generally caught from get_dist_dependency_conflicts
+            # returning a DependencyConflict. Keeping this error handling in case custom
+            # distro and instrumentor behavior raises a DependencyConflictError later.
+            # See https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3610
             _logger.debug(
                 "Skipping instrumentation %s: %s",
                 entry_point.name,
@@ -142,7 +145,6 @@ def _load_instrumentors(distro):
             )
             continue
         except Exception as exc:  # pylint: disable=broad-except
-            # print("Skipping instrumentation %s: %s" % (entry_point.name, exc))
             _logger.exception("Instrumenting of %s failed", entry_point.name)
             raise exc
 

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

@@ -29,11 +29,27 @@
 
 
 class DependencyConflict:
+    """Represents a dependency conflict in OpenTelemetry instrumentation.
+
+    This class is used to track conflicts between required dependencies and the
+    actual installed packages. It supports two scenarios:
+
+    1. Standard conflicts where all dependencies are required
+    2. Either/or conflicts where only one of a set of dependencies is required
+
+    Attributes:
+        required: The required dependency specification that conflicts with what's installed.
+        found: The actual dependency that was found installed (if any).
+        required_either: Collection of dependency specifications where any one would satisfy
+            the requirement (for either/or scenarios).
+        found_either: Collection of actual dependencies found for either/or scenarios.
+    """
+
     required: str | None = None
     found: str | None = None
     # The following fields are used when an instrumentation requires any of a set of dependencies rather than all.
-    required_either: Collection[str] = []
-    found_either: Collection[str] = []
+    required_either: Collection[str] = None
+    found_either: Collection[str] = None
 
     def __init__(
         self,

opentelemetry-instrumentation/tests/auto_instrumentation/test_load.py

@@ -386,13 +386,10 @@ def test_load_instrumentors_import_error_does_not_stop_everything(
     @patch(
         "opentelemetry.instrumentation.auto_instrumentation._load.get_dist_dependency_conflicts"
     )
-    @patch("opentelemetry.instrumentation.auto_instrumentation._load._logger")
     @patch(
         "opentelemetry.instrumentation.auto_instrumentation._load.entry_points"
     )
-    def test_load_instrumentors_raises_exception(
-        self, iter_mock, mock_logger, mock_dep
-    ):
+    def test_load_instrumentors_raises_exception(self, iter_mock, mock_dep):
         ep_mock1 = Mock(name="instr1")
         ep_mock2 = Mock(name="instr2")