From 8ae7aa346e57b81ab278ec653a00caea66d5c49e Mon Sep 17 00:00:00 2001 From: Ilan Steemers Date: Fri, 8 Jan 2016 12:06:56 +0100 Subject: [PATCH] Updates docs with rollbar support also bumps version to 0.7.12 --- README.rst | 2 +- django_q/__init__.py | 2 +- docs/conf.py | 2 +- docs/configure.rst | 15 +++++++++++++++ docs/index.rst | 2 +- docs/install.rst | 5 +++++ setup.py | 4 ++-- 7 files changed, 26 insertions(+), 6 deletions(-) diff --git a/README.rst b/README.rst index 73508e79..0497f025 100644 --- a/README.rst +++ b/README.rst @@ -21,7 +21,7 @@ Features - PaaS compatible with multiple instances - Multi cluster monitor - Redis, Disque, IronMQ, SQS, MongoDB or ORM -- Python 2 and 3 +- Rollbar support Requirements ~~~~~~~~~~~~ diff --git a/django_q/__init__.py b/django_q/__init__.py index e5551e0b..47ae6bcc 100644 --- a/django_q/__init__.py +++ b/django_q/__init__.py @@ -5,7 +5,7 @@ myPath = os.path.dirname(os.path.abspath(__file__)) sys.path.insert(0, myPath) -VERSION = (0, 7, 11) +VERSION = (0, 7, 12) default_app_config = 'django_q.apps.DjangoQConfig' diff --git a/docs/conf.py b/docs/conf.py index 7e303549..a0db1e78 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -72,7 +72,7 @@ # The short X.Y version. version = '0.7' # The full version, including alpha/beta/rc tags. -release = '0.7.11' +release = '0.7.12' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/docs/configure.rst b/docs/configure.rst index 9f07d4b6..cb0183d9 100644 --- a/docs/configure.rst +++ b/docs/configure.rst @@ -320,6 +320,21 @@ 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:: + + # 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/index.rst b/docs/index.rst index b0dc610b..07027a19 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -21,7 +21,7 @@ Features - PaaS compatible with multiple instances - Multi cluster monitor - Redis, Disque, IronMQ, SQS, MongoDB or ORM -- Python 2 and 3 +- Rollbar support Django Q is tested with: Python 2.7 & 3.5. Django 1.8.8 & 1.9.1 diff --git a/docs/install.rst b/docs/install.rst index ebeaa7bd..88418b26 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -78,6 +78,11 @@ Optional - `MongoDB `__ is a highly scalable NoSQL database which makes for a very fast and reliably persistent at-least-once message broker. Usually available on most PaaS providers. +- `Pyrollbar `__ is an error notifier for `Rollbar `__ which lets you manage your worker errors in one place. Needs a `Rollbar `__ account and access key:: + + $ pip install rollbar + + Compatibility ------------- Django Q is still a young project. If you do find any incompatibilities please submit an issue on `github `__. diff --git a/setup.py b/setup.py index efa917f4..e3243ebf 100644 --- a/setup.py +++ b/setup.py @@ -26,10 +26,10 @@ def run(self): setup( name='django-q', - version='0.7.11', + version='0.7.12', author='Ilan Steemers', author_email='koed0@gmail.com', - keywords='django distributed task queue worker scheduler cron redis disque ironmq sqs orm mongodb multiprocessing', + keywords='django distributed task queue worker scheduler cron redis disque ironmq sqs orm mongodb multiprocessing rollbar', packages=['django_q'], include_package_data=True, url='https://django-q.readthedocs.org',