checkly 6.9.4 → 6.9.5-prerelease-3810aa7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/constructs/alert-channel.d.ts +1 -2
- package/dist/constructs/alert-channel.js +1 -2
- package/dist/constructs/alert-channel.js.map +1 -1
- package/dist/constructs/api-assertion.d.ts +1 -1
- package/dist/constructs/api-assertion.js +1 -1
- package/dist/constructs/api-check.d.ts +3 -61
- package/dist/constructs/api-check.js +3 -61
- package/dist/constructs/api-check.js.map +1 -1
- package/dist/constructs/browser-check.d.ts +3 -3
- package/dist/constructs/browser-check.js +3 -3
- package/dist/constructs/check-group-v2.d.ts +1 -1
- package/dist/constructs/check.d.ts +4 -4
- package/dist/constructs/dashboard.d.ts +3 -3
- package/dist/constructs/dashboard.js +1 -1
- package/dist/constructs/dns-monitor.d.ts +1 -1
- package/dist/constructs/dns-monitor.js +1 -1
- package/dist/constructs/email-alert-channel.d.ts +1 -1
- package/dist/constructs/email-alert-channel.js +1 -1
- package/dist/constructs/frequency.d.ts +1 -1
- package/dist/constructs/frequency.js +1 -1
- package/dist/constructs/heartbeat-monitor.d.ts +1 -1
- package/dist/constructs/heartbeat-monitor.js +1 -1
- package/dist/constructs/incidentio-alert-channel.d.ts +3 -3
- package/dist/constructs/incidentio-alert-channel.js +1 -1
- package/dist/constructs/maintenance-window.d.ts +1 -1
- package/dist/constructs/maintenance-window.js +1 -1
- package/dist/constructs/monitor.d.ts +1 -1
- package/dist/constructs/msteams-alert-channel.d.ts +1 -1
- package/dist/constructs/multi-step-check.d.ts +1 -1
- package/dist/constructs/multi-step-check.js +1 -1
- package/dist/constructs/opsgenie-alert-channel.d.ts +1 -1
- package/dist/constructs/phone-call-alert-channel.d.ts +2 -3
- package/dist/constructs/phone-call-alert-channel.js +2 -3
- package/dist/constructs/phone-call-alert-channel.js.map +1 -1
- package/dist/constructs/playwright-check.d.ts +2 -2
- package/dist/constructs/playwright-check.js +2 -2
- package/dist/constructs/private-location.d.ts +1 -1
- package/dist/constructs/private-location.js +1 -1
- package/dist/constructs/slack-alert-channel.d.ts +1 -1
- package/dist/constructs/slack-alert-channel.js +1 -1
- package/dist/constructs/sms-alert-channel.d.ts +1 -1
- package/dist/constructs/sms-alert-channel.js +1 -1
- package/dist/constructs/status-page-service.d.ts +1 -1
- package/dist/constructs/status-page-service.js +1 -1
- package/dist/constructs/status-page.d.ts +1 -1
- package/dist/constructs/status-page.js +1 -1
- package/dist/constructs/tcp-monitor.d.ts +1 -1
- package/dist/constructs/tcp-monitor.js +1 -1
- package/dist/constructs/telegram-alert-channel.d.ts +2 -2
- package/dist/constructs/url-assertion.d.ts +1 -1
- package/dist/constructs/url-assertion.js +1 -1
- package/dist/constructs/url-monitor.d.ts +3 -3
- package/dist/constructs/url-monitor.js +3 -3
- package/dist/constructs/webhook-alert-channel.d.ts +2 -2
- package/dist/constructs/webhook-alert-channel.js +1 -1
- package/dist/rules/checkly.rules.md +43 -21
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/oclif.manifest.json +1 -1
- package/package.json +1 -1
|
@@ -30,7 +30,7 @@ const RE_SLUG = /^((?!((us(-gov)?|ap|ca|cn|eu|sa|af|me)-(central|(north|south)?(
|
|
|
30
30
|
*
|
|
31
31
|
* This class make use of the Private Location endpoints.
|
|
32
32
|
*
|
|
33
|
-
* {@link https://www.checklyhq.com/docs/
|
|
33
|
+
* {@link https://www.checklyhq.com/docs/constructs/private-location/ Read more in the docs}
|
|
34
34
|
*/
|
|
35
35
|
class PrivateLocation extends construct_1.Construct {
|
|
36
36
|
name;
|
|
@@ -19,7 +19,7 @@ export declare class SlackAlertChannel extends AlertChannel {
|
|
|
19
19
|
* @param logicalId unique project-scoped resource name identification
|
|
20
20
|
* @param props Slack alert channel configuration properties
|
|
21
21
|
*
|
|
22
|
-
* {@link https://checklyhq.com/docs/
|
|
22
|
+
* {@link https://www.checklyhq.com/docs/constructs/slack-alert-channel/ Read more in the docs}
|
|
23
23
|
*/
|
|
24
24
|
constructor(logicalId: string, props: SlackAlertChannelProps);
|
|
25
25
|
describe(): string;
|
|
@@ -19,7 +19,7 @@ class SlackAlertChannel extends alert_channel_1.AlertChannel {
|
|
|
19
19
|
* @param logicalId unique project-scoped resource name identification
|
|
20
20
|
* @param props Slack alert channel configuration properties
|
|
21
21
|
*
|
|
22
|
-
* {@link https://checklyhq.com/docs/
|
|
22
|
+
* {@link https://www.checklyhq.com/docs/constructs/slack-alert-channel/ Read more in the docs}
|
|
23
23
|
*/
|
|
24
24
|
constructor(logicalId, props) {
|
|
25
25
|
super(logicalId, props);
|
|
@@ -25,7 +25,7 @@ export declare class SmsAlertChannel extends AlertChannel {
|
|
|
25
25
|
* @param logicalId unique project-scoped resource name identification
|
|
26
26
|
* @param props SMS alert channel configuration properties
|
|
27
27
|
*
|
|
28
|
-
* {@link https://checklyhq.com/docs/
|
|
28
|
+
* {@link https://www.checklyhq.com/docs/constructs/sms-alert-channel/ Read more in the docs}
|
|
29
29
|
*/
|
|
30
30
|
constructor(logicalId: string, props: SmsAlertChannelProps);
|
|
31
31
|
describe(): string;
|
|
@@ -19,7 +19,7 @@ class SmsAlertChannel extends alert_channel_1.AlertChannel {
|
|
|
19
19
|
* @param logicalId unique project-scoped resource name identification
|
|
20
20
|
* @param props SMS alert channel configuration properties
|
|
21
21
|
*
|
|
22
|
-
* {@link https://checklyhq.com/docs/
|
|
22
|
+
* {@link https://www.checklyhq.com/docs/constructs/sms-alert-channel/ Read more in the docs}
|
|
23
23
|
*/
|
|
24
24
|
constructor(logicalId, props) {
|
|
25
25
|
super(logicalId, props);
|
|
@@ -27,7 +27,7 @@ export declare class StatusPageService extends Construct {
|
|
|
27
27
|
* @param logicalId unique project-scoped resource name identification
|
|
28
28
|
* @param props status page service configuration properties
|
|
29
29
|
*
|
|
30
|
-
* {@link https://checklyhq.com/docs/
|
|
30
|
+
* {@link https://www.checklyhq.com/docs/constructs/status-page-service/ Read more in the docs}
|
|
31
31
|
*/
|
|
32
32
|
constructor(logicalId: string, props: StatusPageServiceProps);
|
|
33
33
|
describe(): string;
|
|
@@ -33,7 +33,7 @@ class StatusPageService extends construct_1.Construct {
|
|
|
33
33
|
* @param logicalId unique project-scoped resource name identification
|
|
34
34
|
* @param props status page service configuration properties
|
|
35
35
|
*
|
|
36
|
-
* {@link https://checklyhq.com/docs/
|
|
36
|
+
* {@link https://www.checklyhq.com/docs/constructs/status-page-service/ Read more in the docs}
|
|
37
37
|
*/
|
|
38
38
|
constructor(logicalId, props) {
|
|
39
39
|
super(StatusPageService.__checklyType, logicalId);
|
|
@@ -64,7 +64,7 @@ export declare class StatusPage extends Construct {
|
|
|
64
64
|
* @param logicalId unique project-scoped resource name identification
|
|
65
65
|
* @param props status page configuration properties
|
|
66
66
|
*
|
|
67
|
-
* {@link https://checklyhq.com/docs/
|
|
67
|
+
* {@link https://www.checklyhq.com/docs/constructs/status-page/ Read more in the docs}
|
|
68
68
|
*/
|
|
69
69
|
constructor(logicalId: string, props: StatusPageProps);
|
|
70
70
|
describe(): string;
|
|
@@ -23,7 +23,7 @@ class StatusPage extends construct_1.Construct {
|
|
|
23
23
|
* @param logicalId unique project-scoped resource name identification
|
|
24
24
|
* @param props status page configuration properties
|
|
25
25
|
*
|
|
26
|
-
* {@link https://checklyhq.com/docs/
|
|
26
|
+
* {@link https://www.checklyhq.com/docs/constructs/status-page/ Read more in the docs}
|
|
27
27
|
*/
|
|
28
28
|
constructor(logicalId, props) {
|
|
29
29
|
super(StatusPage.__checklyType, logicalId);
|
|
@@ -117,7 +117,7 @@ export declare class TcpMonitor extends Monitor {
|
|
|
117
117
|
* @param logicalId unique project-scoped resource name identification
|
|
118
118
|
* @param props configuration properties
|
|
119
119
|
*
|
|
120
|
-
* {@link https://checklyhq.com/docs/
|
|
120
|
+
* {@link https://www.checklyhq.com/docs/constructs/tcp-monitor/ Read more in the docs}
|
|
121
121
|
*/
|
|
122
122
|
constructor(logicalId: string, props: TcpMonitorProps);
|
|
123
123
|
describe(): string;
|
|
@@ -51,7 +51,7 @@ class TcpMonitor extends monitor_1.Monitor {
|
|
|
51
51
|
* @param logicalId unique project-scoped resource name identification
|
|
52
52
|
* @param props configuration properties
|
|
53
53
|
*
|
|
54
|
-
* {@link https://checklyhq.com/docs/
|
|
54
|
+
* {@link https://www.checklyhq.com/docs/constructs/tcp-monitor/ Read more in the docs}
|
|
55
55
|
*/
|
|
56
56
|
constructor(logicalId, props) {
|
|
57
57
|
super(logicalId, props);
|
|
@@ -7,12 +7,12 @@ export interface TelegramAlertChannelProps extends AlertChannelProps {
|
|
|
7
7
|
name: string;
|
|
8
8
|
/**
|
|
9
9
|
* The chat ID of your Telegram bot.
|
|
10
|
-
* {@link https://www.checklyhq.com/docs/integrations/telegram/}
|
|
10
|
+
* {@link https://www.checklyhq.com/docs/integrations/alerts/telegram/}
|
|
11
11
|
*/
|
|
12
12
|
chatId: string;
|
|
13
13
|
/**
|
|
14
14
|
* The API key for your Telegram bot.
|
|
15
|
-
* {@link https://www.checklyhq.com/docs/integrations/telegram/}
|
|
15
|
+
* {@link https://www.checklyhq.com/docs/integrations/alerts/telegram/}
|
|
16
16
|
*/
|
|
17
17
|
apiKey: string;
|
|
18
18
|
/**
|
|
@@ -37,7 +37,7 @@ export type UrlAssertion = CoreAssertion<UrlAssertionSource>;
|
|
|
37
37
|
* UrlAssertionBuilder.statusCode().lessThan(600)
|
|
38
38
|
* ```
|
|
39
39
|
*
|
|
40
|
-
* @see {@link https://www.checklyhq.com/docs/url-monitors/ | URL Monitors Documentation}
|
|
40
|
+
* @see {@link https://www.checklyhq.com/docs/detect/uptime-monitoring/url-monitors/overview/ | URL Monitors Documentation}
|
|
41
41
|
*/
|
|
42
42
|
export declare class UrlAssertionBuilder {
|
|
43
43
|
/**
|
|
@@ -30,7 +30,7 @@ const assertion_1 = require("./internal/assertion");
|
|
|
30
30
|
* UrlAssertionBuilder.statusCode().lessThan(600)
|
|
31
31
|
* ```
|
|
32
32
|
*
|
|
33
|
-
* @see {@link https://www.checklyhq.com/docs/url-monitors/ | URL Monitors Documentation}
|
|
33
|
+
* @see {@link https://www.checklyhq.com/docs/detect/uptime-monitoring/url-monitors/overview/ | URL Monitors Documentation}
|
|
34
34
|
*/
|
|
35
35
|
class UrlAssertionBuilder {
|
|
36
36
|
/**
|
|
@@ -93,8 +93,8 @@ export interface UrlMonitorProps extends MonitorProps {
|
|
|
93
93
|
* })
|
|
94
94
|
* ```
|
|
95
95
|
*
|
|
96
|
-
* @see {@link https://www.checklyhq.com/docs/
|
|
97
|
-
* @see {@link https://www.checklyhq.com/docs/url-monitors/ | URL Monitors Documentation}
|
|
96
|
+
* @see {@link https://www.checklyhq.com/docs/constructs/url-monitor/ | UrlMonitor API Reference}
|
|
97
|
+
* @see {@link https://www.checklyhq.com/docs/detect/uptime-monitoring/url-monitors/overview/ | URL Monitors Documentation}
|
|
98
98
|
*/
|
|
99
99
|
export declare class UrlMonitor extends Monitor {
|
|
100
100
|
readonly request: UrlRequest;
|
|
@@ -106,7 +106,7 @@ export declare class UrlMonitor extends Monitor {
|
|
|
106
106
|
* @param logicalId unique project-scoped resource name identification
|
|
107
107
|
* @param props configuration properties
|
|
108
108
|
*
|
|
109
|
-
* {@link https://checklyhq.com/docs/
|
|
109
|
+
* {@link https://www.checklyhq.com/docs/constructs/url-monitor/ Read more in the docs}
|
|
110
110
|
*/
|
|
111
111
|
constructor(logicalId: string, props: UrlMonitorProps);
|
|
112
112
|
describe(): string;
|
|
@@ -59,8 +59,8 @@ const project_1 = require("./project");
|
|
|
59
59
|
* })
|
|
60
60
|
* ```
|
|
61
61
|
*
|
|
62
|
-
* @see {@link https://www.checklyhq.com/docs/
|
|
63
|
-
* @see {@link https://www.checklyhq.com/docs/url-monitors/ | URL Monitors Documentation}
|
|
62
|
+
* @see {@link https://www.checklyhq.com/docs/constructs/url-monitor/ | UrlMonitor API Reference}
|
|
63
|
+
* @see {@link https://www.checklyhq.com/docs/detect/uptime-monitoring/url-monitors/overview/ | URL Monitors Documentation}
|
|
64
64
|
*/
|
|
65
65
|
class UrlMonitor extends monitor_1.Monitor {
|
|
66
66
|
request;
|
|
@@ -72,7 +72,7 @@ class UrlMonitor extends monitor_1.Monitor {
|
|
|
72
72
|
* @param logicalId unique project-scoped resource name identification
|
|
73
73
|
* @param props configuration properties
|
|
74
74
|
*
|
|
75
|
-
* {@link https://checklyhq.com/docs/
|
|
75
|
+
* {@link https://www.checklyhq.com/docs/constructs/url-monitor/ Read more in the docs}
|
|
76
76
|
*/
|
|
77
77
|
constructor(logicalId, props) {
|
|
78
78
|
super(logicalId, props);
|
|
@@ -14,7 +14,7 @@ export interface WebhookAlertChannelProps extends AlertChannelProps {
|
|
|
14
14
|
url: URL | string;
|
|
15
15
|
/**
|
|
16
16
|
* This is commonly a JSON body. You can
|
|
17
|
-
* use {@link https://www.checklyhq.com/docs/
|
|
17
|
+
* use {@link https://www.checklyhq.com/docs/communicate/alerts/webhooks/#using-variables | Handlebars-style template variables}
|
|
18
18
|
* to add custom data to the template.
|
|
19
19
|
*/
|
|
20
20
|
template?: string;
|
|
@@ -60,7 +60,7 @@ export declare class WebhookAlertChannel extends AlertChannel {
|
|
|
60
60
|
* @param logicalId unique project-scoped resource name identification
|
|
61
61
|
* @param props Webhook alert channel configuration properties
|
|
62
62
|
*
|
|
63
|
-
* {@link https://checklyhq.com/docs/
|
|
63
|
+
* {@link https://www.checklyhq.com/docs/constructs/webhook-alert-channel/ Read more in the docs}
|
|
64
64
|
*/
|
|
65
65
|
constructor(logicalId: string, props: WebhookAlertChannelProps);
|
|
66
66
|
describe(): string;
|
|
@@ -25,7 +25,7 @@ class WebhookAlertChannel extends alert_channel_1.AlertChannel {
|
|
|
25
25
|
* @param logicalId unique project-scoped resource name identification
|
|
26
26
|
* @param props Webhook alert channel configuration properties
|
|
27
27
|
*
|
|
28
|
-
* {@link https://checklyhq.com/docs/
|
|
28
|
+
* {@link https://www.checklyhq.com/docs/constructs/webhook-alert-channel/ Read more in the docs}
|
|
29
29
|
*/
|
|
30
30
|
constructor(logicalId, props) {
|
|
31
31
|
super(logicalId, props);
|
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
|
|
3
3
|
- Refer to docs for Checkly CLI v6.0.0 and above.
|
|
4
4
|
- Check the Checkly CLI output to figure out into which folder the setup was generated.
|
|
5
|
-
- Use the [Checkly CLI reference documentation](https://www.checklyhq.com/docs/cli/
|
|
6
|
-
- Use the [Checkly construct reference documentation](https://www.checklyhq.com/docs/
|
|
7
|
-
- Import and / or require any constructs you need in your code, such as `ApiCheck`, `BrowserCheck` from the `checkly/constructs` package.
|
|
5
|
+
- Use the [Checkly CLI reference documentation](https://www.checklyhq.com/docs/cli/overview/).
|
|
6
|
+
- Use the [Checkly construct reference documentation](https://www.checklyhq.com/docs/constructs/overview/).
|
|
7
|
+
- Import and / or require any constructs you need in your code, such as `ApiCheck`, `BrowserCheck`, or `PlaywrightCheck` from the `checkly/constructs` package.
|
|
8
8
|
- Always ground generated code and CLI commands against the official documentation and examples in this file.
|
|
9
9
|
|
|
10
10
|
## Installing the Checkly CLI
|
|
@@ -38,8 +38,8 @@ The `checkly.config.ts` at the root of your project defines a range of defaults
|
|
|
38
38
|
### API Check
|
|
39
39
|
|
|
40
40
|
- Import the `ApiCheck` construct from `checkly/constructs`.
|
|
41
|
-
- Reference [the docs for API checks](https://www.checklyhq.com/docs/
|
|
42
|
-
- When adding `assertions`, always use `AssertionBuilder` class for API Checks
|
|
41
|
+
- Reference [the docs for API checks](https://www.checklyhq.com/docs/constructs/api-check/) before generating any code.
|
|
42
|
+
- When adding `assertions`, always use `AssertionBuilder` class for API Checks.
|
|
43
43
|
- When referencing environment variables always use the handlebar syntax `{{MY_ENV_VAR}}`.
|
|
44
44
|
- When referencing secrets always use the handlebar syntax `{{MY_SECRET}}`.
|
|
45
45
|
- If endpoints require authentication ask the user which authentication method to use and then generate a setupScript to authenticate the given requests.
|
|
@@ -100,7 +100,7 @@ new ApiCheck('example-api-check', {
|
|
|
100
100
|
### Browser Check
|
|
101
101
|
|
|
102
102
|
- Import the `BrowserCheck` construct from `checkly/constructs`.
|
|
103
|
-
- Reference [the docs for Browser checks](https://www.checklyhq.com/docs/
|
|
103
|
+
- Reference [the docs for Browser checks](https://www.checklyhq.com/docs/constructs/browser-check/) before generating any code.
|
|
104
104
|
- Generate a separate `.spec.ts` file for the Playwright code referenced in the `BrowserCheck` construct.
|
|
105
105
|
- Use the `code.entrypoint` property to specify the path to your Playwright test file.
|
|
106
106
|
|
|
@@ -138,10 +138,26 @@ new BrowserCheck('example-browser-check', {
|
|
|
138
138
|
|
|
139
139
|
```
|
|
140
140
|
|
|
141
|
+
### Playwright Check Suite
|
|
142
|
+
|
|
143
|
+
- Import the `PlaywrightCheck` construct from `checkly/constructs`.
|
|
144
|
+
- Reference [the docs for Playwright Check Suites](https://www.checklyhq.com/docs/constructs/playwright-check/) before generating any code.
|
|
145
|
+
- use `pwProjects` if your tasked to reuse a Playwright project.
|
|
146
|
+
|
|
147
|
+
```typescript
|
|
148
|
+
const playwrightChecks = new PlaywrightCheck("multi-browser-check", {
|
|
149
|
+
name: "Multi-browser check suite",
|
|
150
|
+
playwrightConfigPath: "./playwright.config.ts",
|
|
151
|
+
// Playwright Check Suites support all browsers
|
|
152
|
+
// defined in your `playwight.config`
|
|
153
|
+
pwProjects: ["chromium", "firefox", "webkit"],
|
|
154
|
+
});
|
|
155
|
+
```
|
|
156
|
+
|
|
141
157
|
### MultiStep Check
|
|
142
158
|
|
|
143
159
|
- Import the `MultiStepCheck` construct from `checkly/constructs`.
|
|
144
|
-
- Reference [the docs for Multistep checks](https://www.checklyhq.com/docs/
|
|
160
|
+
- Reference [the docs for Multistep checks](https://www.checklyhq.com/docs/constructs/multistep-check/) before generating any code.
|
|
145
161
|
- Generate a separate `.spec.ts` file for the Playwright code referenced in the `MultiStepCheck` construct.
|
|
146
162
|
- Use the `code.entrypoint` property to specify the path to your Playwright test file.
|
|
147
163
|
|
|
@@ -177,8 +193,8 @@ new MultiStepCheck('example-multi-step-check', {
|
|
|
177
193
|
### TCP Monitor
|
|
178
194
|
|
|
179
195
|
- Import the `TcpMonitor` construct from `checkly/constructs`.
|
|
180
|
-
- Reference [the docs for TCP monitors](https://www.checklyhq.com/docs/
|
|
181
|
-
- When adding `assertions`, always use `TcpAssertionBuilder` class for TCP monitors
|
|
196
|
+
- Reference [the docs for TCP monitors](https://www.checklyhq.com/docs/constructs/tcp-monitor/) before generating any code.
|
|
197
|
+
- When adding `assertions`, always use `TcpAssertionBuilder` class for TCP monitors.
|
|
182
198
|
|
|
183
199
|
```typescript
|
|
184
200
|
import { AlertEscalationBuilder, Frequency, RetryStrategyBuilder, TcpAssertionBuilder, TcpMonitor } from 'checkly/constructs'
|
|
@@ -225,8 +241,8 @@ new TcpMonitor('example-tcp-monitor', {
|
|
|
225
241
|
### URL Monitor
|
|
226
242
|
|
|
227
243
|
- Import the `UrlMonitor` construct from `checkly/constructs`.
|
|
228
|
-
- Reference [the docs for URL monitors](https://www.checklyhq.com/docs/
|
|
229
|
-
- When adding `assertions`, always use `UrlAssertionBuilder
|
|
244
|
+
- Reference [the docs for URL monitors](https://www.checklyhq.com/docs/constructs/url-monitor/) before generating any code.
|
|
245
|
+
- When adding `assertions`, always use `UrlAssertionBuilder`.
|
|
230
246
|
|
|
231
247
|
```typescript
|
|
232
248
|
import { AlertEscalationBuilder, Frequency, RetryStrategyBuilder, UrlAssertionBuilder, UrlMonitor } from 'checkly/constructs'
|
|
@@ -271,8 +287,8 @@ new UrlMonitor('example-url-monitor', {
|
|
|
271
287
|
### DNS Monitor
|
|
272
288
|
|
|
273
289
|
- Import the `DnsMonitor` construct from `checkly/constructs`.
|
|
274
|
-
- Reference [the docs for DNS monitors](https://www.checklyhq.com/docs/
|
|
275
|
-
- When adding `assertions`, always use `DnsAssertionBuilder` class
|
|
290
|
+
- Reference [the docs for DNS monitors](https://www.checklyhq.com/docs/constructs/dns-monitor/) before generating any code.
|
|
291
|
+
- When adding `assertions`, always use `DnsAssertionBuilder` class.
|
|
276
292
|
|
|
277
293
|
```typescript
|
|
278
294
|
import { AlertEscalationBuilder, DnsAssertionBuilder, DnsMonitor, Frequency, RetryStrategyBuilder } from 'checkly/constructs'
|
|
@@ -312,7 +328,7 @@ new DnsMonitor('example-dns-monitor', {
|
|
|
312
328
|
### Heartbeat Monitor
|
|
313
329
|
|
|
314
330
|
- Import the `HeartbeatMonitor` construct from `checkly/constructs`.
|
|
315
|
-
- Reference [the docs for Heartbeat monitor](https://www.checklyhq.com/docs/
|
|
331
|
+
- Reference [the docs for Heartbeat monitor](https://www.checklyhq.com/docs/constructs/heartbeat-monitor/) before generating any code.
|
|
316
332
|
|
|
317
333
|
```typescript
|
|
318
334
|
import { AlertEscalationBuilder, Frequency, HeartbeatMonitor, RetryStrategyBuilder } from 'checkly/constructs'
|
|
@@ -348,7 +364,7 @@ new HeartbeatMonitor('example-heartbeat-monitor', {
|
|
|
348
364
|
### Check Group
|
|
349
365
|
|
|
350
366
|
- Import the `CheckGroupV2` construct from `checkly/constructs`.
|
|
351
|
-
- Reference [the docs for Check Groups](https://www.checklyhq.com/docs/
|
|
367
|
+
- Reference [the docs for Check Groups](https://www.checklyhq.com/docs/constructs/check-group-v2/) before generating any code.
|
|
352
368
|
- Check Groups are used to group checks together for easier management and organization.
|
|
353
369
|
- Checks are added to Check Groups by referencing the group in the `group` property of a check.
|
|
354
370
|
|
|
@@ -366,10 +382,12 @@ export const exampleGroup = new CheckGroupV2('example-group', {
|
|
|
366
382
|
- Alert channels are used to send notifications when checks and monitors fail or recover.
|
|
367
383
|
- Alert channels are added to checks, monitors, and check groups constructs by adding them to the `alertChannels` array property.
|
|
368
384
|
|
|
369
|
-
Here are some examples of how to create different types of alert channels. All alert are described in the [Checkly docs](https://www.checklyhq.com/docs/
|
|
385
|
+
Here are some examples of how to create different types of alert channels. All alert are described in the [Checkly docs](https://www.checklyhq.com/docs/constructs/overview/).
|
|
370
386
|
|
|
371
387
|
### Email Alert Channel
|
|
372
388
|
|
|
389
|
+
- Reference [the docs for Email Alert Channels](https://www.checklyhq.com/docs/constructs/email-alert-channel/) before generating any code.
|
|
390
|
+
|
|
373
391
|
```typescript
|
|
374
392
|
import { EmailAlertChannel } from 'checkly/constructs'
|
|
375
393
|
|
|
@@ -383,6 +401,8 @@ export const testEmailAlert = new EmailAlertChannel('example-email-alert-channel
|
|
|
383
401
|
|
|
384
402
|
### Phone Call Alert Channel
|
|
385
403
|
|
|
404
|
+
- Reference [the docs for Phone Call Alert Channels](https://www.checklyhq.com/docs/constructs/phone-call-alert-channel/) before generating any code.
|
|
405
|
+
|
|
386
406
|
```typescript
|
|
387
407
|
import { PhoneCallAlertChannel } from 'checkly/constructs'
|
|
388
408
|
|
|
@@ -396,6 +416,8 @@ export const testUserPhoneCallAlert = new PhoneCallAlertChannel('example-call-al
|
|
|
396
416
|
|
|
397
417
|
### Slack Alert Channel
|
|
398
418
|
|
|
419
|
+
- Reference [the docs for Slack Alert Channels](https://www.checklyhq.com/docs/constructs/slack-alert-channel/) before generating any code.
|
|
420
|
+
|
|
399
421
|
```typescript
|
|
400
422
|
import { SlackAlertChannel } from 'checkly/constructs'
|
|
401
423
|
|
|
@@ -412,7 +434,7 @@ export const generalSlackAlert = new SlackAlertChannel('example-slack-alert-chan
|
|
|
412
434
|
### Status Page
|
|
413
435
|
|
|
414
436
|
- Import the `StatusPage` construct from `checkly/constructs`.
|
|
415
|
-
- Reference [the docs for StatusPages](https://www.checklyhq.com/docs/
|
|
437
|
+
- Reference [the docs for StatusPages](https://www.checklyhq.com/docs/constructs/status-page/) before generating any code.
|
|
416
438
|
- Status pages are used to display the status of your services to your users.
|
|
417
439
|
- A Status Page consists of cards which include Status Page Services.
|
|
418
440
|
|
|
@@ -440,7 +462,7 @@ new StatusPage('example-status-page', {
|
|
|
440
462
|
### Status Page Service
|
|
441
463
|
|
|
442
464
|
- Import the `StatusPageService` construct from `checkly/constructs`.
|
|
443
|
-
- Reference [the docs for Status Page Services](https://www.checklyhq.com/docs/
|
|
465
|
+
- Reference [the docs for Status Page Services](https://www.checklyhq.com/docs/constructs/status-page-service/) before generating any code.
|
|
444
466
|
- Status Page Services are used to represent individual services on a Status Page.
|
|
445
467
|
|
|
446
468
|
```typescript
|
|
@@ -455,7 +477,7 @@ export const exampleService = new StatusPageService('example-status-page-service
|
|
|
455
477
|
### Dashboard
|
|
456
478
|
|
|
457
479
|
- Import the `Dashboard` construct from `checkly/constructs`.
|
|
458
|
-
- Reference [the docs for Dashboards](https://www.checklyhq.com/docs/
|
|
480
|
+
- Reference [the docs for Dashboards](https://www.checklyhq.com/docs/constructs/dashboard/) before generating any code.
|
|
459
481
|
- Dashboards are used to display the results of your checks on screens external to Checkly.
|
|
460
482
|
|
|
461
483
|
```typescript
|
|
@@ -489,7 +511,7 @@ new Dashboard('example-dashboard', {
|
|
|
489
511
|
### Maintenance Window
|
|
490
512
|
|
|
491
513
|
- Import the `MaintenanceWindow` construct from `checkly/constructs`.
|
|
492
|
-
- Reference [the docs for Maintenance Windows](https://www.checklyhq.com/docs/
|
|
514
|
+
- Reference [the docs for Maintenance Windows](https://www.checklyhq.com/docs/constructs/maintenance-window/) before generating any code.
|
|
493
515
|
- Maintenance windows are used to pause checks during maintenance periods so no alerts are sent.
|
|
494
516
|
- Checks are referenced by their tags in the `tags` property.
|
|
495
517
|
|
|
@@ -513,7 +535,7 @@ new MaintenanceWindow('example-maintenance-window', {
|
|
|
513
535
|
### Private Location
|
|
514
536
|
|
|
515
537
|
- Import the `PrivateLocation` construct from `checkly/constructs`.
|
|
516
|
-
- Reference [the docs for Private Locations](https://www.checklyhq.com/docs/
|
|
538
|
+
- Reference [the docs for Private Locations](https://www.checklyhq.com/docs/constructs/private-location/) before generating any code.
|
|
517
539
|
- Private locations are used to run checks from your own infrastructure with the Checkly Agent, an OCI compatible container.
|
|
518
540
|
|
|
519
541
|
```typescript
|