Skip to content

docs(python): Improve BottleIntegration options docs #11512

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
merged 2 commits into from
Oct 14, 2024
Merged

docs(python): Improve BottleIntegration options docs #11512

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
886386c
docs(python): Improve `BottleIntegration` options docs
szokeasaurusrex Oct 8, 2024
1d5d92a
Apply suggestions from code review
szokeasaurusrex Oct 11, 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
22 changes: 11 additions & 11 deletions docs/platforms/python/integrations/bottle/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,22 +73,22 @@ sentry_sdk.init(

```

You can pass the following keyword arguments to `BottleIntegration()`:
Each of the following options are supported as keyword arguments to `BottleIntegration()`.

- `transaction_style`:
### `transaction_style`

```python
@app.route("/myurl/<foo>")
def myendpoint():
return "ok"
```
The `transaction_style` option specifies how the transaction name is generated. You can set the option to `"endpoint"` (the default) or `"url"`.

In the above code, you would set the transaction to:
For example, given the following route:

- `/myurl/<foo>` if you set `transaction_style="url"`.
- `myendpoint` if you set `transaction_style="endpoint"`
```python
@app.route("/myurl/<foo>")
def myendpoint():
return "ok"
```

The default is `"endpoint"`.
- If you set `transaction_style="endpoint"`, the transaction name is `"myendpoint"`, since that is the route handler function's name.
- If you set `transaction_style="url"`, the transaction name is `"/myurl/<foo>"`, since that is the URL path.

## Supported Versions

Expand Down
Loading