Merge branch 'main' into fix-3415

Author: emdneto

CHANGELOG.md

@@ -11,6 +11,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+### Added
+
+### Fixed
+
+- `opentelemetry-instrumentation` Catch `ModuleNotFoundError` when the library is not installed
+  and log as debug instead of exception
+  ([#3423](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3423))
+
 ## Version 1.32.0/0.53b0 (2025-04-10)
 
 ### Added

instrumentation/opentelemetry-instrumentation-aiohttp-client/test-requirements.txt

@@ -13,7 +13,7 @@ http_server_mock==1.7
 idna==3.7
 iniconfig==2.0.0
 itsdangerous==2.1.2
-Jinja2==3.1.4
+Jinja2==3.1.6
 MarkupSafe==2.1.5
 multidict==6.0.5
 packaging==24.0

instrumentation/opentelemetry-instrumentation-boto/test-requirements.txt

@@ -10,7 +10,7 @@ Deprecated==1.2.14
 docker==7.0.0
 idna==3.7
 iniconfig==2.0.0
-Jinja2==3.1.4
+Jinja2==3.1.6
 jmespath==1.0.1
 MarkupSafe==2.1.5
 moto==2.3.2

instrumentation/opentelemetry-instrumentation-botocore/test-requirements-0.txt

@@ -10,7 +10,7 @@ Deprecated==1.2.14
 docker==7.0.0
 idna==3.7
 iniconfig==2.0.0
-Jinja2==3.1.4
+Jinja2==3.1.6
 jmespath==1.0.1
 MarkupSafe==2.1.5
 moto==5.0.9

instrumentation/opentelemetry-instrumentation-botocore/test-requirements-1.txt

@@ -10,7 +10,7 @@ Deprecated==1.2.14
 docker==7.0.0
 idna==3.7
 iniconfig==2.0.0
-Jinja2==3.1.4
+Jinja2==3.1.6
 jmespath==1.0.1
 MarkupSafe==2.1.5
 moto==5.0.9

instrumentation/opentelemetry-instrumentation-click/test-requirements.txt

@@ -5,7 +5,7 @@ Deprecated==1.2.14
 Flask==3.0.2
 iniconfig==2.0.0
 itsdangerous==2.1.2
-Jinja2==3.1.4
+Jinja2==3.1.6
 MarkupSafe==2.1.2
 packaging==24.0
 pluggy==1.5.0

instrumentation/opentelemetry-instrumentation-flask/test-requirements-0.txt

@@ -4,7 +4,7 @@ Deprecated==1.2.14
 Flask==2.1.3
 iniconfig==2.0.0
 itsdangerous==2.1.2
-Jinja2==3.1.4
+Jinja2==3.1.6
 MarkupSafe==2.1.2
 packaging==24.0
 pluggy==1.5.0

instrumentation/opentelemetry-instrumentation-flask/test-requirements-1.txt

@@ -4,7 +4,7 @@ Deprecated==1.2.14
 Flask==2.2.0
 iniconfig==2.0.0
 itsdangerous==2.1.2
-Jinja2==3.1.4
+Jinja2==3.1.6
 MarkupSafe==2.1.2
 packaging==24.0
 pluggy==1.5.0

instrumentation/opentelemetry-instrumentation-flask/test-requirements-2.txt

@@ -5,7 +5,7 @@ Deprecated==1.2.14
 Flask==3.0.2
 iniconfig==2.0.0
 itsdangerous==2.1.2
-Jinja2==3.1.4
+Jinja2==3.1.6
 MarkupSafe==2.1.2
 packaging==24.0
 pluggy==1.5.0

instrumentation/opentelemetry-instrumentation-jinja2/test-requirements.txt

@@ -1,7 +1,7 @@
 asgiref==3.8.1
 Deprecated==1.2.14
 iniconfig==2.0.0
-Jinja2==3.1.4
+Jinja2==3.1.6
 MarkupSafe==2.0.1
 packaging==24.0
 pluggy==1.5.0

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

@@ -72,6 +72,8 @@ def get(self):
 
 .. code-block:: python
 
+    from opentelemetry.instrumentation.tornado import TornadoInstrumentor
+
     # will be called for each incoming request to Tornado
     # web server. `handler` is an instance of
     # `tornado.web.RequestHandler`.
@@ -94,7 +96,7 @@ def client_response_hook(span, future):
     TornadoInstrumentor().instrument(
         server_request_hook=server_request_hook,
         client_request_hook=client_request_hook,
-        client_response_hook=client_response_hook
+        client_response_hook=client_response_hook,
     )
 
 Capture HTTP request and response headers

instrumentation/opentelemetry-instrumentation-tornado/test-requirements.txt

@@ -9,7 +9,7 @@ http_server_mock==1.7
 idna==3.7
 iniconfig==2.0.0
 itsdangerous==2.1.2
-Jinja2==3.1.4
+Jinja2==3.1.6
 MarkupSafe==2.1.5
 packaging==24.0
 pluggy==1.5.0

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

@@ -82,6 +82,14 @@ def _load_instrumentors(distro):
                 exc.conflict,
             )
             continue
+        except ModuleNotFoundError as exc:
+            # ModuleNotFoundError is raised when the library is not installed
+            # and the instrumentation is not required to be loaded.
+            # See https://github.com/open-telemetry/opentelemetry-python-contrib/issues/3421
+            _logger.debug(
+                "Skipping instrumentation %s: %s", entry_point.name, exc.msg
+            )
+            continue
         except ImportError:
             # in scenarios using the kubernetes operator to do autoinstrumentation some
             # instrumentors (usually requiring binary extensions) may fail to load

opentelemetry-instrumentation/tests/auto_instrumentation/test_load.py

@@ -326,11 +326,12 @@ def test_load_instrumentors_dep_conflict(self, iter_mock, mock_logger):  # pylin
             ]
         )
 
