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/cli/constructs-reference.md
+63-1Lines changed: 63 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -392,8 +392,10 @@ This brings the following benefits:
392
392
2. You can trigger all Checks in a group from the web UI and via a command line trigger.
393
393
3. You can manage group-level configuration like the runtime, activated & muted-state, tags and alert channels that trickle down to all the Checks in the group.
394
394
395
+
> Groups can behave as a folder without shared configuartion for checks if no overrides are defined for certain propeties.
396
+
395
397
> [!WARNING]
396
-
> Adding a check to a group means having it_only_ alert through the group's alert channels. Make sure your group has connected alert channels, or you might miss out on important alerts!
398
+
> Adding a check to a group that has defined group-level alert settings means the check will_only_ alert through the group's alert channels. Make sure your group has connected alert channels, or you might miss out on important alerts!
397
399
398
400
> Note: you will notice that managing shared configuration between Checks is very easy just using JS/TS. You might not need Check Groups for that purpose.
399
401
@@ -455,6 +457,66 @@ new ApiCheck('check-group-api-check-1', {
455
457
> Note that you can configure two different `frequency` properties for API and Browser checks in a `CheckGroup` separately.
456
458
> The CLI follows a fallback logic using `Check->CheckGroup->Project` configurations.
457
459
460
+
### Folder-like behavior
461
+
462
+
Groups can behave like folders, with no group-level configuration applied, meaning checks inside that group will run with its own check-level configuration.
463
+
464
+
The following group-level properties will have no effect on check runs if not defined (e.g. set as empty array `[]`, `null`, or `FALLBACK`):
465
+
466
+
-`runParallel`: `null` vs. overrideable configuration `true/false`.
467
+
-`locations`: `[]` vs. overrideable configuration, , i.e. `['us-east-1', 'eu-west-1']`.
468
+
-`privateLocations`: `[]` vs. overrideable configuration (slugs), i.e. `['datacenter-east-1']`.
469
+
-`retryStrategy`: `FALLBACK` vs. [RetryStrategy](/docs/cli/constructs-reference/#retrystrategy) object.
470
+
-`alertSettings`: `null` vs. [AlertSettings](/docs/cli/constructs-reference/#alertsettings) object.
471
+
472
+
> Note: group-level locations settings will override check-level configuation if one, or both of `locations` or `privateLocations` are defined to something other than an empty array `[]`.
473
+
474
+
```ts {title="group.check.ts"}
475
+
import { CheckGroup, ApiCheck, Frequency } from'checkly/constructs'
0 commit comments