tutor-contrib-sentry 20.0.0

Sentry Integration for Open edX

Sentry plugin for Tutor

A tutor plugin to integration Open edX with Sentry.

Installation

pip install tutor-contrib-sentry

Usage

tutor plugins enable sentry

Make sure to rebuld the openedx docker image to install the sentry SDK

Configuration

This plugin supports the following settings:

• SENTRY_DSN: The sentry DSN used for ingestion.
• SENTRY_IGNORED_ERRORS: A list of rules with exceptions types to ignore, optionally you can ignore only specific exceptions that matches a list of regex.

SENTRY_IGNORED_ERRORS:
# Ignore all AuthFailedError exceptions
- exc_class: AuthFailedError
# Ignore all exceptions that match a regex
- exc_text:
  - .*Email or password is incorrect
# Ignore all exceptions of type AuthFailedError that matches: .*Email or password is incorrect
- exc_class: AuthFailedError
  exc_text:
  - .*Email or password is incorrect

• SENTRY_ENVIRONMENT: The sentry environment. Defaults to production.
• SENTRY_EXTRA_ARGS: A dictionary with extra arguments for the sentry SDK. e.g:

SENTRY_EXTRA_ARGS:
  traces_sample_rate: 1.0
  profiles_sample_rate: 0.0

Recommendations

On production we recommend adjusting both traces_sample_rate and profiles_sample_rate as those can impact performance. See the sentry configuration options for more information.

License

This software is licensed under the terms of the AGPLv3.