Sentry's Django integration enables automatic reporting of errors and exceptions.
Sentry's Django integration reports all exceptions leading to an Internal Server Error and creates a separate scope for each request. The integration supports Django Web Framework from Version 1.6 and above. Django applications using Channels 2.0 will be correctly instrumented using Python 3.7. Older versions of Python require installation of
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.
Install our Python SDK using
pip install --upgrade sentry-sdk
Configuration should happen as early as possible in your application's lifecycle.
Initialize the Python SDK with the Django integration in your
settings.py file. Once this is done, the SDK captures all unhandled exceptions and transactions.
import sentry_sdk from sentry_sdk.integrations.django import DjangoIntegration sentry_sdk.init( dsn="https://examplePublicKey@o0.ingest.sentry.io/0", integrations=[DjangoIntegration()], # 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, # If you wish to associate users to errors (assuming you are using # django.contrib.auth) you may enable sending PII data. send_default_pii=True )
Additional configuration for
DjangoIntegration 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:
from django.urls import path def trigger_error(request): division_by_zero = 1 / 0 urlpatterns = [ path('sentry-debug/', trigger_error), # ... ]
Visiting this route will trigger an error that will be captured by Sentry.
- If you use
django.contrib.authand 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 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.