Skip to content

Deprecated enable_tracing option in Python docs.#12439

Merged
stephanie-anderson merged 1 commit intomasterfrom
antonpirker/python/deprecate-enable-tracing
Feb 5, 2025
Merged

Deprecated enable_tracing option in Python docs.#12439
stephanie-anderson merged 1 commit intomasterfrom
antonpirker/python/deprecate-enable-tracing

Conversation

@antonpirker
Copy link
Contributor

@antonpirker antonpirker commented Jan 23, 2025

DESCRIBE YOUR PR

The option enable_tracing has been deprecated, so update the docs to not use it in code snippets and mark it as deprecated.

Preview: https://sentry-docs-git-antonpirker-pythondeprecate-enable-tracing.sentry.dev/platforms/python/configuration/options#enable-tracing

Fixes #12417

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.

  • Urgent deadline (GA date, etc.):
  • Other deadline:
  • None: Not urgent, can wait up to 1 week+

SLA

  • Teamwork makes the dream work, so please add a reviewer to your PRs.
  • Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it.
    Thanks in advance for your help!

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

LEGAL BOILERPLATE

Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

EXTRA RESOURCES

@vercel
Copy link

vercel bot commented Jan 23, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
develop-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 23, 2025 0:10am
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 23, 2025 0:10am
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
changelog ⬜️ Ignored (Inspect) Jan 23, 2025 0:10am

@codecov
Copy link

codecov bot commented Jan 23, 2025

Bundle Report

Changes will decrease total bundle size by 15 bytes (-0.0%) ⬇️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
sentry-docs-server-cjs 10.38MB 9 bytes (-0.0%) ⬇️
sentry-docs-client-array-push 9.3MB 6 bytes (-0.0%) ⬇️

Copy link
Contributor

@coolguyzone coolguyzone left a comment

Choose a reason for hiding this comment

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

Thanks for updating, looks good.

@antonpirker
Copy link
Contributor Author

Thanks for reviewing @coolguyzone, I will merge this once the new version of the SDK with the deprecation has been released.

@stephanie-anderson stephanie-anderson merged commit ce3059b into master Feb 5, 2025
@stephanie-anderson stephanie-anderson deleted the antonpirker/python/deprecate-enable-tracing branch February 5, 2025 11:43
enable_tracing=True,
# Set traces_sample_rate to 1.0 to capture 100%
# of transactions for tracing.
tracees_sample_rate=1.0,

Choose a reason for hiding this comment

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

@antonpirker Hello! Noticed this PR introduced a typo.
There is a doubled "ee"

tracees_sample_rate  # current
traces_sample_rate    # should be

Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks @kid-alan, we'll fix this right away!

Copy link
Contributor

Choose a reason for hiding this comment

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

Fix should be up soon. Thanks again for noticing.

vperron added a commit to gip-inclusion/data-inclusion that referenced this pull request Feb 26, 2025
There was a SENTRY_ENABLE_TRACING parameter introduced in
65a4d4e, but it is now
removed from the Sentry SDK documentation.

The correct configuration is now the traces_sample_rate setting:
getsentry/sentry-docs#12439

It's a little bit disappointing to notice though that having the traces
enabled since a long time didn't help getting the ooutgoing HTTP
requests timings, as those are not supported in airflow-sentry.
@github-actions github-actions bot locked and limited conversation to collaborators Feb 28, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Deprecated enable_tracing option in Python SDK docs.

5 participants