Skip to content

Commit

Permalink
Remove redis fanout caveats
Browse files Browse the repository at this point in the history
The fanout_prefix and fanout_patterns transport options were made the default in Celery 4.0 
https://docs.celeryproject.org/en/stable/history/whatsnew-4.0.html#redis-events-not-backward-compatible
  • Loading branch information
leonardsocialcodeinc authored and auvipy committed Jul 9, 2020
1 parent e0d865c commit 9d54c8a
Showing 1 changed file with 0 additions and 40 deletions.
40 changes: 0 additions & 40 deletions docs/getting-started/brokers/redis.rst
Original file line number Diff line number Diff line change
Expand Up @@ -100,46 +100,6 @@ If you are using Sentinel, you should specify the master_name using the :setting
Caveats
=======

.. _redis-caveat-fanout-prefix:

Fanout prefix
-------------

Broadcast messages will be seen by all virtual hosts by default.

You have to set a transport option to prefix the messages so that
they will only be received by the active virtual host:

.. code-block:: python
app.conf.broker_transport_options = {'fanout_prefix': True}
Note that you won't be able to communicate with workers running older
versions or workers that doesn't have this setting enabled.

This setting will be the default in the future, so better to migrate
sooner rather than later.

.. _redis-caveat-fanout-patterns:

Fanout patterns
---------------

Workers will receive all task related events by default.

To avoid this you must set the ``fanout_patterns`` fanout option so that
the workers may only subscribe to worker related events:

.. code-block:: python
app.conf.broker_transport_options = {'fanout_patterns': True}
Note that this change is backward incompatible so all workers in the
cluster must have this option enabled, or else they won't be able to
communicate.

This option will be enabled by default in the future.

Visibility timeout
------------------

Expand Down

0 comments on commit 9d54c8a

Please sign in to comment.