https://github.com/danielwelch/django-q-sentry

Bringing Sentry error tracking to Django Q
https://github.com/danielwelch/django-q-sentry

django django-q sentry

Last synced: 2 months ago
JSON representation

Bringing Sentry error tracking to Django Q

• Host: GitHub
• URL: https://github.com/danielwelch/django-q-sentry
• Owner: danielwelch
• License: mit
• Created: 2017-03-31T01:58:08.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2023-11-04T19:08:25.000Z (over 1 year ago)
• Last Synced: 2024-03-19T15:03:21.338Z (11 months ago)
• Topics: django, django-q, sentry
• Language: Python
• Homepage:
• Size: 18.6 KB
• Stars: 8
• Watchers: 4
• Forks: 7
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        

# django-q-sentry

A [Django Q](https://github.com/Koed00/django-q/) Error Reporter plugin adding Sentry support.

# Before version 0.1.3 sentry raven was a dependency. After 0.1.3 sentry-sdk used as raven is being deprecated.

### Installation

This plugin is intended to be included with Django Q as [setuptools extra](https://setuptools.readthedocs.io/en/latest/setuptools.html#declaring-extras-optional-features-with-their-own-dependencies).

`$ pip install django-q[sentry]`

Or add `django-q[sentry]` to `requirements.txt`.

> This plugin requires Django Q version 0.8.1 or greater.

### Usage

Configure Sentry via the Django Q `Q_CLUSTER` dictionary in your Django project's `settings.py`. It is important that the `sentry` key be set in the `error_reporter` dictionary, as this name aligns with the project's entry point for this plugin. The only required configuration entry is your Sentry DSN.

```python

Q_CLUSTER = {

    'error_reporter': {

        'sentry': {

            'dsn': 'https://******@sentry.io/'

        }

    }

}

```

Please check the [python sentry client configuration docs](https://docs.sentry.io/clients/python/) for more options. Additional key-value pairs defined in `Q_CLUSTER['error_reporter']['sentry']` are passed directly as kwargs to instantiation of [`raven.Client`](https://docs.sentry.io/clients/python/#configuring-the-client).