Add documentation for the jobs failure policy #4676
+45
−10
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
acroca
force-pushed
the
jobs-failure-policy
branch
from
8ffe3db to
17442bc
Compare
7 tasks
JoshVanL
previously requested changes
Jun 17, 2025
| `failure_policy` specifies how the job should handle failures. | ||
|
|
||
| It can be set to `constant` or `drop`. | ||
| - The `constant` policy will retry the job up to `max_retries` times, with a delay of `interval` between retries. |
There was a problem hiding this comment.
Please add that if max_retries is not set, it will retry forever.
| @@ -37,6 +37,7 @@ Parameter | Description | |||
| `dueTime` | An optional time at which the job should be active, or the "one shot" time, if other scheduling type fields are not provided. Accepts a "point in time" string in the format of RFC3339, Go duration string (calculated from creation time), or non-repeating ISO8601. | |||
| `repeats` | An optional number of times in which the job should be triggered. If not set, the job runs indefinitely or until expiration. | |||
| `ttl` | An optional time to live or expiration of the job. Accepts a "point in time" string in the format of RFC3339, Go duration string (calculated from job creation time), or non-repeating ISO8601. | |||
| `failure_policy` | An optional failure policy for the job. Details of the format are below. | |||
There was a problem hiding this comment.
Add to this line what the default value is when unset.
Please can we add a new table with the full failure_policy API definitions- add what the defaults are when fields are unset.
There was a problem hiding this comment.
Didn't add a table, but different bullet points for the two fields of the constant policy. Do you think this is good enough? I find a table might be confusing given that there are two types of policies, and one of them doesn't have any configuration.
|
@JoshVanL shouldn't this PR target the |
This was referenced Jun 19, 2025
3 tasks
msfussell
reviewed
Jun 26, 2025
| @@ -37,6 +37,7 @@ Parameter | Description | |||
| `dueTime` | An optional time at which the job should be active, or the "one shot" time, if other scheduling type fields are not provided. Accepts a "point in time" string in the format of RFC3339, Go duration string (calculated from creation time), or non-repeating ISO8601. | |||
| `repeats` | An optional number of times in which the job should be triggered. If not set, the job runs indefinitely or until expiration. | |||
| `ttl` | An optional time to live or expiration of the job. Accepts a "point in time" string in the format of RFC3339, Go duration string (calculated from job creation time), or non-repeating ISO8601. | |||
| `failure_policy` | An optional failure policy for the job. Details of the format are below. If not set, the job will be retried up to 3 times with a delay of 1 second between retries. | |||
There was a problem hiding this comment.
Suggested change
| `failure_policy` | An optional failure policy for the job. Details of the format are below. If not set, the job will be retried up to 3 times with a delay of 1 second between retries. | |
| `failure_policy` | An optional failure policy for the job. Details of the format are below. If not set, the job is retried up to 3 times with a delay of 1 second between retries. |
|
|
||
| It can be set to `constant` or `drop`. | ||
| - The `constant` policy will retry the job based on the configuration | ||
| - `max_retries` configures how many times the job should be retried. Not setting this will make it retry indefinitely. |
There was a problem hiding this comment.
Suggested change
| - `max_retries` configures how many times the job should be retried. Not setting this will make it retry indefinitely. | |
| - `max_retries` configures how many times the job should be retried. Not setting this makes it retry indefinitely. |
| `failure_policy` specifies how the job should handle failures. | ||
|
|
||
| It can be set to `constant` or `drop`. | ||
| - The `constant` policy will retry the job based on the configuration |
There was a problem hiding this comment.
Suggested change
| - The `constant` policy will retry the job based on the configuration | |
| - The `constant` policy retries the job based on the configuration |
Signed-off-by: Albert Callarisa <albert@diagrid.io>
…n the constant policy Signed-off-by: Albert Callarisa <albert@diagrid.io>
Signed-off-by: Albert Callarisa <albert@diagrid.io>
acroca
force-pushed
the
jobs-failure-policy
branch
from
17751d3 to
461c37f
Compare
alicejgibbons
approved these changes
Jul 4, 2025
| `failure_policy` specifies how the job should handle failures. | ||
|
|
||
| It can be set to `constant` or `drop`. | ||
| - The `constant` policy retries the job based on the configuration. |
There was a problem hiding this comment.
Suggested change
| - The `constant` policy retries the job based on the configuration. | |
| - The `constant` policy retries the job constantly with the following configuration options. |
| It can be set to `constant` or `drop`. | ||
| - The `constant` policy retries the job based on the configuration. | ||
| - `max_retries` configures how many times the job should be retried. Not setting this makes it retry indefinitely. | ||
| - `interval` configures the delay between retries. Not setting this makes it retry immediately. |
There was a problem hiding this comment.
Suggested change
| - `interval` configures the delay between retries. Not setting this makes it retry immediately. | |
| - `interval` configures the delay between retries. Defaults to retrying immediately. Valid values are of the form `200ms`, `15s`, `2m`, etc. |
There was a problem hiding this comment.
Not sure if all these are valid but this is what we say for other retry policies: https://docs.dapr.io/operations/resiliency/policies/retries/retries-overview/#spec-metadata
|
|
||
| It can be set to `constant` or `drop`. | ||
| - The `constant` policy retries the job based on the configuration. | ||
| - `max_retries` configures how many times the job should be retried. Not setting this makes it retry indefinitely. |
There was a problem hiding this comment.
Suggested change
| - `max_retries` configures how many times the job should be retried. Not setting this makes it retry indefinitely. | |
| - `max_retries` configures how many times the job should be retried. Defaults to retrying indefinitely. |
There was a problem hiding this comment.
Not sure if you can set -1 here or 0? If so them would add something like:
"-1 denotes an unlimited number of retries, while 0 means the request will not be retried."
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Thank you for helping make the Dapr documentation better!
Please follow this checklist before submitting:
In addition, please fill out the following to help reviewers understand this pull request:
Description
Document the use of FailurePolicy for jobs. This new field has been introduced in this PR
Issue reference