Support OTEL_PYTHON_DISABLED_INSTRUMENTATIONS (#294)

* Support OTEL_PYTHON_DISABLED_INSTRUMENTATIONS

Author: jeremydvoss

CHANGELOG.md

@@ -10,6 +10,8 @@
     ([#291](https://github.com/microsoft/ApplicationInsights-Python/pull/291))
 - Fixing formatting issues for azure sdk
     ([#292](https://github.com/microsoft/ApplicationInsights-Python/pull/292))
+- Support OTEL_PYTHON_DISABLED_INSTRUMENTATIONS
+    ([#XXX](https://github.com/microsoft/ApplicationInsights-Python/pull/XXX))
 
 ## [1.0.0b12](https://github.com/microsoft/ApplicationInsights-Python/releases/tag/v1.0.0b12) - 2023-05-05
 

azure-monitor-opentelemetry/azure/monitor/opentelemetry/_configure.py

@@ -10,6 +10,7 @@
     DISABLE_LOGGING_ARG,
     DISABLE_METRICS_ARG,
     DISABLE_TRACING_ARG,
+    DISABLED_INSTRUMENTATIONS_ARG,
     LOGGING_EXPORT_INTERVAL_MS_ARG,
     SAMPLING_RATIO_ARG,
 )
@@ -89,7 +90,7 @@ def configure_azure_monitor(**kwargs) -> None:
     # Setup instrumentations
     # Instrumentations need to be setup last so to use the global providers
     # instanstiated in the other setup steps
-    _setup_instrumentations()
+    _setup_instrumentations(configurations)
 
 
 def _setup_tracing(configurations: Dict[str, ConfigurationValue]):
@@ -129,14 +130,21 @@ def _setup_metrics(configurations: Dict[str, ConfigurationValue]):
     set_meter_provider(meter_provider)
 
 
-def _setup_instrumentations():
+def _setup_instrumentations(configurations: Dict[str, ConfigurationValue]):
+    disabled_instrumentations = configurations[DISABLED_INSTRUMENTATIONS_ARG]
+
     # use pkg_resources for now until https://github.com/open-telemetry/opentelemetry-python/pull/3168 is merged
     for entry_point in iter_entry_points(
         "azure_monitor_opentelemetry_instrumentor"
     ):
         lib_name = entry_point.name
         if lib_name not in _SUPPORTED_INSTRUMENTED_LIBRARIES_DEPENDENCIES_MAP:
             continue
+        if entry_point.name in disabled_instrumentations:
+            _logger.debug(
+                "Instrumentation skipped for library %s", entry_point.name
+            )
+            continue
         try:
             # Check if dependent libraries/version are installed
             instruments = _SUPPORTED_INSTRUMENTED_LIBRARIES_DEPENDENCIES_MAP[

azure-monitor-opentelemetry/azure/monitor/opentelemetry/_constants.py

@@ -19,6 +19,7 @@
 DISABLE_LOGGING_ARG = "disable_logging"
 DISABLE_METRICS_ARG = "disable_metrics"
 DISABLE_TRACING_ARG = "disable_tracing"
+DISABLED_INSTRUMENTATIONS_ARG = "disabled_instrumentations"
 LOGGING_EXPORT_INTERVAL_MS_ARG = "logging_export_interval_ms"
 SAMPLING_RATIO_ARG = "sampling_ratio"
 

azure-monitor-opentelemetry/azure/monitor/opentelemetry/util/configurations.py

@@ -12,10 +12,14 @@
     DISABLE_LOGGING_ARG,
     DISABLE_METRICS_ARG,
     DISABLE_TRACING_ARG,
+    DISABLED_INSTRUMENTATIONS_ARG,
     LOGGING_EXPORT_INTERVAL_MS_ARG,
     SAMPLING_RATIO_ARG,
 )
 from azure.monitor.opentelemetry._types import ConfigurationValue
+from azure.monitor.opentelemetry._vendor.v0_38b0.opentelemetry.instrumentation.environment_variables import (
+    OTEL_PYTHON_DISABLED_INSTRUMENTATIONS,
+)
 from opentelemetry.environment_variables import (
     OTEL_LOGS_EXPORTER,
     OTEL_METRICS_EXPORTER,
@@ -45,6 +49,7 @@ def _get_configurations(**kwargs) -> Dict[str, ConfigurationValue]:
     _default_disable_logging(configurations)
     _default_disable_metrics(configurations)
     _default_disable_tracing(configurations)
+    _default_disabled_instrumentations(configurations)
     _default_logging_export_interval_ms(configurations)
     _default_sampling_ratio(configurations)
 
@@ -81,6 +86,19 @@ def _default_disable_tracing(configurations):
     configurations[DISABLE_TRACING_ARG] = default
 
 
+def _default_disabled_instrumentations(configurations):
+    disabled_instrumentation = environ.get(
+        OTEL_PYTHON_DISABLED_INSTRUMENTATIONS, []
+    )
+    if isinstance(disabled_instrumentation, str):
+        disabled_instrumentation = disabled_instrumentation.split(",")
+        # to handle users entering "requests , flask" or "requests, flask" with spaces
+        disabled_instrumentation = [
+            x.strip() for x in disabled_instrumentation
+        ]
+    configurations[DISABLED_INSTRUMENTATIONS_ARG] = disabled_instrumentation
+
+
 def _default_logging_export_interval_ms(configurations):
     default = 5000
     if LOGGING_EXPORT_INTERVAL_MS_ENV_VAR in environ:

azure-monitor-opentelemetry/tests/configuration/test_configure.py

@@ -52,7 +52,7 @@ def test_configure_azure_monitor(
         tracing_mock.assert_called_once()
         logging_mock.assert_called_once()
         metrics_mock.assert_called_once()
-        instrumentation_mock.assert_called_once_with()
+        instrumentation_mock.assert_called_once()
 
     @patch(
         "azure.monitor.opentelemetry._configure._setup_instrumentations",
@@ -88,7 +88,7 @@ def test_configure_azure_monitor_disable_tracing(
         tracing_mock.assert_not_called()
         logging_mock.assert_called_once_with(configurations)
         metrics_mock.assert_called_once_with(configurations)
-        instrumentation_mock.assert_called_once_with()
+        instrumentation_mock.assert_called_once_with(configurations)
 
     @patch(
         "azure.monitor.opentelemetry._configure._setup_instrumentations",
@@ -124,7 +124,7 @@ def test_configure_azure_monitor_disable_logging(
         tracing_mock.assert_called_once_with(configurations)
         logging_mock.assert_not_called()
         metrics_mock.assert_called_once_with(configurations)
-        instrumentation_mock.assert_called_once_with()
+        instrumentation_mock.assert_called_once_with(configurations)
 
     @patch(
         "azure.monitor.opentelemetry._configure._setup_instrumentations",
@@ -160,7 +160,7 @@ def test_configure_azure_monitor_disable_metrics(
         tracing_mock.assert_called_once_with(configurations)
         logging_mock.assert_called_once_with(configurations)
         metrics_mock.assert_not_called()
-        instrumentation_mock.assert_called_once_with()
+        instrumentation_mock.assert_called_once_with(configurations)
 
     @patch(
         "azure.monitor.opentelemetry._configure.BatchSpanProcessor",
@@ -340,7 +340,7 @@ def test_setup_instrumentations_lib_not_supported(
         )[0]
         ep2_mock.load.return_value = instr_class_mock
         dep_mock.return_value = None
-        _setup_instrumentations()
+        _setup_instrumentations({"disabled_instrumentations": []})
         dep_mock.assert_called_with(
             _SUPPORTED_INSTRUMENTED_LIBRARIES_DEPENDENCIES_MAP[ep2_mock.name]
         )
@@ -367,7 +367,7 @@ def test_setup_instrumentations_conflict(
         )[0]
         ep_mock.load.return_value = instr_class_mock
         dep_mock.return_value = True
-        _setup_instrumentations()
+        _setup_instrumentations({"disabled_instrumentations": []})
         dep_mock.assert_called_with(
             _SUPPORTED_INSTRUMENTED_LIBRARIES_DEPENDENCIES_MAP[ep_mock.name]
         )
@@ -394,10 +394,42 @@ def test_setup_instrumentations_exception(
         )[0]
         ep_mock.load.side_effect = Exception()
         dep_mock.return_value = None
-        _setup_instrumentations()
+        _setup_instrumentations({"disabled_instrumentations": []})
         dep_mock.assert_called_with(
             _SUPPORTED_INSTRUMENTED_LIBRARIES_DEPENDENCIES_MAP[ep_mock.name]
         )
         ep_mock.load.assert_called_once()
         instrumentor_mock.instrument.assert_not_called()
         logger_mock.warning.assert_called_once()
+
+    @patch("azure.monitor.opentelemetry._configure._logger")
+    @patch("azure.monitor.opentelemetry._configure.get_dependency_conflicts")
+    @patch("azure.monitor.opentelemetry._configure.iter_entry_points")
+    def test_setup_instrumentations_disabled(
+        self,
+        iter_mock,
+        dep_mock,
+        logger_mock,
+    ):
+        ep_mock = Mock()
+        ep2_mock = Mock()
+        iter_mock.return_value = (ep_mock, ep2_mock)
+        instrumentor_mock = Mock()
+        instr_class_mock = Mock()
+        instr_class_mock.return_value = instrumentor_mock
+        ep_mock.name = list(
+            _SUPPORTED_INSTRUMENTED_LIBRARIES_DEPENDENCIES_MAP.keys()
+        )[0]
+        ep2_mock.name = list(
+            _SUPPORTED_INSTRUMENTED_LIBRARIES_DEPENDENCIES_MAP.keys()
+        )[1]
+        ep2_mock.load.return_value = instr_class_mock
+        dep_mock.return_value = None
+        _setup_instrumentations({"disabled_instrumentations": [ep_mock.name]})
+        dep_mock.assert_called_with(
+            _SUPPORTED_INSTRUMENTED_LIBRARIES_DEPENDENCIES_MAP[ep2_mock.name]
+        )
+        ep_mock.load.assert_not_called()
+        ep2_mock.load.assert_called_once()
+        instrumentor_mock.instrument.assert_called_once()
+        logger_mock.debug.assert_called_once()

azure-monitor-opentelemetry/tests/configuration/test_util.py

@@ -15,6 +15,9 @@
 from unittest import TestCase
 from unittest.mock import patch
 
+from azure.monitor.opentelemetry._vendor.v0_38b0.opentelemetry.instrumentation.environment_variables import (
+    OTEL_PYTHON_DISABLED_INSTRUMENTATIONS,
+)
 from azure.monitor.opentelemetry.util.configurations import (
     LOGGING_EXPORT_INTERVAL_MS_ENV_VAR,
     SAMPLING_RATIO_ENV_VAR,
@@ -38,6 +41,7 @@ def test_get_configurations(self):
         self.assertEqual(configurations["disable_logging"], False)
         self.assertEqual(configurations["disable_metrics"], False)
         self.assertEqual(configurations["disable_tracing"], False)
+        self.assertEqual(configurations["disabled_instrumentations"], [])
         self.assertEqual(configurations["sampling_ratio"], 1.0)
         self.assertEqual(configurations["logging_export_interval_ms"], 5000)
         self.assertEqual(configurations["credential"], ("test_credential"))
@@ -51,6 +55,7 @@ def test_get_configurations_defaults(self):
         self.assertEqual(configurations["disable_logging"], False)
         self.assertEqual(configurations["disable_metrics"], False)
         self.assertEqual(configurations["disable_tracing"], False)
+        self.assertEqual(configurations["disabled_instrumentations"], [])
         self.assertEqual(configurations["sampling_ratio"], 1.0)
         self.assertEqual(configurations["logging_export_interval_ms"], 5000)
         self.assertTrue("credential" not in configurations)
@@ -69,6 +74,7 @@ def test_get_configurations_logging_export_validation(self):
     @patch.dict(
         "os.environ",
         {
+            OTEL_PYTHON_DISABLED_INSTRUMENTATIONS: "flask , requests,fastapi",
             LOGGING_EXPORT_INTERVAL_MS_ENV_VAR: "10000",
             SAMPLING_RATIO_ENV_VAR: "0.5",
             OTEL_TRACES_EXPORTER: "None",
@@ -84,6 +90,10 @@ def test_get_configurations_env_vars(self):
         self.assertEqual(configurations["disable_logging"], True)
         self.assertEqual(configurations["disable_metrics"], True)
         self.assertEqual(configurations["disable_tracing"], True)
+        self.assertEqual(
+            configurations["disabled_instrumentations"],
+            ["flask", "requests", "fastapi"],
+        )
         self.assertEqual(configurations["sampling_ratio"], 0.5)
         self.assertEqual(configurations["logging_export_interval_ms"], 10000)