[Python] Overhaul "Setup tracing" > "Custom instrumentation" #11341
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎ 3 Skipped Deployments
|
Bundle ReportChanges will decrease total bundle size by 15 bytes (-0.0%) ⬇️. This is within the configured threshold ✅ Detailed changes
|
docs/platforms/python/tracing/instrumentation/custom-instrumentation/index.mdx
Outdated
Show resolved
Hide resolved
docs/platforms/python/tracing/instrumentation/custom-instrumentation/index.mdx
Outdated
Show resolved
Hide resolved
Co-authored-by: Ivana Kellyer <[email protected]>
antonpirker
changed the title
docs/platforms/python/tracing/instrumentation/custom-instrumentation/index.mdx
Outdated
Show resolved
Hide resolved
| def eat_pizza(pizza): | ||
| with sentry_sdk.start_transaction(op="task", name="Eat Pizza"): | ||
| while pizza.slices > 0: | ||
| span = sentry_sdk.start_span(description="Eat Slice") |
There was a problem hiding this comment.
Is it necessary to call __enter__ and __exit__ here? We set some things on the scope in those magic methods, is that important?
| ``` | ||
|
|
||
| When you create your span manually, make sure to call `span.finish()` after the block of code you want to wrap in a span to finish the span. If you do not finish the span it will not be sent to Sentry. | ||
|
|
||
| ## Nested Spans | ||
|
|
||
| Spans can be nested to form a span tree. If you'd like to learn more, read our [distributed tracing](/product/sentry-basics/tracing/distributed-tracing/) documentation. |
There was a problem hiding this comment.
I don't think the examples in this section are needed, we could probably delete them
| <Alert title="Important" level="info"> | ||
|
|
||
| To enable performance monitoring for the functions specified in `functions_to_trace`, the SDK needs to load the function modules. Be aware, there may be code being executed in modules during module loading. To avoid this, use the method described above to trace your functions. | ||
|
|
||
| </Alert> |
There was a problem hiding this comment.
I feel like this page already has so much information. This block will just confuse people. We should either remove it, or if it is important, let's describe functions_to_trace in depth on a different page.
| <Alert title="Important" level="info"> | |
| To enable performance monitoring for the functions specified in `functions_to_trace`, the SDK needs to load the function modules. Be aware, there may be code being executed in modules during module loading. To avoid this, use the method described above to trace your functions. | |
| </Alert> |
docs/platforms/python/tracing/instrumentation/custom-instrumentation/index.mdx
Outdated
Show resolved
Hide resolved
| @@ -145,21 +173,21 @@ sentry_sdk.init( | |||
|
|
|||
| Now, whenever a function specified in `functions_to_trace` will be executed, a span will be created and attached as a child to the currently running span. | |||
|
|
|||
| <Alert level="warning" title="Important"> | |||
| <Alert title="Important" level="info"> | |||
|
|
|||
| To enable performance monitoring for the functions specified in `functions_to_trace`, the SDK needs to load the function modules. Be aware, there may be code being executed in modules during module loading. To avoid this, use the method described above to trace your functions. | |||
|
|
|||
| </Alert> | |||
|
|
|||
| ## Accessing the Current Transaction | |||
There was a problem hiding this comment.
I think we could probably also delete this section or move it to its own page. This is probably too much information for most use cases, especially because users who are doing custom instrumentation should already have a reference to the current transaction, since start_transaction returns the transaction.
| @@ -170,7 +198,7 @@ def eat_pizza(pizza): | |||
|
|
|||
| ## Accessing the Current Span | |||
There was a problem hiding this comment.
Same here, this section is again possibly too detailed for this page.
|
Although, to be fair, this PR is probably already an improvement over what we had before, so I have no objections to merging this change and creating a new issue to address further simplifying this page |
…tation/index.mdx Co-authored-by: Daniel Szoke <[email protected]>
|
Thanks for the review @szokeasaurusrex As for the page being long, I think this is not a big problem. No one reads docs pages from top to bottom. People coming here have a problem and an intend to fix it. They google "python sentry nested spans", land on that page, skim through the page (or CTRL+F) until the find the "Nested Spans" section, figure out how it is done and then leave. What you propose is in deed a bigger refactoring of the docs and outside of the scope of this PR. |
DESCRIBE YOUR PR
Preview Link:
https://sentry-docs-git-antonpirker-pythoncustom-tracing-information.sentry.dev/platforms/python/tracing/instrumentation/custom-instrumentation
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