From a44fc6668255f9ba86847a1534acf447106538d1 Mon Sep 17 00:00:00 2001 From: Ilan Date: Fri, 24 Jul 2015 11:28:52 +0200 Subject: [PATCH] docs: added `queue_limit` information --- README.rst | 6 ++++-- docs/cluster.rst | 3 ++- docs/install.rst | 2 +- docs/monitor.rst | 2 +- 4 files changed, 8 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index cb6cca3..0b9cd71 100644 --- a/README.rst +++ b/README.rst @@ -57,7 +57,7 @@ Installation - Make sure you have a `Redis `__ server running somewhere -Read the more complete documentation at `http://django-q.readthedocs.org `__ +Read the full documentation at `http://django-q.readthedocs.org `__ Configuration @@ -67,7 +67,7 @@ All configuration settings are optional. e.g: .. code:: python - # settings.py + # settings.py example Q_CLUSTER = { 'name': 'myproject', 'workers': 8, @@ -75,6 +75,8 @@ All configuration settings are optional. e.g: 'timeout': 60, 'compress': True, 'save_limit': 250, + 'queue_limit: 500, + 'cpu_affinity': 1, 'label': 'Django Q', 'redis': { 'host': '127.0.0.1', diff --git a/docs/cluster.rst b/docs/cluster.rst index 09798ae..c752849 100644 --- a/docs/cluster.rst +++ b/docs/cluster.rst @@ -160,7 +160,8 @@ Afterwards the sentinel waits for the monitor to empty the result and then the s - Signal that we have stopped .. warning:: - If you force the cluster to terminate before the stop procedure has completed, you can lose tasks or results still being held in the queues. + If you force the cluster to terminate before the stop procedure has completed, you can lose tasks or results still being held in memory. + You can manage the amount of tasks in a clusters memory by setting the :ref:`queue_limit`. Reference --------- diff --git a/docs/install.rst b/docs/install.rst index 1bd5e5c..6b2aa46 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -37,6 +37,7 @@ Configuration is handled via the ``Q_CLUSTER`` dictionary in your :file:`setting 'timeout': 60, 'compress': True, 'save_limit': 250, + 'queue_limit: 500, 'cpu_affinity': 1, 'label': 'Django Q', 'redis': { @@ -46,7 +47,6 @@ Configuration is handled via the ``Q_CLUSTER`` dictionary in your :file:`setting } - name ~~~~ diff --git a/docs/monitor.rst b/docs/monitor.rst index 0b40c02..63a0a03 100644 --- a/docs/monitor.rst +++ b/docs/monitor.rst @@ -127,7 +127,7 @@ Reference The pid of the pusher process - .. py:attribute:: monitormight + .. py:attribute:: monitor The pid of the monitor process