-
Notifications
You must be signed in to change notification settings - Fork 9
Clean up alert channel constructs and add back missing ones #233
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
Merged
Merged
Changes from 15 commits
Commits
Show all changes
23 commits
Select commit
Hold shift + click to select a range
d7b7a14
fix: add back missing CLI alert channel constructs
guolau ac22b85
fix: added back general AlertChannel information and link back to new…
guolau 34919e7
feat: remove unverified AI content from EmailAlertChannel page
guolau b04185e
feat: remove unverified AI content from SmsAlertChannel page
guolau 856322e
feat: improve wording of SMS supported countries link
guolau 31ce2fb
feat: remove unverified AI content from PhoneCallAlertChannel page
guolau ece74d5
feat: remove unverified AI content from SlackAlertChannel page
guolau a584638
feat: remove unverified AI content from WebhookAlertChannel page
guolau 60658f5
feat: replace WebhookAlertChannel basic example with a simpler one
guolau 3ca8b2b
qclear
guolau 5bec2e5
feat: updated example payloads for MS Teams and Incident.io channels
guolau 40facec
feat: removed redundant 'Alert Channel' from constructs sidebar
guolau 5e8daac
feat: remove redundant/unnecessary simple code examples
guolau 7bb809e
Merge branch 'main' into guolau/add-missing-cli-constructs
guolau 35ae9b1
Merge branch 'main' into guolau/add-missing-cli-constructs
guolau d66d04c
Remove redundant Tabs section from alert channel construct pages
guolau d02cb8c
Make long MS Teams code snippets collapsed by default
guolau 854a1f8
Fix broken Handlebars link on webhook alert channel construct page
guolau f847149
Add alert channel assignment example
guolau 10d438a
Restructure fromId() explanation
guolau 6cfebff
Merge branch 'main' into guolau/add-missing-cli-constructs
guolau e67eff5
Minor update to fromId() wording
guolau fbb49c0
Merge branch 'guolau/add-missing-cli-constructs' of github.com:checkl…
guolau 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| --- | ||
| title: 'Alert Channel Overview' | ||
| description: 'Learn how to configure alert channels with the Checkly CLI.' | ||
| sidebarTitle: 'Overview' | ||
| --- | ||
|
|
||
| import AlertChannelOptionsTable from '/snippets/alert-channel-options-table.mdx'; | ||
|
|
||
| Alert channels let you get alert notifications when a check or monitor fails. [Learn more about alerting in our docs](/communicate/alerts/overview/). | ||
|
|
||
| ## Common properties | ||
|
|
||
| All alert channels share a set of common properties to define when / how they should alert derived from the abstract class | ||
| `AlertChannel`. | ||
|
|
||
| <AlertChannelOptionsTable /> | ||
|
|
||
| Alert channels are assigned to checks, monitors, and groups by instantiating a class and adding the resulting object to the | ||
| `alertChannels` array. | ||
|
|
||
| To assign alert channels to `CheckGroupV2` constructs, you'll also need to set the [`alertEscalationPolicy`](/constructs/check-group-v2#param-alert-escalation-policy) to enable the group alerting override. | ||
|
|
||
| ## Using `fromId()` to reference an existing channel | ||
|
|
||
| You can reference an existing alert channel in your Checkly account using the `fromId()` method on any `AlertChannel` | ||
| class. When your CLI project is responsible for creating and managing alert channels, it integrates seamlessly with Checkly's deployment control mechanisms. This ensures that any changes made are thoroughly validated. | ||
|
guolau marked this conversation as resolved.
Outdated
|
||
|
|
||
| For users with multiple Checkly CLI projects: | ||
|
|
||
| - Alert channels can be set up through the Checkly UI or any other method, ensuring they remain intact and unaffected by individual CLI project operations. | ||
|
|
||
| For users managing a single Checkly CLI project: | ||
|
|
||
| - The entire process of creating and subscribing to alert channels can be handled within that single project. This is made possible because the project references the logical ID of the alert channel, rather than an ID generated post-deployment. | ||
|
|
||
| <Note> | ||
| If you attempt to deploy a project that references alert channels which have been removed or are no longer valid, the deployment process will not proceed. This feature helps maintain the integrity and reliability of your monitoring and alerting setup. | ||
| </Note> | ||
|
|
||
| ```ts | ||
| export const emailChannel = EmailAlertChannel.fromId(20) | ||
| ``` | ||
|
|
||
| You can obtain the ID for your alert channel either from the [Checkly web UI](https://app.checklyhq.com/accounts/alerts/settings) or by utilizing our [REST API](/api-reference/alert-channels/list-all-alert-channels/). | ||
|
|
||
|  | ||
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
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.