chore(pin): prevent overriding the global tracer

Author: mabdinur

ddtrace/_trace/pin.py

@@ -6,7 +6,6 @@
 import wrapt
 
 import ddtrace
-from ddtrace.vendor.debtcollector import deprecate
 
 from ..internal.logger import get_logger
 
@@ -38,19 +37,11 @@ def __init__(
         self,
         service=None,  # type: Optional[str]
         tags=None,  # type: Optional[Dict[str, str]]
-        tracer=None,
         _config=None,  # type: Optional[Dict[str, Any]]
     ):
         # type: (...) -> None
-        if tracer is not None and tracer is not ddtrace.tracer:
-            deprecate(
-                "Initializing ddtrace.trace.Pin with `tracer` argument is deprecated",
-                message="All Pin instances should use the global tracer instance",
-                removal_version="3.0.0",
-            )
-        tracer = tracer or ddtrace.tracer
         self.tags = tags
-        self.tracer = tracer
+        self.tracer = ddtrace.tracer
         self._target = None  # type: Optional[int]
         # keep the configuration attribute internal because the
         # public API to access it is not the Pin class
@@ -127,7 +118,6 @@ def override(
         obj,  # type: Any
         service=None,  # type: Optional[str]
         tags=None,  # type: Optional[Dict[str, str]]
-        tracer=None,
     ):
         # type: (...) -> None
         """Override an object with the given attributes.
@@ -139,20 +129,14 @@ def override(
             >>> # Override a pin for a specific connection
             >>> Pin.override(conn, service='user-db')
         """
-        if tracer is not None:
-            deprecate(
-                "Calling ddtrace.trace.Pin.override(...) with the `tracer` argument is deprecated",
-                message="All Pin instances should use the global tracer instance",
-                removal_version="3.0.0",
-            )
         if not obj:
             return
 
         pin = cls.get_from(obj)
         if pin is None:
-            Pin(service=service, tags=tags, tracer=tracer).onto(obj)
+            Pin(service=service, tags=tags).onto(obj)
         else:
-            pin.clone(service=service, tags=tags, tracer=tracer).onto(obj)
+            pin.clone(service=service, tags=tags).onto(obj)
 
     def enabled(self):
         # type: () -> bool
@@ -198,21 +182,13 @@ def clone(
         self,
         service=None,  # type: Optional[str]
         tags=None,  # type: Optional[Dict[str, str]]
-        tracer=None,
     ):
         # type: (...) -> Pin
         """Return a clone of the pin with the given attributes replaced."""
         # do a shallow copy of Pin dicts
         if not tags and self.tags:
             tags = self.tags.copy()
 
-        if tracer is not None:
-            deprecate(
-                "Initializing ddtrace.trace.Pin with `tracer` argument is deprecated",
-                message="All Pin instances should use the global tracer instance",
-                removal_version="3.0.0",
-            )
-
         # we use a copy instead of a deepcopy because we expect configurations
         # to have only a root level dictionary without nested objects. Using
         # deepcopy introduces a big overhead:
