FlaskFlask
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.
Don't already have an account and Sentry project established? Head over to sentry.io, then return to this page.
Install
Sentry captures data by using an SDK within your application’s runtime.
Install sentry-sdk from PyPI with the flask extra:
pip install --upgrade 'sentry-sdk[flask]'Configure
Configuration should happen as early as possible in your application's lifecycle.
import sentry_sdk
from flask import Flask
sentry_sdk.init(
dsn="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,
# By default the SDK will try to use the SENTRY_RELEASE
# environment variable, or infer a git commit
# SHA as release, however you may want to set
# something more human-readable.
# release="myapp@1.0.0",
)
app = Flask(__name__)Verify
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 / 0After initialization:
- If you use
flask-loginand have setsend_default_pii=Truein your call toinit, 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.
- Logs emitted by
app.loggeror any logger are recorded as breadcrumbs by the Logging integration (this integration is enabled by default).
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.
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) to suggesting an update ("yeah, this would be better").