Skip to content

Commit c4fe71f

Browse files
[Messenger] Redis Sentinel support
1 parent 63261ef commit c4fe71f

File tree

1 file changed

+46
-32
lines changed

1 file changed

+46
-32
lines changed

messenger.rst

Lines changed: 46 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1441,38 +1441,47 @@ A number of options can be configured via the DSN or via the ``options`` key
14411441
under the transport in ``messenger.yaml``:
14421442

14431443

1444-
=================== ===================================== =================================
1445-
Option Description Default
1446-
=================== ===================================== =================================
1447-
stream The Redis stream name messages
1448-
group The Redis consumer group name symfony
1449-
consumer Consumer name used in Redis consumer
1450-
auto_setup Create the Redis group automatically? true
1451-
auth The Redis password
1452-
delete_after_ack If ``true``, messages are deleted false
1453-
automatically after processing them
1454-
delete_after_reject If ``true``, messages are deleted true
1455-
automatically if they are rejected
1456-
lazy Connect only when a connection is false
1457-
really needed
1458-
serializer How to serialize the final payload ``Redis::SERIALIZER_PHP``
1459-
in Redis (the
1460-
``Redis::OPT_SERIALIZER`` option)
1461-
stream_max_entries The maximum number of entries which ``0`` (which means "no trimming")
1462-
the stream will be trimmed to. Set
1463-
it to a large enough number to
1464-
avoid losing pending messages
1465-
tls Enable TLS support for the connection false
1466-
redeliver_timeout Timeout before retrying a pending ``3600``
1467-
message which is owned by an
1468-
abandoned consumer (if a worker died
1469-
for some reason, this will occur,
1470-
eventually you should retry the
1471-
message) - in seconds.
1472-
claim_interval Interval on which pending/abandoned ``60000`` (1 Minute)
1473-
messages should be checked for to
1474-
claim - in milliseconds
1475-
=================== ===================================== =================================
1444+
======================= ===================================== =================================
1445+
Option Description Default
1446+
======================= ===================================== =================================
1447+
stream The Redis stream name messages
1448+
group The Redis consumer group name symfony
1449+
consumer Consumer name used in Redis consumer
1450+
auto_setup Create the Redis group automatically? true
1451+
auth The Redis password
1452+
delete_after_ack If ``true``, messages are deleted false
1453+
automatically after processing them
1454+
delete_after_reject If ``true``, messages are deleted true
1455+
automatically if they are rejected
1456+
lazy Connect only when a connection is false
1457+
really needed
1458+
serializer How to serialize the final payload ``Redis::SERIALIZER_PHP``
1459+
in Redis (the
1460+
``Redis::OPT_SERIALIZER`` option)
1461+
stream_max_entries The maximum number of entries which ``0`` (which means "no trimming")
1462+
the stream will be trimmed to. Set
1463+
it to a large enough number to
1464+
avoid losing pending messages
1465+
tls Enable TLS support for the connection false
1466+
redeliver_timeout Timeout before retrying a pending ``3600``
1467+
message which is owned by an
1468+
abandoned consumer (if a worker died
1469+
for some reason, this will occur,
1470+
eventually you should retry the
1471+
message) - in seconds.
1472+
claim_interval Interval on which pending/abandoned ``60000`` (1 Minute)
1473+
messages should be checked for to
1474+
claim - in milliseconds
1475+
sentinel_persistent_id String, if null connection is null
1476+
non-persistent.
1477+
sentinel_retry_interval Int, value in milliseconds ``0``
1478+
sentinel_read_timeout Float, value in seconds ``0``
1479+
default indicates unlimited
1480+
sentinel_timeout Float, value in seconds ``0``
1481+
default indicates unlimited
1482+
sentinel_master String, if null or empty Sentinel null
1483+
support is disabled
1484+
======================= ===================================== =================================
14761485

14771486
.. caution::
14781487

@@ -1500,6 +1509,11 @@ claim_interval Interval on which pending/abandoned ``60000`` (1 Minute)
15001509
.. versionadded:: 5.2
15011510

15021511
The ``delete_after_reject`` and ``lazy`` options were introduced in Symfony 5.2.
1512+
1513+
.. versionadded:: 5.4
1514+
1515+
The ``sentinel_persistent_id``, ``sentinel_retry_interval``, ``sentinel_read_timeout``,
1516+
``sentinel_timeout``, and ``sentinel_master`` options were introduced in Symfony 5.4.
15031517

15041518
.. deprecated:: 5.4
15051519

0 commit comments

Comments
 (0)