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
{{ message }}
This repository was archived by the owner on Jan 5, 2026. It is now read-only.
Copy file name to clipboardExpand all lines: site/content/docs/groups/_index.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,13 +13,13 @@ aliases:
13
13
14
14
---
15
15
16
-
Groups help you organize your checks (e.g. by team or feature) and apply shared configuration such as API defaults, location overrides, and other properties.
16
+
Groups help you organize your checks (e.g. by team or feature) and apply shared configuration such as API defaults, scheduling & location overrides, and other properties.
17
17
18
18

19
19
20
20
# Creating a check group
21
21
22
-
By default, newly created check groups behave like folders, with no group-level configuration applied. To get started:
22
+
By default, newly created check groups behave like folders, with no [group-level configuration](#group-level-configuration) applied. To get started:
23
23
24
24
***Define a name:** Pick a meaningful name for your group. This will not only help you and your team identify the group within Checkly, but also provide a better alerting experience if checks in this group fall into an alert state.
25
25
@@ -32,22 +32,22 @@ You can populate a group by moving existing checks into it or by creating new ch
32
32
Groups let you apply shared configuration to standardize how checks behave. Below is a breakdown of each setting and how it affects checks in the group:
33
33
34
34
### API checks defaults
35
-
You can define [API check defaults](/docs/groups/api-check-defaults/) such as a common base URL, request information, [assertions](/docs/api-checks/assertions/), and [setup & teardown scripts](/docs/api-checks/setup-teardown-scripts/) to manage how API checks in your group behave.
35
+
You can define [API check defaults](/docs/groups/api-check-defaults/) such as a common base URL, request information, [assertions](/docs/api-checks/assertions/), and [setup & teardown scripts](/docs/api-checks/setup-teardown-scripts/) to manage API checks in your group at scale.
36
36
37
37
### Variables
38
38
For configuration information commonly used by checks in your group, create [group environment variables and secrets](/docs/groups/variables/). These are merged with variables at the global and check levels when a check runs.
39
39
40
40
### Scheduling & locations overrides
41
41
42
-
***Locations:** Select [public](/docs/monitoring/global-locations/) or [private](/docs/private-locations/) locations. This will override the location setting for all checks in your group—they’ll all run from the specified group locations.
42
+
***Locations:** Select [public](/docs/monitoring/global-locations/) or [private](/docs/private-locations/) locations. This will override the location setting for all checks in your group. For example, if you create a check that runs in `eu-west-1` but add it to a group running in `us-east-1`, the check will run from `us-east-1` only.
43
43
44
-
***Scheduling strategy:** Selecting a scheduling strategy (parallel or round-robin) will override this setting for all checks in your group.
44
+
***Scheduling strategy:** Selecting a [scheduling strategy](/docs/monitoring/global-locations/#scheduling-strategies) will override this setting for all checks in your group. For example, if you create a check that runs in `parallel` but add it to a group running in `round robin`, the check will run in `round robin` only.
45
45
46
46
***Frequency:** Each check in your group runs at its own scheduling interval. However, you can specify a default at the group level with the `frequency` property via the [CLI](/docs/cli/constructs-reference/#checkgroup).
47
47
48
48
### Retries & alerting overrides
49
49
50
-
***Retries:** Select your preferred [retry strategy](/docs/alerting-and-retries/retries/) for failed checks. This will override retry settings for all checks in your group.
50
+
***Retries:** Select your preferred [retry strategy](/docs/alerting-and-retries/retries/) for failed checks. This will override retry settings for all checks in your group. For example, if you create a check that runs with `fixed` retries but add it to a group running with `linear` retries, the check will run with `linear` retries only.
51
51
52
52
***Alert settings:** You can configure [alert channels](/docs/alerting-and-retries/alert-channels) for checks in your group. If we don’t provide your preferred alert method, use [webhooks](/docs/alerting-and-retries/webhooks/) to configure your alert flow. Like with retries, this will override alert settings for checks in your group.
53
53
@@ -63,7 +63,7 @@ Checkly manages the [runtime](/docs/runtimes) environment for your JavaScript co
63
63
64
64
# Adding or removing checks from groups
65
65
66
-
***Moving a check into a group:** If the group has group-level settings defined, adding a check may change how it runs. Settings like API defaults, locations, scheduling, retries, or alerting can override or append to the check’s configuration.
66
+
***Moving a check into a group:** If the group has [group-level configuration](#group-level-configuration) defined, adding a check may change how it runs. Settings like API defaults, locations & scheduling, or retries & alerting can override or append to the check’s configuration.
67
67
68
68
***Removing check from group:** The check will revert to its original configuration. Any [group-level configuration](#group-level-configuration) will no longer apply.
0 commit comments