maya-chen/flask
1
0
Fork 0
forked from orbit-oss/flask
Code Pull requests Activity

Update sentry error handling documentation (#2990)

Browse source 
- Change examples to use the Sentry Python SDK: `sentry-sdk`
- Removed the app factory pattern example
- Added a custom exception handling example
This commit is contained in:
Adam Walsh 2018-11-07 14:25:52 -05:00 • committed by Markus Unterwaditzer
parent e08bcf9f97
commit 3bf80912cf
1 changed files with 23 additions and 20 deletions
Download patch file Download diff file Expand all files Collapse all files

43
docs/errorhandling.rst
View file

@ -34,39 +34,42 @@ Error Logging Tools
Sending error mails, even if just for critical ones, can become Sending error mails, even if just for critical ones, can become
overwhelming if enough users are hitting the error and log files are overwhelming if enough users are hitting the error and log files are
typically never looked at. This is why we recommend using `Sentry typically never looked at. This is why we recommend using `Sentry
<https://www.getsentry.com/>`_ for dealing with application errors. It's <https://sentry.io/>`_ for dealing with application errors. It's
available as an Open Source project `on GitHub available as an Open Source project `on GitHub
<https://github.com/getsentry/sentry>`__ and is also available as a `hosted version <https://github.com/getsentry/sentry>`_ and is also available as a `hosted version
<https://getsentry.com/signup/>`_ which you can try for free. Sentry <https://sentry.io/signup/>`_ which you can try for free. Sentry
aggregates duplicate errors, captures the full stack trace and local aggregates duplicate errors, captures the full stack trace and local
variables for debugging, and sends you mails based on new errors or variables for debugging, and sends you mails based on new errors or
frequency thresholds. frequency thresholds.
To use Sentry you need to install the `raven` client with extra `flask` dependencies:: To use Sentry you need to install the `sentry-sdk` client with extra `flask` dependencies::
$ pip install raven[flask] $ pip install sentry-sdk[flask]
And then add this to your Flask app:: And then add this to your Flask app::
from raven.contrib.flask import Sentry import sentry_sdk
sentry = Sentry(app, dsn='YOUR_DSN_HERE') from sentry_sdk.integrations.flask import FlaskIntegration
Or if you are using factories you can also init it later:: sentry_sdk.init('YOUR_DSN_HERE',integrations=[FlaskIntegration()])
from raven.contrib.flask import Sentry
sentry = Sentry(dsn='YOUR_DSN_HERE')
def create_app():
app = Flask(__name__)
sentry.init_app(app)
...
return app
The `YOUR_DSN_HERE` value needs to be replaced with the DSN value you get The `YOUR_DSN_HERE` value needs to be replaced with the DSN value you get
from your Sentry installation. from your Sentry installation.
Afterwards failures are automatically reported to Sentry and from there After installation, failures leading to an Internal Server Error are automatically reported to
you can receive error notifications. Sentry and from there you can receive error notifications. Sentry also supports
capturing custom exceptions::
import sentry_sdk
try:
throwing_function()
except Exception as e:
with sentry_sdk.push_scope() as scope:
sentry_sdk.capture_exception(e)
See the `Python <https://docs.sentry.io/platforms/python/>`_ and `Flask-specific <https://docs.sentry.io/platforms/python/flask/>`_
Sentry SDK documentation for more detailed information.
.. _error-handlers: .. _error-handlers: