summaryrefslogtreecommitdiff
path: root/docs/integrations/celery.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/integrations/celery.rst')
-rw-r--r--docs/integrations/celery.rst62
1 files changed, 0 insertions, 62 deletions
diff --git a/docs/integrations/celery.rst b/docs/integrations/celery.rst
deleted file mode 100644
index b242d88..0000000
--- a/docs/integrations/celery.rst
+++ /dev/null
@@ -1,62 +0,0 @@
-Celery
-======
-
-`Celery <http://www.celeryproject.org/>`_ is a distributed task queue
-system for Python built on AMQP principles. For Celery built-in support
-by Raven is provided but it requires some manual configuration.
-
-Installation
-------------
-
-If you haven't already, start by downloading Raven. The easiest way is
-with *pip*::
-
- pip install raven --upgrade
-
-Setup
------
-To capture errors, you need to register a couple of signals to hijack
-Celery error handling::
-
- from raven import Client
- from raven.contrib.celery import register_signal, register_logger_signal
-
- client = Client('___DSN___')
-
- # register a custom filter to filter out duplicate logs
- register_logger_signal(client)
-
- # The register_logger_signal function can also take an optional argument
- # `loglevel` which is the level used for the handler created.
- # Defaults to `logging.ERROR`
- register_logger_signal(client, loglevel=logging.INFO)
-
- # hook into the Celery error handler
- register_signal(client)
-
- # The register_signal function can also take an optional argument
- # `ignore_expected` which causes exception classes specified in Task.throws
- # to be ignored
- register_signal(client, ignore_expected=True)
-
-A more complex version to encapsulate behavior:
-
-.. code-block:: python
-
- import celery
- import raven
- from raven.contrib.celery import register_signal, register_logger_signal
-
- class Celery(celery.Celery):
-
- def on_configure(self):
- client = raven.Client('___DSN___')
-
- # register a custom filter to filter out duplicate logs
- register_logger_signal(client)
-
- # hook into the Celery error handler
- register_signal(client)
-
- app = Celery(__name__)
- app.config_from_object('django.conf:settings')