diff --git a/docs/brokers.rst b/docs/brokers.rst index a3fe3e4..e0de123 100644 --- a/docs/brokers.rst +++ b/docs/brokers.rst @@ -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) diff --git a/docs/monitor.rst b/docs/monitor.rst index 5ef9c91..2b9a28c 100644 --- a/docs/monitor.rst +++ b/docs/monitor.rst @@ -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 ------