-
Notifications
You must be signed in to change notification settings - Fork 38
feat: add Entitlements group troubleshoot guide [TREE-202 TREE-77] #1354
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
pmallol
wants to merge
10
commits into
main
Choose a base branch
from
entitlements-group-troubleshoot
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
b0935bb
docs: update group documentation with validation troubleshooting guide
pmallol 4e25490
docs: update troubleshooting section for mixed monitor types in group…
pmallol 79c61b5
docs: update retry strategies section to add single retry
pmallol df92048
fix: tweak example for single retry strategy
pmallol 13438a6
fix: apply suggestion from @sujaya-sys
pmallol b17687a
fix: apply suggestion from @sujaya-sys in synthetic checks
pmallol 40eb4f5
refactor: apply suggestion from @sujaya-sys in example of troubleshoot
pmallol 757d689
refactor: update title for validation of groups
pmallol 4969915
docs: update section header for mixing different monitor types in a g…
pmallol 44fcf5d
docs: update link text for troubleshooting guidance on monitor types …
pmallol File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -17,7 +17,7 @@ Groups help you organize your checks (e.g. by team or feature) and apply shared | |
|
||
 | ||
|
||
# Creating a check group | ||
## Creating a check group | ||
|
||
By default, newly created check groups behave like folders, with no [group-level configuration](#group-level-configuration) applied. To get started: | ||
|
||
|
@@ -27,14 +27,16 @@ By default, newly created check groups behave like folders, with no [group-level | |
|
||
You can populate a group by moving existing checks into it or by creating new checks directly within the group. | ||
|
||
# Group level configuration | ||
## Group level configuration | ||
|
||
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: | ||
|
||
### API checks defaults | ||
|
||
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. | ||
|
||
### Variables | ||
|
||
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. | ||
|
||
### Scheduling & locations overrides | ||
|
@@ -62,7 +64,7 @@ You can run checks in this group as [E2E tests](/docs/testing) locally or from y | |
|
||
Checkly manages the [runtime](/docs/runtimes) environment for your JavaScript code in browser checks and setup & teardown scripts. If the checks in this group need a runtime different from your account default, you can set that here. | ||
|
||
# Adding or removing checks from groups | ||
## Adding or removing checks from groups | ||
|
||
* **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. | ||
|
||
|
@@ -71,7 +73,7 @@ Checkly manages the [runtime](/docs/runtimes) environment for your JavaScript co | |
> [!WARNING] | ||
> To prevent issues (e.g. broken references to group variables), the check will be automatically deactivated after being added to or removed from a group. Make sure to review its settings before reactivating. | ||
|
||
# How we run grouped checks | ||
## How we run grouped checks | ||
|
||
It helps to understand how we run the checks in a group, specifically if you're doing more sophisticated checks with shared | ||
variables, script and alerting channels. Here are the rules: | ||
|
@@ -82,5 +84,19 @@ variables, script and alerting channels. Here are the rules: | |
4. There are no results or metrics collected at the group level. | ||
5. Checks in a group still have their individual scheduling settings. | ||
|
||
As you can see, groups in their current incarnation are mostly handy configuration buckets for common properties. In the | ||
future we will expand the group features to make them smarter. | ||
As you can see, groups in their current incarnation are mostly handy configuration buckets for common properties. In the future we will expand the group features to make them smarter. | ||
|
||
## Mixing Different Monitor Types in a Group | ||
|
||
When you purchase a plan in Checkly, it comes with certain feature entitlements, which you can review on our [pricing page](https://www.checklyhq.com/pricing/). These entitlements differ by monitor type: | ||
|
||
* Synthetic checks (e.g. API, Multistep, Browser, Playwright Check Suites) | ||
* Uptime monitors (e.g. URL, TCP, DNS) | ||
|
||
This means checks and monitors on the same plan may not all have access to the same features. For example: An API check might support `parallel` scheduling, while a TCP monitor only allows for `round-robin` scheduling. | ||
|
||
Groups let you organize any type of checks/monitors together and define shared settings. If those shared settings aren’t supported by all monitors in the group, Checkly will throw a validation error asking you to either adjust the setting or remove the incompatible monitor. | ||
|
||
Example: If your plan only allows `round-robin` for uptime monitors and you configure the group with `parallel` scheduling, you’ll see an error. To resolve it, switch to `round-robin`, move uptime monitors into a separate group, or upgrade your plan. | ||
|
||
If you’re unsure how to proceed, don’t hesitate to reach out to our [support team](mailto:[email protected]), we’re happy to help. |
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.