fix(tracing): ensure integrations can be disabled (backport #5856 to 1.13) (#5864)

Resolves: #5458

## Checklist

- [x] Change(s) are motivated and described in the PR description.
- [x] Testing strategy is described if automated tests are not included
in the PR.
- [x] Risk is outlined (performance impact, potential for breakage,
maintainability, etc).
- [x] Change is maintainable (easy to change, telemetry, documentation).
- [x] [Library release note
guidelines](https://ddtrace.readthedocs.io/en/stable/contributing.html#Release-Note-Guidelines)
are followed.
- [x] Documentation is included (in-code, generated user docs, [public
corp docs](https://github.com/DataDog/documentation/)).
- [x] OPTIONAL: PR description includes explicit acknowledgement of the
performance implications of the change as reported in the benchmarks PR
comment.

## Reviewer Checklist

- [x] Title is accurate.
- [x] No unnecessary changes are introduced.
- [x] Description motivates each change.
- [x] Avoids breaking
[API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces)
changes unless absolutely necessary.
- [x] Testing strategy adequately addresses listed risk(s).
- [x] Change is maintainable (easy to change, telemetry, documentation).
- [x] Release note makes sense to a user of the library.
- [x] Reviewer has explicitly acknowledged and discussed the performance
implications of this PR as reported in the benchmarks PR comment.

Author: mabdinur

ddtrace/_monkey.py

@@ -28,7 +28,7 @@
     "asyncio": True,
     "boto": True,
     "botocore": True,
-    "bottle": False,
+    "bottle": True,
     "cassandra": True,
     "celery": True,
     "consul": True,
@@ -72,9 +72,9 @@
     "kombu": False,
     "starlette": True,
     # Ignore some web framework integrations that might be configured explicitly in code
-    "falcon": False,
-    "pylons": False,
-    "pyramid": False,
+    "falcon": True,
+    "pylons": True,
+    "pyramid": True,
     # Auto-enable logging if the environment variable DD_LOGS_INJECTION is true
     "logging": config.logs_injection,
     "pynamodb": True,

ddtrace/bootstrap/sitecustomize.py

@@ -71,26 +71,6 @@
         )
 
 
-EXTRA_PATCHED_MODULES = {
-    "bottle": True,
-    "django": True,
-    "falcon": True,
-    "flask": True,
-    "pylons": True,
-    "pyramid": True,
-}
-
-
-def update_patched_modules():
-    modules_to_patch = os.getenv("DD_PATCH_MODULES")
-    if not modules_to_patch:
-        return
-
-    modules = parse_tags_str(modules_to_patch)
-    for module, should_patch in modules.items():
-        EXTRA_PATCHED_MODULES[module] = asbool(should_patch)
-
-
 if PY2:
     _unloaded_modules = []
 
@@ -220,15 +200,16 @@ def _(threading):
         tracer.configure(**opts)
 
     if trace_enabled:
-        update_patched_modules()
         from ddtrace import patch_all
 
         # We need to clean up after we have imported everything we need from
         # ddtrace, but before we register the patch-on-import hooks for the
         # integrations.
         cleanup_loaded_modules()
-
-        patch_all(**EXTRA_PATCHED_MODULES)
+        modules_to_patch = os.getenv("DD_PATCH_MODULES")
+        modules_to_str = parse_tags_str(modules_to_patch)
+        modules_to_bool = {k: asbool(v) for k, v in modules_to_str.items()}
+        patch_all(**modules_to_bool)
     else:
         cleanup_loaded_modules()
 

releasenotes/notes/ensure-ddtracerun-respects-disabled-integrations-ea1952a79a353bf0.yaml

@@ -0,0 +1,5 @@
+---
+fixes:
+  - |
+    tracing: Resolves an issue where ``DD_TRACE_<INTEGRATION>_ENABLED=False`` could not be used to disable
+    the following integrations when ``ddtrace-run`` was used: flask, django, bottle, falcon, and pyramid.

tests/commands/ddtrace_run_patched_modules_overrides.py

@@ -0,0 +1,24 @@
+if __name__ == "__main__":
+    from ddtrace._monkey import _PATCHED_MODULES
+
+    assert (
+        "flask" in _PATCHED_MODULES
+    ), "DD_PATCH_MODULES enables flask, this should override any value set by DD_TRACE_FLASK_ENABLED"
+
+    assert (
+        "gevent" in _PATCHED_MODULES
+    ), "DD_PATCH_MODULES enables gevent, this should override any value set by DD_TRACE_GEVENT_ENABLED"
+
+    assert (
+        "django" not in _PATCHED_MODULES
+    ), "DD_PATCH_MODULES enables django, this setting should override all other configurations"
+
+    assert (
+        "boto" in _PATCHED_MODULES
+    ), "DD_PATCH_MODULES disables boto, this setting should override all other configurations"
+
+    assert (
+        "falcon" not in _PATCHED_MODULES
+    ), "DD_PATCH_MODULES disables falcon, this setting override any value set by DD_TRACE_FALCON_ENABLED"
+
+    print("Test success")

tests/commands/test_runner.py

@@ -157,46 +157,18 @@ def test_patch_modules_from_env(self):
         """
         DD_PATCH_MODULES overrides the defaults for patch_all()
         """
-        from ddtrace.bootstrap.sitecustomize import EXTRA_PATCHED_MODULES
-        from ddtrace.bootstrap.sitecustomize import update_patched_modules
-
-        orig = EXTRA_PATCHED_MODULES.copy()
-
-        # empty / malformed strings are no-ops
-        with self.override_env(dict(DD_PATCH_MODULES="")):
-            update_patched_modules()
-            assert orig == EXTRA_PATCHED_MODULES
-
-        with self.override_env(dict(DD_PATCH_MODULES=":")):
-            update_patched_modules()
-            assert orig == EXTRA_PATCHED_MODULES
-
-        with self.override_env(dict(DD_PATCH_MODULES=",")):
-            update_patched_modules()
-            assert orig == EXTRA_PATCHED_MODULES
-
-        with self.override_env(dict(DD_PATCH_MODULES=",:")):
-            update_patched_modules()
-            assert orig == EXTRA_PATCHED_MODULES
-
-        # overrides work in either direction
-        with self.override_env(dict(DD_PATCH_MODULES="django:false")):
-            update_patched_modules()
-            assert EXTRA_PATCHED_MODULES["django"] is False
-
-        with self.override_env(dict(DD_PATCH_MODULES="boto:true")):
-            update_patched_modules()
-            assert EXTRA_PATCHED_MODULES["boto"] is True
-
-        with self.override_env(dict(DD_PATCH_MODULES="django:true,boto:false")):
-            update_patched_modules()
-            assert EXTRA_PATCHED_MODULES["boto"] is False
-            assert EXTRA_PATCHED_MODULES["django"] is True
-
-        with self.override_env(dict(DD_PATCH_MODULES="django:false,boto:true")):
-            update_patched_modules()
-            assert EXTRA_PATCHED_MODULES["boto"] is True
-            assert EXTRA_PATCHED_MODULES["django"] is False
+        with self.override_env(
+            env=dict(
+                DD_PATCH_MODULES="flask:true,gevent:true,django:false,boto:true,falcon:false",
+                DD_TRACE_FLASK_ENABLED="false",
+                DD_TRACE_GEVENT_ENABLED="false",
+                DD_TRACE_FALCON_ENABLED="true",
+            )
+        ):
+            out = subprocess.check_output(
+                ["ddtrace-run", "python", "tests/commands/ddtrace_run_patched_modules_overrides.py"],
+            )
+            assert out.startswith(b"Test success"), out
 
     def test_sitecustomize_without_ddtrace_run_command(self):
         # [Regression test]: ensure `sitecustomize` path is removed only if it's