Skip to content

fix(python): tracing wording improvements #12139

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.

Sign up for GitHub

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

Merged
obostjancic merged 2 commits into from
Dec 17, 2024
Merged

fix(python): tracing wording improvements #12139

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
59e2db9
fix(python): tracing wording improvements
obostjancic Dec 16, 2024
97d096c
Update docs/platforms/python/tracing/instrumentation/custom-instrumen…
obostjancic Dec 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions docs/platforms/python/tracing/instrumentation/custom-instrumentation/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Custom Instrumentation
description: "Learn how to capture performance data on any action in your app."
---

The Sentry SDK for Python does a very good job of auto instrumenting your application. If you use one of the popular frameworks, we've got you covered because everything is instrumented out of the box. The Sentry SDK will check your installed Python packages and auto enable the matching SDK integrations.
The Sentry SDK for Python does a very good job of auto instrumenting your application. If you use one of the popular frameworks, we've got you covered because well known operations like HTTP calls and database queries will be instrumented out of the box. The Sentry SDK will also check your installed Python packages and auto enable the matching SDK integrations. If you want to enable tracing in a piece of code that performs some other operations, add the @sentry_sdk.trace decorator"
Copy link
Member

@shellmayr shellmayr Dec 16, 2024

Choose a reason for hiding this comment

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

Suggested change
The Sentry SDK for Python does a very good job of auto instrumenting your application. If you use one of the popular frameworks, we've got you covered because well known operations like HTTP calls and database queries will be instrumented out of the box. The Sentry SDK will also check your installed Python packages and auto enable the matching SDK integrations. If you want to enable tracing in a piece of code that performs some other operations, add the @sentry_sdk.trace decorator"
The Sentry SDK for Python does a very good job of auto instrumenting your application. If you use one of the popular frameworks, we've got you covered because well known operations like HTTP calls and database queries will be instrumented out of the box. The Sentry SDK will also check your installed Python packages and auto enable the matching SDK integrations. If you want to enable tracing in a piece of code that performs some other operations, add the @sentry_sdk.trace decorator."


## Add a Transaction

Expand Down Expand Up @@ -98,6 +98,7 @@ def eat_pizza(pizza):
eat_slice(pizza.slices.pop())
span.finish()
```

<Alert title="Changed in 2.15.0" level="info">

The parameter `name` in `start_span()` used to be called `description`. In version 2.15.0 `description` was deprecated and from 2.15.0 on, only `name` should be used. `description` will be removed in `3.0.0`.
Expand Down Expand Up @@ -130,7 +131,6 @@ The parameter `name` in `start_span()` used to be called `description`. In versi

</Alert>


### Using a Decorator

```python
Expand Down Expand Up @@ -177,7 +177,6 @@ When you create your span manually, make sure to call `span.finish()` after the

To avoid having custom performance instrumentation code scattered all over your code base, pass a parameter <PlatformIdentifier name="functions-to-trace" /> to your `sentry_sdk.init()` call.


```python
import sentry_sdk

Expand Down
Loading