@@ -224,6 +200,5 @@ def clone(
         return Pin(
             service=service or self.service,
             tags=tags,
-            tracer=tracer or self.tracer,  # do not clone the Tracer
             _config=config,
         )

ddtrace/contrib/internal/asgi/middleware.py

@@ -152,10 +152,7 @@ async def __call__(self, scope, receive, send):
 
         # Calling ddtrace.trace.Pin(...) with the `tracer` argument is deprecated
         # Remove this if statement when the `tracer` argument is removed
-        if self.tracer is ddtrace.tracer:
-            pin = ddtrace.trace.Pin(service="asgi")
-        else:
-            pin = ddtrace.trace.Pin(service="asgi", tracer=self.tracer)
+        pin = ddtrace.trace.Pin(service="asgi")
 
         with core.context_with_data(
             "asgi.__call__",

ddtrace/contrib/internal/django/patch.py

@@ -17,7 +17,6 @@
 import wrapt
 from wrapt.importer import when_imported
 
-import ddtrace
 from ddtrace import config
 from ddtrace.appsec._utils import _UserInfoRetriever
 from ddtrace.constants import SPAN_KIND
@@ -151,10 +150,7 @@ def cursor(django, pin, func, instance, args, kwargs):
 
         # Calling ddtrace.pin.Pin(...) with the `tracer` argument generates a deprecation warning.
         # Remove this if statement when the `tracer` argument is removed
-        if pin.tracer is ddtrace.tracer:
-            pin = Pin(service, tags=tags)
-        else:
-            pin = Pin(service, tags=tags, tracer=pin.tracer)
+        pin = Pin(service, tags=tags)
 
         cursor = func(*args, **kwargs)
 

ddtrace/contrib/internal/mongoengine/trace.py

@@ -29,11 +29,5 @@ def __call__(self, *args, **kwargs):
         client = self.__wrapped__(*args, **kwargs)
         pin = ddtrace.trace.Pin.get_from(self)
         if pin:
-            # Calling ddtrace.trace.Pin(...) with the `tracer` argument generates a deprecation warning.
-            # Remove this if statement when the `tracer` argument is removed
-            if pin.tracer is ddtrace.tracer:
-                ddtrace.trace.Pin(service=pin.service).onto(client)
-            else:
-                ddtrace.trace.Pin(service=pin.service, tracer=pin.tracer).onto(client)
-
+            ddtrace.trace.Pin(service=pin.service).onto(client)
         return client

ddtrace/contrib/internal/pylibmc/client.py

@@ -51,12 +51,7 @@ def __init__(self, client=None, service=memcached.SERVICE, tracer=None, *args, *
         super(TracedClient, self).__init__(client)
 
         schematized_service = schematize_service_name(service)
-        # Calling ddtrace.trace.Pin(...) with the `tracer` argument generates a deprecation warning.
-        # Remove this if statement when the `tracer` argument is removed
-        if tracer is ddtrace.tracer:
-            pin = ddtrace.trace.Pin(service=schematized_service)
-        else:
-            pin = ddtrace.trace.Pin(service=schematized_service, tracer=tracer)
+        pin = ddtrace.trace.Pin(service=schematized_service)
         pin.onto(self)
 
         # attempt to collect the pool of urls this client talks to

ddtrace/contrib/internal/sqlalchemy/engine.py

@@ -69,10 +69,7 @@ def __init__(self, tracer, service, engine):
         # attach the PIN
         # Calling ddtrace.trace.Pin(...) with the `tracer` argument generates a deprecation warning.
         # Remove this if statement when the `tracer` argument is removed
-        if self.tracer is ddtrace.tracer:
-            Pin(service=self.service).onto(engine)
-        else:
-            Pin(tracer=tracer, service=self.service).onto(engine)
+        Pin(service=self.service).onto(engine)
 
         listen(engine, "before_cursor_execute", self._before_cur_exec)
         listen(engine, "after_cursor_execute", self._after_cur_exec)

ddtrace/contrib/internal/tornado/application.py

@@ -57,7 +57,4 @@ def tracer_config(__init__, app, args, kwargs):
     # configure the PIN object for template rendering
     # Required for backwards compatibility. Remove the else clause when
     # the `ddtrace.trace.Pin` object no longer accepts the Pin argument.
-    if tracer is ddtrace.tracer:
-        ddtrace.trace.Pin(service=service).onto(template)
-    else:
-        ddtrace.trace.Pin(service=service, tracer=tracer).onto(template)
+    ddtrace.trace.Pin(service=service).onto(template)

tests/appsec/contrib_appsec/django_app/urls.py

@@ -13,6 +13,7 @@
 
 import ddtrace.constants
 from ddtrace.trace import tracer
+from tests.utils import Pin
 
 
 # django.conf.urls.url was deprecated in django 3 and removed in django 4
@@ -196,7 +197,7 @@ def login_user(request):
 def new_service(request, service_name: str):
     import ddtrace
 
-    ddtrace.trace.Pin.override(django, service=service_name, tracer=ddtrace.tracer)
+    Pin.override(django, service=service_name, tracer=ddtrace.tracer)
     return HttpResponse(service_name, status=200)
 
 

tests/appsec/contrib_appsec/fastapi_app/app.py

@@ -13,6 +13,7 @@
 
 import ddtrace.constants
 from ddtrace.trace import tracer
+from tests.utils import Pin
 
 
 fake_secret_token = "DataDog"
@@ -104,7 +105,7 @@ async def multi_view_no_param(request: Request):  # noqa: B008
     async def new_service(service_name: str, request: Request):  # noqa: B008
         import ddtrace
 
-        ddtrace.trace.Pin.override(app, service=service_name, tracer=ddtrace.tracer)
+        Pin.override(app, service=service_name, tracer=ddtrace.tracer)
         return HTMLResponse(service_name, 200)
 
     async def slow_numbers(minimum, maximum):

tests/appsec/contrib_appsec/flask_app/app.py

@@ -9,6 +9,7 @@
 # from ddtrace.appsec.iast import ddtrace_iast_flask_patch
 import ddtrace.constants
 from ddtrace.trace import tracer
+from tests.utils import Pin
 from tests.webclient import PingFilter
 
 
@@ -55,7 +56,7 @@ def multi_view(param_int=0, param_str=""):
 def new_service(service_name: str):
     import ddtrace
 
-    ddtrace.trace.Pin.override(Flask, service=service_name, tracer=ddtrace.tracer)
+    Pin.override(Flask, service=service_name, tracer=ddtrace.tracer)
     return service_name
 
 

tests/appsec/contrib_appsec/test_flask.py

@@ -2,8 +2,8 @@
 import pytest
 
 from ddtrace.internal.packages import get_version_for_package
-from ddtrace.trace import Pin
 from tests.appsec.contrib_appsec import utils
+from tests.utils import TestPin as Pin
 from tests.utils import TracerTestCase
 
 

tests/appsec/contrib_appsec/utils.py

@@ -17,6 +17,7 @@
 from ddtrace.settings.asm import config as asm_config
 import tests.appsec.rules as rules
 from tests.utils import DummyTracer
+from tests.utils import Pin
 from tests.utils import override_env
 from tests.utils import override_global_config
 
@@ -1567,8 +1568,8 @@ def test_tracer():
 
 @contextmanager
 def post_tracer(interface):
-    original_tracer = getattr(ddtrace.trace.Pin.get_from(interface.framework), "tracer", None)
-    ddtrace.trace.Pin.override(interface.framework, tracer=interface.tracer)
+    original_tracer = getattr(Pin.get_from(interface.framework), "tracer", None)
+    Pin.override(interface.framework, tracer=interface.tracer)
     yield
     if original_tracer is not None:
-        ddtrace.trace.Pin.override(interface.framework, tracer=original_tracer)
+        Pin.override(interface.framework, tracer=original_tracer)

tests/appsec/integrations/django_tests/conftest.py

@@ -6,10 +6,10 @@
 
 from ddtrace.appsec._iast import enable_iast_propagation
 from ddtrace.contrib.internal.django.patch import patch
-from ddtrace.trace import Pin
 from tests.appsec.iast.conftest import _end_iast_context_and_oce
 from tests.appsec.iast.conftest import _start_iast_context_and_oce
 from tests.utils import DummyTracer
+from tests.utils import TestPin as Pin
 from tests.utils import TracerSpanContainer
 from tests.utils import override_global_config
 

tests/commands/ddtrace_run_integration.py

@@ -5,9 +5,9 @@
 
 import redis
 
-from ddtrace.trace import Pin
 from tests.contrib.config import REDIS_CONFIG
 from tests.utils import DummyWriter
+from tests.utils import TestPin as Pin
 
 
 if __name__ == "__main__":

tests/contrib/aiobotocore/utils.py

@@ -3,7 +3,7 @@
 from async_generator import asynccontextmanager
 from async_generator import yield_
 
-from ddtrace.trace import Pin
+from tests.utils import TestPin as Pin
 
 
 LOCALSTACK_ENDPOINT_URL = {

tests/contrib/aiohttp/test_aiohttp_client.py

@@ -6,7 +6,7 @@
 from ddtrace.contrib.internal.aiohttp.patch import extract_netloc_and_query_info_from_url
 from ddtrace.contrib.internal.aiohttp.patch import patch
 from ddtrace.contrib.internal.aiohttp.patch import unpatch
-from ddtrace.trace import Pin
+from tests.utils import TestPin as Pin
 from tests.utils import override_config
 from tests.utils import override_http_config
 
@@ -101,7 +101,7 @@ async def test_distributed_tracing_disabled(ddtrace_run_python_code_in_subproces
 import asyncio
 import sys
 import aiohttp
-from ddtrace.trace import Pin
+from tests.utils import TestPin as Pin
 from tests.contrib.aiohttp.test_aiohttp_client import URL
 
 async def test():
@@ -184,7 +184,7 @@ def test_configure_service_name_pin(ddtrace_run_python_code_in_subprocess):
 import asyncio
 import sys
 import aiohttp
-from ddtrace.trace import Pin
+from tests.utils import TestPin as Pin
 from tests.contrib.aiohttp.test_aiohttp_client import URL_200
 
 async def test():

tests/contrib/aiohttp_jinja2/conftest.py

@@ -3,10 +3,10 @@
 
 from ddtrace.contrib.internal.aiohttp_jinja2.patch import patch
 from ddtrace.contrib.internal.aiohttp_jinja2.patch import unpatch
-from ddtrace.trace import Pin
 from tests.contrib.aiohttp.conftest import app_tracer  # noqa:F401
 from tests.contrib.aiohttp.conftest import patched_app_tracer  # noqa:F401
 from tests.contrib.aiohttp.conftest import untraced_app_tracer  # noqa:F401
+from tests.utils import TestPin as Pin
 
 
 @pytest.fixture

tests/contrib/aiohttp_jinja2/test_aiohttp_jinja2.py

@@ -2,11 +2,11 @@
 import pytest
 
 from ddtrace.constants import ERROR_MSG
-from ddtrace.trace import Pin
 from ddtrace.trace import tracer
 from tests.contrib.aiohttp.app.web import set_filesystem_loader
 from tests.contrib.aiohttp.app.web import set_package_loader
 import tests.contrib.aiohttp.conftest  # noqa:F401
+from tests.utils import TestPin as Pin
 
 
 VERSION = tuple(map(int, aiohttp_jinja2.__version__.split(".")))

tests/contrib/aiomysql/test_aiomysql.py

@@ -8,11 +8,11 @@
 from ddtrace.contrib.internal.aiomysql.patch import patch
 from ddtrace.contrib.internal.aiomysql.patch import unpatch
 from ddtrace.internal.schema import DEFAULT_SPAN_SERVICE_NAME
-from ddtrace.trace import Pin
 from tests.contrib import shared_tests_async as shared_tests
 from tests.contrib.asyncio.utils import AsyncioTestCase
 from tests.contrib.asyncio.utils import mark_asyncio
 from tests.contrib.config import MYSQL_CONFIG
+from tests.utils import TestPin as Pin
 
 
 AIOMYSQL_CONFIG = dict(MYSQL_CONFIG)

tests/contrib/aiopg/test.py

@@ -7,13 +7,13 @@
 from ddtrace.contrib.internal.aiopg.patch import patch
 from ddtrace.contrib.internal.aiopg.patch import unpatch
 from ddtrace.internal.schema import DEFAULT_SPAN_SERVICE_NAME
-
-# project
-from ddtrace.trace import Pin
 from tests.contrib.asyncio.utils import AsyncioTestCase
 from tests.contrib.config import POSTGRES_CONFIG
 from tests.opentracer.utils import init_tracer
 from tests.subprocesstest import run_in_subprocess
+
+# project
+from tests.utils import TestPin as Pin
 from tests.utils import assert_is_measured
 
 

tests/contrib/algoliasearch/test.py

@@ -3,8 +3,8 @@
 from ddtrace.contrib.internal.algoliasearch.patch import algoliasearch_version
 from ddtrace.contrib.internal.algoliasearch.patch import patch
 from ddtrace.contrib.internal.algoliasearch.patch import unpatch
-from ddtrace.trace import Pin
 from ddtrace.vendor.packaging.version import parse as parse_version
+from tests.utils import TestPin as Pin
 from tests.utils import TracerTestCase
 from tests.utils import assert_is_measured
 

tests/contrib/anthropic/conftest.py

@@ -6,10 +6,10 @@
 from ddtrace.contrib.internal.anthropic.patch import patch
 from ddtrace.contrib.internal.anthropic.patch import unpatch
 from ddtrace.llmobs import LLMObs
-from ddtrace.trace import Pin
 from tests.contrib.anthropic.utils import get_request_vcr
 from tests.utils import DummyTracer
 from tests.utils import DummyWriter
+from tests.utils import TestPin as Pin
 from tests.utils import override_config
 from tests.utils import override_env
 from tests.utils import override_global_config