diff --git a/messenger.rst b/messenger.rst index cbbd7e6b31f..0e3b8f51b0d 100644 --- a/messenger.rst +++ b/messenger.rst @@ -1441,38 +1441,47 @@ A number of options can be configured via the DSN or via the ``options`` key under the transport in ``messenger.yaml``: -=================== ===================================== ================================= -Option Description Default -=================== ===================================== ================================= -stream The Redis stream name messages -group The Redis consumer group name symfony -consumer Consumer name used in Redis consumer -auto_setup Create the Redis group automatically? true -auth The Redis password -delete_after_ack If ``true``, messages are deleted false - automatically after processing them -delete_after_reject If ``true``, messages are deleted true - automatically if they are rejected -lazy Connect only when a connection is false - really needed -serializer How to serialize the final payload ``Redis::SERIALIZER_PHP`` - in Redis (the - ``Redis::OPT_SERIALIZER`` option) -stream_max_entries The maximum number of entries which ``0`` (which means "no trimming") - the stream will be trimmed to. Set - it to a large enough number to - avoid losing pending messages -tls Enable TLS support for the connection false -redeliver_timeout Timeout before retrying a pending ``3600`` - message which is owned by an - abandoned consumer (if a worker died - for some reason, this will occur, - eventually you should retry the - message) - in seconds. -claim_interval Interval on which pending/abandoned ``60000`` (1 Minute) - messages should be checked for to - claim - in milliseconds -=================== ===================================== ================================= +======================= ===================================== ================================= + Option Description Default +======================= ===================================== ================================= +stream The Redis stream name messages +group The Redis consumer group name symfony +consumer Consumer name used in Redis consumer +auto_setup Create the Redis group automatically? true +auth The Redis password +delete_after_ack If ``true``, messages are deleted false + automatically after processing them +delete_after_reject If ``true``, messages are deleted true + automatically if they are rejected +lazy Connect only when a connection is false + really needed +serializer How to serialize the final payload ``Redis::SERIALIZER_PHP`` + in Redis (the + ``Redis::OPT_SERIALIZER`` option) +stream_max_entries The maximum number of entries which ``0`` (which means "no trimming") + the stream will be trimmed to. Set + it to a large enough number to + avoid losing pending messages +tls Enable TLS support for the connection false +redeliver_timeout Timeout before retrying a pending ``3600`` + message which is owned by an + abandoned consumer (if a worker died + for some reason, this will occur, + eventually you should retry the + message) - in seconds. +claim_interval Interval on which pending/abandoned ``60000`` (1 Minute) + messages should be checked for to + claim - in milliseconds +sentinel_persistent_id String, if null connection is null + non-persistent. +sentinel_retry_interval Int, value in milliseconds ``0`` +sentinel_read_timeout Float, value in seconds ``0`` + default indicates unlimited +sentinel_timeout Float, value in seconds ``0`` + default indicates unlimited +sentinel_master String, if null or empty Sentinel null + support is disabled +======================= ===================================== ================================= .. caution:: @@ -1500,6 +1509,11 @@ claim_interval Interval on which pending/abandoned ``60000`` (1 Minute) .. versionadded:: 5.2 The ``delete_after_reject`` and ``lazy`` options were introduced in Symfony 5.2. + +.. versionadded:: 5.4 + + The ``sentinel_persistent_id``, ``sentinel_retry_interval``, ``sentinel_read_timeout``, + ``sentinel_timeout``, and ``sentinel_master`` options were introduced in Symfony 5.4. .. deprecated:: 5.4