docs: updates for broker changes

This commit is contained in:
Ilan Steemers
2015-09-15 17:41:41 +02:00
parent dbf0b20ba5
commit 6a564639d4
2 changed files with 8 additions and 2 deletions
+2 -2
View File
@@ -96,11 +96,11 @@ You can override this class if you want to contribute and support your own broke
.. py:method:: enqueue(task)
Sends a task package to the broker queue and returns a tracking id.
Sends a task package to the broker queue and returns a tracking id if available.
.. py:method:: dequeue()
Gets a task package from the broker and returns a tuple with a tracking id and the package.
Gets packages from the broker and returns a list of tuples with a tracking id and the package.
.. py:method:: acknowledge(id)
+6
View File
@@ -11,6 +11,10 @@ Start the monitor with Django's `manage.py` command::
.. image:: _static/monitor.png
For all broker types except the Redis broker, the monitor utilizes Django's cache framework to store statistics of running clusters.
This can be any type of cache backend as long as it can be shared among Django instances. For this reason, the local memory backend will not work.
Legend
------
@@ -88,6 +92,8 @@ Average execution time (`Avg time`) is calculated in seconds over the last 24 ho
Since some of these numbers are based on what is available in your tasks database, limiting or disabling the result backend will skew them.
Like with the monitor, these statistics come from a Redis server or Django's cache framework. So make sure you have either one configured.
Status
------