Python
Sentry's Python SDK enables automatic reporting of errors and performance data in your application.
- You need a Sentry account and project
- Read one of our dedicated guides if you use any of the frameworks we support
Select which Sentry features you'd like to install in addition to Error Monitoring to get the corresponding installation and configuration instructions below.
Install the Sentry SDK using pip:
pip install "sentry-sdk"
Configuration should happen as early as possible in your application's lifecycle.
import sentry_sdk
sentry_sdk.init(
dsn="___PUBLIC_DSN___",
# Add request headers and IP for users,
# see https://docs.sentry.io/platforms/python/data-management/data-collected/ for more info
send_default_pii=True,
# ___PRODUCT_OPTION_START___ performance
# Set traces_sample_rate to 1.0 to capture 100%
# of transactions for tracing.
traces_sample_rate=1.0,
# ___PRODUCT_OPTION_END___ performance
# ___PRODUCT_OPTION_START___ profiling
# To collect profiles for all profile sessions,
# set `profile_session_sample_rate` to 1.0.
profile_session_sample_rate=1.0,
# Profiles will be automatically collected while
# there is an active span.
profile_lifecycle="trace",
# ___PRODUCT_OPTION_END___ profiling
# ___PRODUCT_OPTION_START___ logs
# Enable logs to be sent to Sentry
enable_logs=True,
# ___PRODUCT_OPTION_END___ logs
)
In async programs, it's recommended to call sentry_sdk.init() inside an async function to ensure async code is instrumented properly. If possible, we recommend calling sentry_sdk.init() at the beginning of the first async function you call.
import asyncio
import sentry_sdk
async def main():
sentry_sdk.init(
... # same as above
)
asyncio.run(main())
Add this intentional error to your application to test that everything is working right away.
division_by_zero = 1 / 0
Learn more about manually capturing an error or message in our Usage documentation.
To view and resolve the recorded error, log into sentry.io and select your project. Clicking on the error's title will open a page where you can see detailed information and mark it as resolved.
Not seeing your error in Sentry? Make sure you're running the above example from a file and not from a Python shell like IPython.
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").