Document Retry Strategy configuration fields#720
Conversation
Add documentation for the four Queue Settings → Retry Strategy fields: - Max retries (default: 3, can be 0 to disable) - Delay (default: 1000 ms) - Multiplier (default: 2, must be ≥ 1) - Max delay (default: 0 for no limit) Also fixes British to American English spelling (behaviour → behavior). Related to mautic/mautic#16157 which adds form validation for these fields.
promptless-for-oss
requested review from
adiati98 and
favour-chibueze
and removed request for
a team
|
|
||
| * **Max retries** - The maximum number of times Mautic retries a failed message before giving up. Set to ``0`` to disable retries. The default is ``3``. | ||
|
|
||
| * **Delay** - The initial delay in milliseconds before the first retry attempt. The default is ``1000`` (1 second). |
There was a problem hiding this comment.
Added Multiplier constraint documentation based on PR #16157 which adds form validation requiring messenger_retry_strategy_multiplier >= 1 to prevent MultiplierRetryStrategy crash from values < 1. Also documented the other three retry strategy fields and their defaults from the same PR.
Source: mautic/mautic#16157
adiati98
left a comment
adiati98
left a comment
There was a problem hiding this comment.
@promptless-for-oss please address the suggestions.
- Change "disable retries" to "turn off retries" for Max retries field - Adjust Delay field phrasing to use ", which is" instead of parentheses
|
Thanks for the review feedback, @adiati98! I've applied both suggested changes:
|
|
@promptless-for-oss please see and address the feedback from the original PR author at I checked it against the code change. It mostly matches: the defaults are right, and the multiplier rule is covered. The only small gap is that the code also rejects negative values for Max retries, Delay, and Max delay, so it would be good to mention those ranges too. Other than that, it looks aligned to me. |
Document that Max retries, Delay, and Max delay fields reject negative values, based on reviewer feedback from @adiati98 who verified this against the source code changes.
|
Thanks for the review feedback, @adiati98! I've updated the documentation to note that Max retries, Delay, and Max delay fields also reject negative values. |
2 participants
Open this suggestion in Promptless to view citations and reasoning process
Add documentation for the Queue Settings → Retry Strategy fields (Max retries, Delay, Multiplier, Max delay) including their default values and valid ranges. Notably documents that Multiplier values less than 1 are not allowed, preventing configuration errors that could crash the queue worker.
Trigger Events
Tip: Set up a GitHub Issues trigger in Projects to enable @Promptless mentions in issues 🐙