-
Notifications
You must be signed in to change notification settings - Fork 73
DOC Document new queued job retry feature #870
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: 6
Are you sure you want to change the base?
DOC Document new queued job retry feature #870
Conversation
a1d0834 to
67ccc4e
Compare
67ccc4e to
bb5fb6d
Compare
| ```yml | ||
| Symbiote\QueuedJobs\Services\AbstractQueuedJob: | ||
| # Retry pattern with spread | ||
| # First retry attempt - Retry after 8 to 12 minutes | ||
| # Second retry attempt - Retry after 6.4 to 14.4 minutes | ||
| # Third retry attempt - Retry after 5.1 to 27.4 minutes | ||
| # Fourth retry attempt - Retry after 4 to 38.4 minutes | ||
| retry_max_attempts: 4 | ||
| retry_initial_delay: 600 | ||
| retry_falloff_multiplier: 1 | ||
| retry_falloff_multiplier_variance: 0.2 | ||
| ``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This example comes straight from the docs - see https://github.com/silverstripe/silverstripe-queuedjobs/blob/6/docs/en/08_troubleshooting.md#advanced-configuration
|
|
||
| ### Automatic retries for queued jobs | ||
|
|
||
| The [symbiote/silverstripe-queuedjobs](/optional_features/queuedjobs/) module now has the ability to automatically retry broken or paused jobs. By default no jobs will be retried, but you can easily enable this for all jobs by setting [`AbstractQueuedJob.retry_max_attempts`](api:Symbiote\QueuedJobs\Services\AbstractQueuedJob->retry_max_attempts) to the maximum number times you want to retry jobs. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| The [symbiote/silverstripe-queuedjobs](/optional_features/queuedjobs/) module now has the ability to automatically retry broken or paused jobs. By default no jobs will be retried, but you can easily enable this for all jobs by setting [`AbstractQueuedJob.retry_max_attempts`](api:Symbiote\QueuedJobs\Services\AbstractQueuedJob->retry_max_attempts) to the maximum number times you want to retry jobs. | |
| The [symbiote/silverstripe-queuedjobs](/optional_features/queuedjobs/) module now has the ability to automatically retry broken or paused jobs. By default no jobs will be retried, but you can easily enable this for all jobs by setting [`AbstractQueuedJob.retry_max_attempts`](api:Symbiote\QueuedJobs\Services\AbstractQueuedJob->retry_max_attempts) to the maximum number of times you want to retry jobs. |
|
|
||
| You can also define the delay between retry attempts, and randomise that delay to prevent clobbering your site and any external services your jobs might connect to. | ||
|
|
||
| ```yml |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This example given is really confusing in the context of a changelog i.e. people reading (including myself) don't have knowledge of what the PR does so seeing things like Third retry attempt - Retry after 5.1 to 27.4 minutes is confusing based on the given config. I think it would be better to not have this example, say it's configurable and simply link to the docs
Issue