Sentry's Flask integration enables automatic reporting of errors and exceptions.
Our Python SDK will install the Flask integration for all of your apps. It hooks into Flask’s signals, not anything on the app object. Each request has a separate scope. Changes to the scope within a view, for example setting a tag, will only apply to events sent as part of the request being handled.
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.
Sentry captures data by using an SDK within your application’s runtime.
sentry-sdk from PyPI with the
pip install --upgrade 'sentry-sdk[flask]'
Configuration should happen as early as possible in your application's lifecycle.
import sentry_sdk from flask import Flask from sentry_sdk.integrations.flask import FlaskIntegration sentry_sdk.init( dsn="https://examplePublicKey@o0.ingest.sentry.io/0", integrations=[FlaskIntegration()], # 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 ) app = Flask(__name__)
Additional configuration for
FlaskIntegration can be found under integration configuration.
This snippet includes an intentional error, so you can test that everything is working as soon as you set it up:
@app.route('/debug-sentry') def trigger_error(): division_by_zero = 1 / 0
- If you use
flask-loginand have set
send_default_pii=Truein your call to
init, user data (current user id, email address, username) is attached to the event.
- Request data is attached to all events: HTTP method, URL, headers, form data, JSON payloads. Sentry excludes raw bodies and multipart file uploads.
- Logging with
app.loggeror any logger creates breadcrumbs when the Logging integration, which is enabled by default.
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.