Browse Source

Clarify the prefetch multiplier

For years, I thought CELERYD_PREFETCH_MULTIPLIER turned off prefetching, and I had a lot of weird problems.  Today I finally figured out 1 means disabled, 0 means PREFETCH ALL THE THINGS.  This fixes the documentation bug.
Kevin McCarthy 10 years ago
parent
commit
3f0ce3004d
1 changed files with 6 additions and 0 deletions
  1. 6 0
      docs/configuration.rst

+ 6 - 0
docs/configuration.rst

@@ -164,6 +164,12 @@ workers, note that the first worker to start will receive four times the
 number of messages initially.  Thus the tasks may not be fairly distributed
 to the workers.
 
+To disable prefetching, set CELERYD_PREFETCH_MULTIPLIER to 1.  Setting 
+CELERYD_PREFETCH_MULTIPLIER to 0 will allow the worker to keep consuming
+as many messages as it wants.
+
+For more on prefetching, read :ref:`optimizing-prefetch-limit`
+
 .. note::
 
     Tasks with ETA/countdown are not affected by prefetch limits.