+    @patch("opentelemetry.instrumentation.auto_instrumentation._load._logger")
     @patch(
         "opentelemetry.instrumentation.auto_instrumentation._load.entry_points"
     )
     def test_load_instrumentors_import_error_does_not_stop_everything(
-        self, iter_mock
+        self, iter_mock, mock_logger
     ):
         ep_mock1 = Mock(name="instr1")
         ep_mock2 = Mock(name="instr2")
@@ -354,6 +355,12 @@ def test_load_instrumentors_import_error_does_not_stop_everything(
             ]
         )
         self.assertEqual(distro_mock.load_instrumentor.call_count, 2)
+        mock_logger.exception.assert_any_call(
+            "Importing of %s failed, skipping it",
+            ep_mock1.name,
+        )
+
+        mock_logger.debug.assert_any_call("Instrumented %s", ep_mock2.name)
 
     @patch(
         "opentelemetry.instrumentation.auto_instrumentation._load.entry_points"
@@ -382,6 +389,46 @@ def test_load_instrumentors_raises_exception(self, iter_mock):
         )
         self.assertEqual(distro_mock.load_instrumentor.call_count, 1)
 
+    @patch("opentelemetry.instrumentation.auto_instrumentation._load._logger")
+    @patch(
+        "opentelemetry.instrumentation.auto_instrumentation._load.entry_points"
+    )
+    def test_load_instrumentors_module_not_found_error(
+        self, iter_mock, mock_logger
+    ):
+        ep_mock1 = Mock()
+        ep_mock1.name = "instr1"
+
+        ep_mock2 = Mock()
+        ep_mock2.name = "instr2"
+
+        distro_mock = Mock()
+
+        distro_mock.load_instrumentor.side_effect = [
+            ModuleNotFoundError("No module named 'fake_module'"),
+            None,
+        ]
+
+        iter_mock.side_effect = [(), (ep_mock1, ep_mock2), ()]
+
+        _load._load_instrumentors(distro_mock)
+
+        distro_mock.load_instrumentor.assert_has_calls(
+            [
+                call(ep_mock1, raise_exception_on_conflict=True),
+                call(ep_mock2, raise_exception_on_conflict=True),
+            ]
+        )
+        self.assertEqual(distro_mock.load_instrumentor.call_count, 2)
+
+        mock_logger.debug.assert_any_call(
+            "Skipping instrumentation %s: %s",
+            "instr1",
+            "No module named 'fake_module'",
+        )
+
+        mock_logger.debug.assert_any_call("Instrumented %s", ep_mock2.name)
+
     def test_load_instrumentors_no_entry_point_mocks(self):
         distro_mock = Mock()
         _load._load_instrumentors(distro_mock)