Starlite
Learn about using Sentry with Starlite.
The Starlite integration adds support for the Starlite framework.
Install sentry-sdk from PyPI with the starlite extra:
pip install --upgrade 'sentry-sdk[starlite]' uvicorn
If you have the starlite package in your dependencies, the Starlite integration will be enabled automatically when you initialize the Sentry SDK.
import sentry_sdk
sentry_sdk.init(
dsn="https://examplePublicKey@o0.ingest.sentry.io/0example-org / example-project",
# Add data like request headers and IP for users, if applicable;
# see https://docs.sentry.io/platforms/python/data-management/data-collected/ for more info
send_default_pii=True,
# Set traces_sample_rate to 1.0 to capture 100%
# of transactions for tracing.
traces_sample_rate=1.0,
# Set profiles_sample_rate to 1.0 to profile 100%
# of sampled transactions.
# We recommend adjusting this value in production.
profiles_sample_rate=1.0,
)
from starlite import Starlite, get
sentry_sdk.init(...) # same as above
@get("/hello")
async def hello_world() -> str:
1 / 0
return "Hello!"
app = Starlite(route_handlers=[hello_world])
Save the file above as app.py and start the development server with:
uvicorn app:app
When you point your browser to http://localhost:8000/hello a transaction will be created in the Performance section of sentry.io. Additionally, the ZeroDivisionError we've snuck into our hello_world handler will be sent to sentry.io and will be connected to the transaction.
It takes a couple of moments for the data to appear in sentry.io.
Note
Starlite was renamed to Litestar with the release of version 2.0. We support different integrations for each one. This guide applies to Starlite. See Litestar integration for the guide that applies to Litestar.
- Starlite: 1.48.0 - 1.51.14
- Python: 3.8+
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) or suggesting an update ("yeah, this would be better").