You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: site/content/docs/alerting-and-retries/retries.md
+9-6Lines changed: 9 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,14 +28,15 @@ Click **Edit check** or **Edit group** on the 3-dot menu on your [Checkly Home p
28
28
29
29
There are three distinct retry strategies based on the time between retry attempts, and each one comes with different retry/backoff characteristics.
30
30
31
+
-**Retry once** — a single retry after a fixed interval, e.g. 5s.
31
32
-**Fixed** — a fixed time between retries, e.g. 5s, 5s, 5s etc.
32
33
-**Linear** — a linearly increasing time between retries, e.g. 5s, 10s, 15s etc.
33
34
-**Exponential** — an exponentially increasing time between retries, e.g. 5s, 25s, 125s (2m and 5s) etc.
34
35
35
36
On top of the time between attempts, you can also set:
36
37
37
-
***maximum number of retries** - the maximum number of retries for this check or check group.
38
-
***maximum total retry duration** - the maximum time a check can be in a retrying state.
38
+
-**maximum number of retries** - the maximum number of retries for this check or check group.
39
+
-**maximum total retry duration** - the maximum time a check can be in a retrying state.
39
40
This is a timeout to ensure the check finishes on a timely manner.
40
41
41
42
> Make sure to include the time your check needs to run when setting the **maximum total retry duration**. For example, if you set a maximum to 2 minutes, and your check takes 1.5 minutes, you have 30 seconds left for retries.
@@ -57,8 +58,8 @@ Of course, picking the right strategy depends on your use case, tolerance for in
57
58
58
59
### Location-based check retries
59
60
60
-
You can decide if a check should be retried from the same location or not with the checkbox:
61
-
**Always retry from the same location the check failed in**
61
+
You can decide if a check should be retried from the same location or not with the checkbox "**Always retry from the same location the check failed in**":
62
+
62
63
- If enabled, a check that fails will be retried in the same location.
63
64
- If disabled, a check that fails will be retried in a different location, from the locations your check runs at.
64
65
@@ -72,8 +73,9 @@ There are some tradeoffs to consider:
72
73
For API checks & URL monitors, you can enable network retries to automatically retry a check run only if it fails due to a network error—such as a timeout, DNS resolution issue, or connection reset.
73
74
74
75
When network retries are enabled:
75
-
* The check will retry on: ECONNRESET, ENOTFOUND, ETIMEDOUT, EAI_AGAIN, ECONNREFUSED, and similar network errors.
76
-
* The check will not retry on: Any HTTP response that includes a status code (4xx or 5xx), failed assertions, or any other type of check failure.
76
+
77
+
- The check will retry on: `ECONNRESET`, `ENOTFOUND`, `ETIMEDOUT`, `EAI_AGAIN`, `ECONNREFUSED`, and similar network errors.
78
+
- The check will not retry on: Any HTTP response that includes a status code (4xx or 5xx), failed assertions, or any other type of check failure.
77
79
78
80
## Test sessions retries
79
81
@@ -112,6 +114,7 @@ All retry attempts are be visible on the web interface at Checkly and in your co
112
114
```
113
115
114
116
### Test session retries in your CI/CD pipeline
117
+
115
118
Use the ``--reporter=ci`` flag to run test session retries from your CI/CD pipeline. The `ci` reporter will print out all retry attempts in the prompt output, instead of live-updating the prompt.
Copy file name to clipboardExpand all lines: site/content/docs/cli/constructs-reference.md
+2-1Lines changed: 2 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1057,7 +1057,7 @@ new ApiCheck('local-api-1', {
1057
1057
## `RetryStrategy`
1058
1058
1059
1059
`RetryStrategy` objects can be used to configure retries for failed check runs.
1060
-
Retry strategies can be set at the [check](#check), [check group](#checkgroup), and [project](#project) levels.
1060
+
Retry strategies can be set at the [check](#synthetic-checks) and [monitor](#uptime-monitors), [check group](#checkgroupv2), and [project](#project) levels.
1061
1061
[Learn more about retry strategies](/docs/alerting-and-retries/retries/#retry-strategies).
1062
1062
1063
1063
To build `RetryStrategy` objects you should use the `RetryStrategyBuilder`, which provides helper methods for configuring retries.
@@ -1083,6 +1083,7 @@ new ApiCheck('retrying-check', {
1083
1083
`RetryStrategyBuilder` supports the following helper methods:
1084
1084
1085
1085
-`noRetries()`: No retries are performed.
1086
+
-`singleStrategy(options)`: A single retry is performed after a fixed interval, e.g. 5s and 5s.
1086
1087
-`fixedStrategy(options)`: A fixed time between retries, e.g. 5s, 5s, 5s etc.
1087
1088
-`linearStrategy(options)`: A linearly increasing time between retries, e.g. 5s, 10s, 15s, etc.
1088
1089
-`exponentialStrategy(options)`: An exponentially increasing time between retries, e.g. 5s, 25s, 125s (2m and 5s) etc.
0 commit comments