Python
Sentry's Python SDK enables automatic reporting of errors and exceptions as well as identifies perfomance issues in your application.
Sentry's Python SDK includes powerful hooks that let you get more out of Sentry, and helps you bind data like tags, users, or contexts. Our SDK supports Python 2.7, then 3.4 and above; specific versions for each framework are documented on the respective framework page. Migrating from older versions is documented here.
On this page, we get you up and running with Sentry's SDK, so that it will automatically report errors and exceptions in your application.
If you don't already have an account and Sentry project established, head over to sentry.io, then return to this page.
Using a framework? Take a look at our specific guides to get started.
Install
Sentry captures data by using an SDK within your application’s runtime.
Install our Python SDK using pip
:
pip install --upgrade sentry-sdk
Configure
Configuration should happen as early as possible in your application's lifecycle.
Once this is done, Sentry's Python SDK captures all unhandled exceptions and transactions.
import sentry_sdk
sentry_sdk.init(
"https://examplePublicKey@o0.ingest.sentry.io/0",
# Set traces_sample_rate to 1.0 to capture 100%
# of transactions for performance monitoring.
# We recommend adjusting this value in production.
traces_sample_rate=1.0,
)
Verify
This snippet includes an intentional error, so you can test that everything is working as soon as you set it up:
division_by_zero = 1 / 0
Or, by manually generating an event:
In Python you can either capture a caught exception or the one currently held in
sys.exc_info()
by not passing an argument:
from sentry_sdk import capture_exception
try:
a_potentially_failing_function()
except Exception as e:
# Alternatively the argument can be omitted
capture_exception(e)
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 open your project. Clicking on the error's title will open a page where you can see detailed information and mark it as resolved.
- Package:
- pypi:sentry-sdk
- Version:
- 0.19.5
- Repository:
- https://github.com/getsentry/sentry-python