feat(python): Update the Configuration > Sampling page for Python SDK 3.0
#14275
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
1 Skipped Deployment
|
Bundle ReportChanges will decrease total bundle size by 1.72kB (-0.01%) ⬇️. This is within the configured threshold ✅ Detailed changes
Affected Assets, Files, and Routes:view changes for bundle: sentry-docs-client-array-pushAssets Changed:
view changes for bundle: sentry-docs-server-cjsAssets Changed:
|
| ```python | ||
| sentry_sdk.start_transaction( | ||
| # kwargs passed to Transaction constructor - will be recorded on transaction | ||
| name="GET /search", | ||
| op="search", | ||
| data={ | ||
| "query_params": { | ||
| "animal": "dog", | ||
| "type": "very good" | ||
| } | ||
| }, | ||
| # `custom_sampling_context` - won't be recorded | ||
| custom_sampling_context={ | ||
| # PII | ||
| "user_id": "12312012", | ||
| # too big to send | ||
| "search_results": { ... } | ||
| } | ||
| ) | ||
| ``` | ||
|
|
There was a problem hiding this comment.
This is the current content of the snippet in performance/custom-sampling-context. Inlined it here on this page for SDK 2.0 so that the snippet can be updated to be 3.x compatible and used from the 3.x page.
| sentry_sdk.start_transaction( | ||
| name="GET /search", | ||
| sampled=True | ||
| ) |
sentrivana
changed the title
There was a problem hiding this comment.
This and the other python.<platform>.mdx snippets were removed because as far as I can tell they can never be displayed anywhere (and they're now outdated). They'd only display if the Python docs supported the sub-SDK/platform view like e.g. JS does.
There was a problem hiding this comment.
hmm ok I see, eventually these tables from the migration guide should probably live in the specific integration pages? not sure what is best..
There was a problem hiding this comment.
Yeah was also thinking that might be nice. Might do this in a follow up PR.
sentrivana
changed the title
Configuration > Sampling page for Python SDK 3.0
sentrivana
changed the title
Configuration > Sampling page for Python SDK 3.0Configuration > Sampling page for Python SDK 3.0
Co-authored-by: Shannon Anahata <shannon.anahata@gmail.com>
DESCRIBE YOUR PR
We've made some changes to sampling in the upcoming 3.0 version of the Python SDK. Creating a new 3.x version of the relevant pages.
Also removed some
python.<platform>.mdxsnippets because as far as I can tell they can never be displayed anywhere (and they're now outdated). They'd only display if the Python docs supported the sub-SDK/platform view like e.g. JS does.Once 3.x is actually out of alpha, we can make the
__3.xpage the default and make the base page into a__2.x.Direct link to the new page: https://sentry-docs-git-ivana-pythonsampling-breaking-changes.sentry.dev/platforms/python/configuration/sampling__v3.x (but note there are other changes too, see diff)
IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes:
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