documentation for error reporter plugin system

This commit is contained in:
Daniel Welch
2017-10-03 17:04:37 -04:00
parent f90c4f5747
commit f5e62bb624
3 changed files with 40 additions and 10 deletions
+30 -10
View File
@@ -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 <https://rollbar.com/>`__ 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 <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::
# 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 <https://github.com/rollbar/pyrollbar#configuration-reference>`__ for more options.
Note that you will need a `Rollbar <https://rollbar.com/>`__ 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<errors>`.
.. rollbar
.. ~~~~~~~
.. You can redirect worker exceptions directly to your `Rollbar <https://rollbar.com/>`__ 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 <https://github.com/rollbar/pyrollbar#configuration-reference>`__ for more options.
.. Note that you will need a `Rollbar <https://rollbar.com/>`__ account and access token to use this feature.
cpu_affinity
~~~~~~~~~~~~