mirror of
https://github.com/django-q2/django-q2.git
synced 2026-09-15 13:37:56 +08:00
Fixes some minor mistakes in the new error reporting documentation source
This commit is contained in:
@@ -357,7 +357,7 @@ Defaults to ``True``
|
||||
|
||||
error_reporter
|
||||
~~~~~~~~~~~~~~
|
||||
You can redirect worker exceptions directly to various error reportes (for example, `Rollbar <https://rollbar.com/>` or `Sentry <https://docs.sentry.io/>`) by installing Django Q with the necessary `extras <https://setuptools.readthedocs.io/en/latest/setuptools.html#declaring-extras-optional-features-with-their-own-dependencies>`.
|
||||
You can redirect worker exceptions directly to various error reporters (for example `Rollbar <https://rollbar.com/>`__ or `Sentry <https://docs.sentry.io/>`__) by installing Django Q with the necessary `extras <https://setuptools.readthedocs.io/en/latest/setuptools.html#declaring-extras-optional-features-with-their-own-dependencies>`__.
|
||||
|
||||
To enable installed error reporters, you must provide the configuration settings required by an error reporter extension::
|
||||
|
||||
@@ -368,7 +368,7 @@ To enable installed error reporters, you must provide the configuration settings
|
||||
'access_token': '32we33a92a5224jiww8982',
|
||||
'environment': 'Django-Q'
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
For more information on error reporters and developing error reporting plugins for Django Q, see :doc:`errors<errors>`.
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
Errors
|
||||
------
|
||||
.. py:currentmodule:: django_q
|
||||
.. py:currentmodule:: django_q
|
||||
|
||||
Django Q uses a pluggable error reporter system based upon python `extras <https://setuptools.readthedocs.io/en/latest/setuptools.html#declaring-extras-optional-features-with-their-own-dependencies>`, allowing anyone to develop plugins for error reporting and monitoring integration. Currently implemented examples include `Rollbar <https://rollbar.com/>` and `Sentry <https://docs.sentry.io/>`).
|
||||
Django Q uses a pluggable error reporter system based upon python `extras <https://setuptools.readthedocs.io/en/latest/setuptools.html#declaring-extras-optional-features-with-their-own-dependencies>`__, allowing anyone to develop plugins for their favorite error reporting and monitoring integration. Currently implemented examples include `Rollbar <https://rollbar.com/>`__ and `Sentry <https://docs.sentry.io/>`__.
|
||||
|
||||
Error reporting plugins register a class which implements a ``report`` method, which is invoked when a Django Q cluster encounters an error, pasing information to the particular service. Error reporters must be :ref:`configured<error_reporter>` via the ``Q_CLUSTER`` dictionary in your :file:`settings.py`. These settings are passed as kwargs upon initiation of the Error Reporter. Therefore, in order to implement a new plugin, a package must expose a class which will be instantiated with the necessary information via the ``Q_CLUSTER`` settings and implements a single ``report`` method.
|
||||
Error reporting plugins register a class which implements a ``report`` method, which is invoked when a Django Q cluster encounters an error, passing information to the particular service. Error reporters must be :ref:`configured<error_reporter>` via the ``Q_CLUSTER`` dictionary in your :file:`settings.py`. These settings are passed as kwargs upon initiation of the Error Reporter. Therefore, in order to implement a new plugin, a package must expose a class which will be instantiated with the necessary information via the ``Q_CLUSTER`` settings and implements a single ``report`` method.
|
||||
|
||||
For example implementations, see `django-q-rollbar <https://github.com/danielwelch/django-q-rollbar>` and `django-q-sentry <https://github.com/danielwelch/django-q-sentry>`
|
||||
For example implementations, see `django-q-rollbar <https://github.com/danielwelch/django-q-rollbar>`__ and `django-q-sentry <https://github.com/danielwelch/django-q-sentry>`__
|
||||
|
||||
@@ -86,6 +86,16 @@ Optional
|
||||
$ pip install rollbar
|
||||
|
||||
|
||||
|
||||
Extras
|
||||
------
|
||||
- `django-q-rollbar <https://github.com/danielwelch/django-q-rollbar>`__ is a Rollbar error reporter::
|
||||
|
||||
$ pip install django-q[rollbar]
|
||||
- `django-q-sentry <https://github.com/danielwelch/django-q-sentry>`__ is a Sentry error reporter::
|
||||
|
||||
$ pip install django-q[sentry]
|
||||
|
||||
Compatibility
|
||||
-------------
|
||||
Django Q is still a young project. If you do find any incompatibilities please submit an issue on `github <https://github.com/Koed00/django-q>`__.
|
||||
@@ -128,7 +138,7 @@ You can reference the `requirements <https://github.com/Koed00/django-q/blob/mas
|
||||
Django
|
||||
~~~~~~
|
||||
We strive to be compatible with last two major version of Django.
|
||||
At the moment this means we support the 1.8.18 LTS, 1.10.8 and 1.11.2 releases.
|
||||
At the moment this means we support the 1.8.18 LTS, 1.10.8 and 1.11.6 releases.
|
||||
|
||||
You might find that Django Q still works fine with Django 1.7 and 1.9, but new releases are no longer tested for it.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user