Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(pin): deprecate multi tracer support #11884

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

mabdinur
Copy link
Contributor

@mabdinur mabdinur commented Jan 9, 2025

Motivation

In ddtrace v3.0 ddtrace will drop support for initializing multiple instance of ddtrace.Tracer. With this change the all pin objects will use the same tracer instance. There is no need to support initializing, cloning or overriding the Pin.tracer argument.

Changes

  • Deprecates the tracer argument in Pin.override(..), Pin.__init__(...), and Pin.clone(...)
  • Avoids logging the new deprecation warning in integrations when the global tracer is used.

Checklist

  • PR author has checked that all the criteria below are met
  • The PR description includes an overview of the change
  • The PR description articulates the motivation for the change
  • The change includes tests OR the PR description describes a testing strategy
  • The PR description notes risks associated with the change, if any
  • Newly-added code is easy to change
  • The change follows the library release note guidelines
  • The change includes or references documentation updates if necessary
  • Backport labels are set (if applicable)

Reviewer Checklist

  • Reviewer has checked that all the criteria below are met
  • Title is accurate
  • All changes are related to the pull request's stated goal
  • Avoids breaking API changes
  • Testing strategy adequately addresses listed risks
  • Newly-added code is easy to change
  • Release note makes sense to a user of the library
  • If necessary, author has acknowledged and discussed the performance implications of this PR as reported in the benchmarks PR comment
  • Backport labels are set in a manner that is consistent with the release branch maintenance policy

Copy link
Contributor

github-actions bot commented Jan 9, 2025

CODEOWNERS have been resolved as:

releasenotes/notes/remove-multi-tracer-support-from-pin-f2f20ca3fa731929.yaml  @DataDog/apm-python
ddtrace/contrib/grpc/__init__.py                                        @DataDog/apm-core-python @DataDog/apm-idm-python
ddtrace/contrib/internal/django/patch.py                                @DataDog/apm-core-python @DataDog/apm-idm-python
ddtrace/contrib/internal/mongoengine/trace.py                           @DataDog/apm-core-python @DataDog/apm-idm-python
ddtrace/contrib/internal/pylibmc/client.py                              @DataDog/apm-core-python @DataDog/apm-idm-python
ddtrace/contrib/internal/sqlalchemy/engine.py                           @DataDog/apm-core-python @DataDog/apm-idm-python
ddtrace/contrib/internal/tornado/application.py                         @DataDog/apm-core-python @DataDog/apm-idm-python
ddtrace/contrib/vertica/__init__.py                                     @DataDog/apm-core-python @DataDog/apm-idm-python
ddtrace/pin.py                                                          @DataDog/apm-sdk-api-python

@datadog-dd-trace-py-rkomorn
Copy link

Datadog Report

Branch report: munir/deprecate-using-pin-with-multiple-tracers
Commit report: 538935a
Test service: dd-trace-py

✅ 0 Failed, 279 Passed, 1276 Skipped, 4m 29.61s Total duration (34m 46.7s time saved)

@pr-commenter
Copy link

pr-commenter bot commented Jan 9, 2025

Benchmarks

Benchmark execution time: 2025-01-09 17:38:17

Comparing candidate commit 538935a in PR branch munir/deprecate-using-pin-with-multiple-tracers with baseline commit 35fe7b5 in branch main.

Found 0 performance improvements and 0 performance regressions! Performance is the same for 394 metrics, 2 unstable metrics.

# 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)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With multiple tracers gone, is there a chance that we can perhaps drop the concept of Pins entirely?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants