Skip to content

Commit d8bc095

Browse files
committed
docs: update retry strategies section to add single retry
1 parent f435a5f commit d8bc095

File tree

2 files changed

+11
-7
lines changed

2 files changed

+11
-7
lines changed

site/content/docs/alerting-and-retries/retries.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,15 @@ Click **Edit check** or **Edit group** on the 3-dot menu on your [Checkly Home p
2828

2929
There are three distinct retry strategies based on the time between retry attempts, and each one comes with different retry/backoff characteristics.
3030

31+
- **Retry once** — a single retry after a fixed interval, e.g. 5s.
3132
- **Fixed** — a fixed time between retries, e.g. 5s, 5s, 5s etc.
3233
- **Linear** — a linearly increasing time between retries, e.g. 5s, 10s, 15s etc.
3334
- **Exponential** — an exponentially increasing time between retries, e.g. 5s, 25s, 125s (2m and 5s) etc.
3435

3536
On top of the time between attempts, you can also set:
3637

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.
3940
This is a timeout to ensure the check finishes on a timely manner.
4041

4142
> 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
5758

5859
### Location-based check retries
5960

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+
6263
- If enabled, a check that fails will be retried in the same location.
6364
- If disabled, a check that fails will be retried in a different location, from the locations your check runs at.
6465

@@ -72,8 +73,9 @@ There are some tradeoffs to consider:
7273
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.
7374

7475
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.
7779

7880
## Test sessions retries
7981

@@ -112,6 +114,7 @@ All retry attempts are be visible on the web interface at Checkly and in your co
112114
```
113115

114116
### Test session retries in your CI/CD pipeline
117+
115118
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.
116119

117120
For example:

site/content/docs/cli/constructs-reference.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1057,7 +1057,7 @@ new ApiCheck('local-api-1', {
10571057
## `RetryStrategy`
10581058

10591059
`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.
10611061
[Learn more about retry strategies](/docs/alerting-and-retries/retries/#retry-strategies).
10621062

10631063
To build `RetryStrategy` objects you should use the `RetryStrategyBuilder`, which provides helper methods for configuring retries.
@@ -1083,6 +1083,7 @@ new ApiCheck('retrying-check', {
10831083
`RetryStrategyBuilder` supports the following helper methods:
10841084

10851085
- `noRetries()`: No retries are performed.
1086+
- `singleStrategy(options)`: A single retry is performed after a fixed interval, e.g. 5s and 5s.
10861087
- `fixedStrategy(options)`: A fixed time between retries, e.g. 5s, 5s, 5s etc.
10871088
- `linearStrategy(options)`: A linearly increasing time between retries, e.g. 5s, 10s, 15s, etc.
10881089
- `exponentialStrategy(options)`: An exponentially increasing time between retries, e.g. 5s, 25s, 125s (2m and 5s) etc.

0 commit comments

Comments
 (0)