plainx-sentry

Use Sentry to monitor errors and performance in your Plain application.

Installation

# settings.py
INSTALLED_PACKAGES = [
  # ...
  "plainx.sentry",
]

In your base.html, load sentry and include the sentry_js tag:

<!-- base.html -->
<!doctype html>
<html lang="en">
  <head>
      ...
      {% sentry_js %}
  </head>
  <body>
      ...
  </body>
</html>

To enable Sentry in production, add the SENTRY_DSN to your environment. In Heroku, for example:

heroku config:set SENTRY_DSN=<your-DSN>

User and request context

To attach user and request context to errors, add the middleware:

# settings.py
MIDDLEWARE = [
    ...
    "plain.sessions.middleware.SessionMiddleware",
    "plainx.sentry.middleware.SentryMiddleware",  # After SessionMiddleware
    ...
]

This attaches to errors:

• User context: ID, email, username
• Request context: URL, method, query string, headers, cookies

Email, username, headers, and cookies require SENTRY_PII_ENABLED=True (the default).

Configuration

Look at the default_settings.py for all available settings.

Error page feedback widget

In your 500.html, you can optionally use the sentry_feedback tag to show Sentry's feedback widget:

<!-- base.html -->
<!doctype html>
<html lang="en">
  <head>
      ...
      {% sentry_feedback %}
  </head>
  <body>
      ...
  </body>
</html>