feat(integrations): add ability to auto-deactivate lower-level integrations based on map

sentry_sdk/integrations/__init__.py

@@ -3,7 +3,7 @@
 
 from sentry_sdk.utils import logger
 
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Any
 
 if TYPE_CHECKING:
     from collections.abc import Sequence
@@ -171,6 +171,11 @@ def iter_default_integrations(with_auto_enabling_integrations):
 }
 
 
+_INTEGRATION_DEACTIVATES = {
+    "langchain": ["openai", "anthropic"],
+}
+
+
 def setup_integrations(
     integrations,  # type: Sequence[Integration]
     with_defaults=True,  # type: bool
@@ -187,13 +192,24 @@ def setup_integrations(
 
     `disabled_integrations` takes precedence over `with_defaults` and
     `with_auto_enabling_integrations`.
+
+    Some integrations are designed to automatically deactivate other integrations
+    in order to avoid conflicts and prevent duplicate telemetry from being collected.
+    For example, enabling the `langchain` integration will auto-deactivate both the
+    `openai` and `anthropic` integrations.
+
+    Users can override this behavior by:
+      - Explicitly providing an integration in the `integrations=[]` list, or
+      - Disabling the higher-level integration via the `disabled_integrations` option.
     """
     integrations = dict(
         (integration.identifier, integration) for integration in integrations or ()
     )
 
     logger.debug("Setting up integrations (with default = %s)", with_defaults)
 
+    user_provided_integrations = set[Any](integrations.keys())
+
     # Integrations that will not be enabled
     disabled_integrations = [
         integration if isinstance(integration, type) else type(integration)
@@ -212,6 +228,27 @@ def setup_integrations(
                 integrations[instance.identifier] = instance
                 used_as_default_integration.add(instance.identifier)
 
+    disabled_integration_identifiers = {
+        integration.identifier for integration in disabled_integrations
+    }
+
+    for integration, targets_to_deactivate in _INTEGRATION_DEACTIVATES.items():
+        if (
+            integration in integrations
+            and integration not in disabled_integration_identifiers
+        ):
+            for target in targets_to_deactivate:
+                if target not in user_provided_integrations:
+                    for cls in iter_default_integrations(True):
+                        if cls.identifier == target:
+                            if cls not in disabled_integrations:
+                                disabled_integrations.append(cls)
+                                logger.debug(
+                                    "Auto-deactivating %s integration because %s integration is active",
+                                    target,
+                                    integration,
+                                )
+
     for identifier, integration in integrations.items():
         with _installer_lock:
             if identifier not in _processed_integrations:

tests/test_ai_integration_deactivation.py

@@ -0,0 +1,232 @@
+import pytest
+
+from sentry_sdk import get_client
+from sentry_sdk.integrations import _INTEGRATION_DEACTIVATES
+
+
+try:
+    from sentry_sdk.integrations.langchain import LangchainIntegration
+
+    has_langchain = True
+except Exception:
+    has_langchain = False
+
+try:
+    from sentry_sdk.integrations.openai import OpenAIIntegration
+
+    has_openai = True
+except Exception:
+    has_openai = False
+
+try:
+    from sentry_sdk.integrations.anthropic import AnthropicIntegration
+
+    has_anthropic = True
+except Exception:
+    has_anthropic = False
+
+
+pytestmark = pytest.mark.skipif(
+    not (has_langchain and has_openai and has_anthropic),
+    reason="Requires langchain, openai, and anthropic packages to be installed",
+)
+
+
+def test_integration_deactivates_map_exists():
+    assert "langchain" in _INTEGRATION_DEACTIVATES
+    assert "openai" in _INTEGRATION_DEACTIVATES["langchain"]
+    assert "anthropic" in _INTEGRATION_DEACTIVATES["langchain"]
+
+
+@pytest.mark.forked
+def test_langchain_auto_deactivates_openai_and_anthropic(
+    sentry_init, reset_integrations
+):
+    sentry_init(
+        default_integrations=False,
+        auto_enabling_integrations=True,
+    )
+
+    client = get_client()
+    integration_types = {
+        type(integration) for integration in client.integrations.values()
+    }
+
+    if LangchainIntegration in integration_types:
+        assert OpenAIIntegration not in integration_types
+        assert AnthropicIntegration not in integration_types
+
+
+@pytest.mark.forked
+def test_user_can_override_with_explicit_openai(sentry_init, reset_integrations):
+    sentry_init(
+        default_integrations=False,
+        auto_enabling_integrations=True,
+        integrations=[OpenAIIntegration()],
+    )
+
+    client = get_client()
+    integration_types = {
+        type(integration) for integration in client.integrations.values()
+    }
+
+    assert OpenAIIntegration in integration_types
+
+
+@pytest.mark.forked
+def test_user_can_override_with_explicit_anthropic(sentry_init, reset_integrations):
+    sentry_init(
+        default_integrations=False,
+        auto_enabling_integrations=True,
+        integrations=[AnthropicIntegration()],
+    )
+
+    client = get_client()
+    integration_types = {
+        type(integration) for integration in client.integrations.values()
+    }
+
+    assert AnthropicIntegration in integration_types
+
+
+@pytest.mark.forked
+def test_user_can_override_with_both_explicit_integrations(
+    sentry_init, reset_integrations
+):
+    sentry_init(
+        default_integrations=False,
+        auto_enabling_integrations=True,
+        integrations=[OpenAIIntegration(), AnthropicIntegration()],
+    )
+
+    client = get_client()
+    integration_types = {
+        type(integration) for integration in client.integrations.values()
+    }
+
+    assert OpenAIIntegration in integration_types
+    assert AnthropicIntegration in integration_types
+
+
+@pytest.mark.forked
+def test_disabling_langchain_allows_openai_and_anthropic(
+    sentry_init, reset_integrations
+):
+    sentry_init(
+        default_integrations=False,
+        auto_enabling_integrations=True,
+        disabled_integrations=[LangchainIntegration],
+    )
+
+    client = get_client()
+    integration_types = {
+        type(integration) for integration in client.integrations.values()
+    }
+
+    assert LangchainIntegration not in integration_types
+
+
+@pytest.mark.forked
+def test_explicit_langchain_still_deactivates_others(sentry_init, reset_integrations):
+    sentry_init(
+        default_integrations=False,
+        auto_enabling_integrations=False,
+        integrations=[LangchainIntegration()],
+    )
+
+    client = get_client()
+    integration_types = {
+        type(integration) for integration in client.integrations.values()
+    }
+
+    if LangchainIntegration in integration_types:
+        assert OpenAIIntegration not in integration_types
+        assert AnthropicIntegration not in integration_types
+
+
+@pytest.mark.forked
+def test_langchain_and_openai_both_explicit_both_active(
+    sentry_init, reset_integrations
+):
+    sentry_init(
+        default_integrations=False,
+        auto_enabling_integrations=False,
+        integrations=[LangchainIntegration(), OpenAIIntegration()],
+    )
+
+    client = get_client()
+    integration_types = {
+        type(integration) for integration in client.integrations.values()
+    }
+
+    assert LangchainIntegration in integration_types
+    assert OpenAIIntegration in integration_types
+
+
+@pytest.mark.forked
+def test_no_langchain_means_openai_and_anthropic_can_auto_enable(
+    sentry_init, reset_integrations, monkeypatch
+):
+    import sys
+    import sentry_sdk.integrations
+
+    old_iter = sentry_sdk.integrations.iter_default_integrations
+
+    def filtered_iter(with_auto_enabling):
+        for cls in old_iter(with_auto_enabling):
+            if cls.identifier != "langchain":
+                yield cls
+
+    monkeypatch.setattr(
+        sentry_sdk.integrations, "iter_default_integrations", filtered_iter
+    )
+
+    sentry_init(
+        default_integrations=False,
+        auto_enabling_integrations=True,
+    )
+
+    client = get_client()
+    integration_types = {
+        type(integration) for integration in client.integrations.values()
+    }
+
+    assert LangchainIntegration not in integration_types
+
+
+@pytest.mark.forked
+def test_deactivation_with_default_integrations_enabled(
+    sentry_init, reset_integrations
+):
+    sentry_init(
+        default_integrations=True,
+        auto_enabling_integrations=True,
+    )
+
+    client = get_client()
+    integration_types = {
+        type(integration) for integration in client.integrations.values()
+    }
+
+    if LangchainIntegration in integration_types:
+        assert OpenAIIntegration not in integration_types
+        assert AnthropicIntegration not in integration_types
+
+
+@pytest.mark.forked
+def test_only_auto_enabling_integrations_without_defaults(
+    sentry_init, reset_integrations
+):
+    sentry_init(
+        default_integrations=False,
+        auto_enabling_integrations=True,
+    )
+
+    client = get_client()
+    integration_types = {
+        type(integration) for integration in client.integrations.values()
+    }
+
+    if LangchainIntegration in integration_types:
+        assert OpenAIIntegration not in integration_types
+        assert AnthropicIntegration not in integration_types