Django

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.

Install

Sentry captures data by using an SDK within your application’s runtime.

Install our Python SDK using pip:

Copied
pip install --upgrade sentry-sdk

Configure

Configure Sentry as early as possible in your app.

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.

settings.py
Copied
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
)

Verify

This snippet includes an intentional error, so you can test that everything is working as soon as you set it up:

Copied
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.

After initialization:

  • If you use django.contrib.auth and have set send_default_pii=True in 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.

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.

You can edit this page on GitHub.