feat: only call add_ignored when using the xray sdk

Author: Michael Brewer

aws_lambda_powertools/tracing/tracer.py

@@ -779,11 +779,12 @@ def _disable_xray_trace_batching(self):
     def _is_xray_provider(self):
         return "aws_xray_sdk" in self.provider.__module__
 
-    @staticmethod
-    def ignore_endpoint(hostname: Optional[str] = None, urls: Optional[List[str]] = None):
+    def ignore_endpoint(self, hostname: Optional[str] = None, urls: Optional[List[str]] = None):
         """If you want to ignore certain httplib requests you can do so based on the hostname or URL that is being
         requested.
 
+        > NOTE: If the provider is not xray, nothing will be added to ignore list
+
         Documentation
         --------------
         - https://github.com/aws/aws-xray-sdk-python#ignoring-httplib-requests
@@ -795,6 +796,9 @@ def ignore_endpoint(hostname: Optional[str] = None, urls: Optional[List[str]] =
         urls: Optional, List[str]
             List of urls to ignore. Example `tracer.ignore_endpoint(urls=["/ignored-url"])`
         """
+        if not self._is_xray_provider():
+            return
+
         from aws_xray_sdk.ext.httplib import add_ignored  # type: ignore
 
         add_ignored(hostname=hostname, urls=urls)

tests/unit/test_tracing.py

@@ -2,6 +2,7 @@
 import sys
 from typing import NamedTuple
 from unittest import mock
+from unittest.mock import MagicMock
 
 import pytest
 
@@ -630,7 +631,22 @@ def handler(event, context):
     assert in_subsegment_mock.put_annotation.call_args == mocker.call(key="ColdStart", value=True)
 
 
-def test_ignore_endpoints(provider_stub, in_subsegment_mock):
-    provider = provider_stub(in_subsegment=in_subsegment_mock.in_subsegment)
-    tracer = Tracer(provider=provider)
-    tracer.ignore_endpoint(hostname="https://foo.com/", urls=["/bar", "/ignored"])
+@mock.patch("aws_xray_sdk.ext.httplib.add_ignored")
+def test_ignore_endpoints_xray_sdk(mock_add_ignored: MagicMock):
+    # GIVEN a xray sdk provider
+    tracer = Tracer()
+    # WHEN we call ignore_endpoint
+    tracer.ignore_endpoint(hostname="https://www.foo.com/", urls=["/bar", "/ignored"])
+    # THEN call xray add_ignored
+    assert mock_add_ignored.call_count == 1
+    mock_add_ignored.assert_called_with(hostname="https://www.foo.com/", urls=["/bar", "/ignored"])
+
+
+@mock.patch("aws_xray_sdk.ext.httplib.add_ignored")
+def test_ignore_endpoints_mocked_provider(mock_add_ignored: MagicMock, provider_stub, in_subsegment_mock):
+    # GIVEN a mock provider
+    tracer = Tracer(provider=provider_stub(in_subsegment=in_subsegment_mock.in_subsegment))
+    # WHEN we call ignore_endpoint
+    tracer.ignore_endpoint(hostname="https://foo.com/")
+    # THEN don't call xray add_ignored
+    assert mock_add_ignored.call_count == 0