diff --git a/docs/configure.rst b/docs/configure.rst
index 08e94ab..3091ca6 100644
--- a/docs/configure.rst
+++ b/docs/configure.rst
@@ -353,20 +353,40 @@ scheduler
You can disable the scheduler by setting this option to ``False``. This will reduce a little overhead if you're not using schedules, but is most useful if you want to temporarily disable all schedules.
Defaults to ``True``
-rollbar
-~~~~~~~
-You can redirect worker exceptions directly to your `Rollbar `__ dashboard by installing the python notifier with ``pip install rollbar`` and adding this configuration dictionary to your config::
+.. _error_reporter:
- # rollbar config
+error_reporter
+~~~~~~~~~~~~~~
+You can redirect worker exceptions directly to various error reportes (for example, `Rollbar ` or `Sentry `) by installing Django Q with the necessary `extras `.
+
+To enable installed error reporters, you must provide the configuration settings required by an error reporter extension::
+
+ # error_reporter config--rollbar example
Q_CLUSTER = {
- 'rollbar': {
- 'access_token': '32we33a92a5224jiww8982',
- 'environment': 'Django-Q'
- }
+ 'error_reporter': {
+ 'rollbar': {
+ 'access_token': '32we33a92a5224jiww8982',
+ 'environment': 'Django-Q'
+ }
+ }
}
-Please check the Pyrollbar `configuration reference `__ for more options.
-Note that you will need a `Rollbar `__ account and access token to use this feature.
+For more information on error reporters and developing error reporting plugins for Django Q, see :doc:`errors`.
+
+.. rollbar
+.. ~~~~~~~
+.. You can redirect worker exceptions directly to your `Rollbar `__ dashboard by installing the python notifier with ``pip install rollbar`` and adding this configuration dictionary to your config::
+
+.. # rollbar config
+.. Q_CLUSTER = {
+.. 'rollbar': {
+.. 'access_token': '32we33a92a5224jiww8982',
+.. 'environment': 'Django-Q'
+.. }
+.. }
+
+.. Please check the Pyrollbar `configuration reference `__ for more options.
+.. Note that you will need a `Rollbar `__ account and access token to use this feature.
cpu_affinity
~~~~~~~~~~~~
diff --git a/docs/errors.rst b/docs/errors.rst
new file mode 100644
index 0000000..94643e2
--- /dev/null
+++ b/docs/errors.rst
@@ -0,0 +1,9 @@
+Errors
+------
+.. py:currentmodule:: django_q
+
+Django Q uses a pluggable error reporter system based upon python `extras `, allowing anyone to develop plugins for error reporting and monitoring integration. Currently implemented examples include `Rollbar ` and `Sentry `).
+
+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` 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 ` and `django-q-sentry `
diff --git a/docs/index.rst b/docs/index.rst
index ee4c3f0..c4ce657 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -42,6 +42,7 @@ Contents:
Cluster
Monitor
Admin
+ Errors
Signals
Architecture
Examples