checkly 7.4.0 → 7.5.0
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/ai-context/checkly.rules.md +55 -17
- package/dist/ai-context/context.d.ts +76 -24
- package/dist/ai-context/context.js +48 -25
- package/dist/ai-context/context.js.map +1 -1
- package/dist/ai-context/public-skills/checkly/README.md +39 -0
- package/dist/ai-context/public-skills/checkly/SKILL.md +65 -0
- package/dist/ai-context/{skills/monitoring/references/api-checks.md → skills-command/references/configure-api-checks.md} +1 -1
- package/dist/ai-context/skills-command/references/configure-dns-monitors.md +38 -0
- package/dist/ai-context/skills-command/references/configure-heartbeat-monitors.md +33 -0
- package/dist/ai-context/skills-command/references/configure-icmp-monitors.md +41 -0
- package/dist/ai-context/skills-command/references/configure-tcp-monitors.md +45 -0
- package/dist/ai-context/skills-command/references/configure-url-monitors.md +43 -0
- package/dist/ai-context/{skills/monitoring/SKILL.md → skills-command/references/configure.md} +40 -17
- package/dist/ai-context/skills-command/references/initialize.md +116 -0
- package/dist/commands/baseCommand.d.ts +3 -0
- package/dist/commands/baseCommand.js +3 -0
- package/dist/commands/baseCommand.js.map +1 -1
- package/dist/commands/incidents/create.d.ts +15 -0
- package/dist/commands/incidents/create.js +107 -0
- package/dist/commands/incidents/create.js.map +1 -0
- package/dist/commands/incidents/list.d.ts +12 -0
- package/dist/commands/incidents/list.js +107 -0
- package/dist/commands/incidents/list.js.map +1 -0
- package/dist/commands/incidents/resolve.d.ts +14 -0
- package/dist/commands/incidents/resolve.js +87 -0
- package/dist/commands/incidents/resolve.js.map +1 -0
- package/dist/commands/incidents/update.d.ts +16 -0
- package/dist/commands/incidents/update.js +111 -0
- package/dist/commands/incidents/update.js.map +1 -0
- package/dist/commands/skills.d.ts +12 -0
- package/dist/commands/skills.js +104 -0
- package/dist/commands/skills.js.map +1 -0
- package/dist/formatters/incidents.d.ts +7 -0
- package/dist/formatters/incidents.js +186 -0
- package/dist/formatters/incidents.js.map +1 -0
- package/dist/help/help-extension.js +17 -6
- package/dist/help/help-extension.js.map +1 -1
- package/dist/helpers/cli-mode.d.ts +3 -0
- package/dist/helpers/cli-mode.js +46 -0
- package/dist/helpers/cli-mode.js.map +1 -0
- package/dist/helpers/command-preview.d.ts +24 -0
- package/dist/helpers/command-preview.js +51 -0
- package/dist/helpers/command-preview.js.map +1 -0
- package/dist/helpers/flags.d.ts +2 -0
- package/dist/helpers/flags.js +16 -1
- package/dist/helpers/flags.js.map +1 -1
- package/dist/helpers/incidents.d.ts +15 -0
- package/dist/helpers/incidents.js +58 -0
- package/dist/helpers/incidents.js.map +1 -0
- package/dist/rest/api.d.ts +2 -1
- package/dist/rest/api.js +5 -24
- package/dist/rest/api.js.map +1 -1
- package/dist/rest/incidents.d.ts +60 -0
- package/dist/rest/incidents.js +30 -0
- package/dist/rest/incidents.js.map +1 -0
- package/dist/rest/status-pages.d.ts +3 -0
- package/dist/rest/status-pages.js.map +1 -1
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/oclif.manifest.json +541 -110
- package/package.json +7 -1
- package/dist/ai-context/skills/monitoring/README.md +0 -55
- package/dist/ai-context/skills/monitoring/references/uptime-monitors.md +0 -206
- /package/dist/ai-context/{skills/monitoring/references/alert-channels.md → skills-command/references/configure-alert-channels.md} +0 -0
- /package/dist/ai-context/{skills/monitoring/references/browser-checks.md → skills-command/references/configure-browser-checks.md} +0 -0
- /package/dist/ai-context/{skills/monitoring/references/check-groups.md → skills-command/references/configure-check-groups.md} +0 -0
- /package/dist/ai-context/{skills/monitoring/references/multistep-checks.md → skills-command/references/configure-multistep-checks.md} +0 -0
- /package/dist/ai-context/{skills/monitoring/references/playwright-checks.md → skills-command/references/configure-playwright-checks.md} +0 -0
- /package/dist/ai-context/{skills/monitoring/references/supporting-constructs.md → skills-command/references/configure-supporting-constructs.md} +0 -0
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "checkly",
|
|
3
|
-
"version": "7.
|
|
3
|
+
"version": "7.5.0",
|
|
4
4
|
"description": "Checkly CLI",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
@@ -70,9 +70,15 @@
|
|
|
70
70
|
"env": {
|
|
71
71
|
"description": "Manage Checkly environment variables."
|
|
72
72
|
},
|
|
73
|
+
"incidents": {
|
|
74
|
+
"description": "Create and manage status page incidents."
|
|
75
|
+
},
|
|
73
76
|
"import": {
|
|
74
77
|
"description": "Import existing resources from your Checkly account to your project."
|
|
75
78
|
},
|
|
79
|
+
"skills": {
|
|
80
|
+
"description": "Explore Checkly AI agent skills, actions and reference documentation."
|
|
81
|
+
},
|
|
76
82
|
"status-pages": {
|
|
77
83
|
"description": "List and manage status pages in your Checkly account."
|
|
78
84
|
}
|
|
@@ -1,55 +0,0 @@
|
|
|
1
|
-
# Checkly CLI Monitoring Agent Skill
|
|
2
|
-
|
|
3
|
-
This directory contains the agent skill for creating and managing end-to-end testing, monitoring, & observability with an AI-native workflow using Checkly.
|
|
4
|
-
|
|
5
|
-
## Structure
|
|
6
|
-
|
|
7
|
-
```
|
|
8
|
-
skills/
|
|
9
|
-
└── monitoring/
|
|
10
|
-
├── README.md # Documentation about the skill
|
|
11
|
-
├── SKILL.md # Main skill instructions
|
|
12
|
-
└── references/ # Detailed construct documentation
|
|
13
|
-
├── api-checks.md
|
|
14
|
-
├── browser-checks.md
|
|
15
|
-
├── playwright-checks.md
|
|
16
|
-
├── multistep-checks.md
|
|
17
|
-
├── monitors.md
|
|
18
|
-
├── check-groups.md
|
|
19
|
-
├── alert-channels.md
|
|
20
|
-
└── supporting-constructs.md
|
|
21
|
-
```
|
|
22
|
-
|
|
23
|
-
## What is an Agent Skill?
|
|
24
|
-
|
|
25
|
-
Agent Skills are a standardized format for giving AI agents specialized knowledge and workflows. This skill teaches agents how to:
|
|
26
|
-
|
|
27
|
-
- Create and manage API checks, Browser Checks, URL monitors, and other monitors
|
|
28
|
-
- Set up Playwright-based Browser and Multistep checks and Playwright Check Suites
|
|
29
|
-
- Configure Heartbeat Monitors for cron jobs and scheduled tasks
|
|
30
|
-
- Define alert channels (email, Slack, phone, webhooks, etc.)
|
|
31
|
-
- Build dashboards and status pages
|
|
32
|
-
- Follow monitoring-as-code best practices with the Checkly CLI
|
|
33
|
-
|
|
34
|
-
## Using This Skill
|
|
35
|
-
|
|
36
|
-
AI agents can load this skill to gain expertise in Checkly monitoring. The skill follows the [Agent Skills specification](https://agentskills.io) with:
|
|
37
|
-
|
|
38
|
-
- **SKILL.md**: Core instructions loaded when the skill is activated
|
|
39
|
-
- **references/**: Detailed documentation loaded on demand
|
|
40
|
-
|
|
41
|
-
## Progressive Disclosure
|
|
42
|
-
|
|
43
|
-
The skill is structured for efficient context usage:
|
|
44
|
-
|
|
45
|
-
1. **Metadata** (~80 tokens): Name and description in frontmatter
|
|
46
|
-
2. **Core Instructions** (~1K tokens): Main SKILL.md content with links to references
|
|
47
|
-
3. **References** (loaded on demand): Detailed construct documentation with examples
|
|
48
|
-
|
|
49
|
-
Agents load what they need for each task.
|
|
50
|
-
|
|
51
|
-
## Learn More
|
|
52
|
-
|
|
53
|
-
- [Checkly CLI Documentation](https://www.checklyhq.com/docs/cli/overview/)
|
|
54
|
-
- [Checkly Constructs Reference](https://www.checklyhq.com/docs/constructs/overview/)
|
|
55
|
-
- [Agent Skills Specification](https://agentskills.io/specification.md)
|
|
@@ -1,206 +0,0 @@
|
|
|
1
|
-
# Monitors
|
|
2
|
-
|
|
3
|
-
## TCP Monitor
|
|
4
|
-
|
|
5
|
-
- Import the `TcpMonitor` construct from `checkly/constructs`.
|
|
6
|
-
- When adding `assertions`, always use `TcpAssertionBuilder` class for TCP monitors.
|
|
7
|
-
|
|
8
|
-
**Reference:** https://www.checklyhq.com/docs/constructs/tcp-monitor/
|
|
9
|
-
|
|
10
|
-
```typescript
|
|
11
|
-
import { AlertEscalationBuilder, Frequency, RetryStrategyBuilder, TcpAssertionBuilder, TcpMonitor } from 'checkly/constructs'
|
|
12
|
-
|
|
13
|
-
new TcpMonitor('example-tcp-monitor', {
|
|
14
|
-
name: 'Example TCP Monitor',
|
|
15
|
-
degradedResponseTime: 5000,
|
|
16
|
-
maxResponseTime: 5000,
|
|
17
|
-
activated: true,
|
|
18
|
-
locations: [
|
|
19
|
-
'eu-central-1',
|
|
20
|
-
'eu-west-2',
|
|
21
|
-
],
|
|
22
|
-
frequency: Frequency.EVERY_1H,
|
|
23
|
-
alertEscalationPolicy: AlertEscalationBuilder.runBasedEscalation(1, {
|
|
24
|
-
amount: 0,
|
|
25
|
-
interval: 5,
|
|
26
|
-
}, {
|
|
27
|
-
enabled: false,
|
|
28
|
-
percentage: 10,
|
|
29
|
-
}),
|
|
30
|
-
retryStrategy: RetryStrategyBuilder.linearStrategy({
|
|
31
|
-
baseBackoffSeconds: 60,
|
|
32
|
-
maxRetries: 2,
|
|
33
|
-
maxDurationSeconds: 600,
|
|
34
|
-
sameRegion: true,
|
|
35
|
-
}),
|
|
36
|
-
runParallel: true,
|
|
37
|
-
request: {
|
|
38
|
-
hostname: 'tcp.example.com',
|
|
39
|
-
port: 4242,
|
|
40
|
-
ipFamily: 'IPv4',
|
|
41
|
-
assertions: [
|
|
42
|
-
TcpAssertionBuilder.responseTime().lessThan(200),
|
|
43
|
-
TcpAssertionBuilder.responseData().isEmpty(),
|
|
44
|
-
],
|
|
45
|
-
},
|
|
46
|
-
})
|
|
47
|
-
```
|
|
48
|
-
|
|
49
|
-
## URL Monitor
|
|
50
|
-
|
|
51
|
-
- Import the `UrlMonitor` construct from `checkly/constructs`.
|
|
52
|
-
- When adding `assertions`, always use `UrlAssertionBuilder`.
|
|
53
|
-
|
|
54
|
-
**Reference:** https://www.checklyhq.com/docs/constructs/url-monitor/
|
|
55
|
-
|
|
56
|
-
```typescript
|
|
57
|
-
import { AlertEscalationBuilder, Frequency, RetryStrategyBuilder, UrlAssertionBuilder, UrlMonitor } from 'checkly/constructs'
|
|
58
|
-
|
|
59
|
-
new UrlMonitor('example-url-monitor', {
|
|
60
|
-
name: 'Example URL Monitor',
|
|
61
|
-
activated: true,
|
|
62
|
-
locations: [
|
|
63
|
-
'eu-central-1',
|
|
64
|
-
'eu-west-2',
|
|
65
|
-
],
|
|
66
|
-
frequency: Frequency.EVERY_5M,
|
|
67
|
-
alertEscalationPolicy: AlertEscalationBuilder.runBasedEscalation(1, {
|
|
68
|
-
amount: 0,
|
|
69
|
-
interval: 5,
|
|
70
|
-
}, {
|
|
71
|
-
enabled: false,
|
|
72
|
-
percentage: 10,
|
|
73
|
-
}),
|
|
74
|
-
retryStrategy: RetryStrategyBuilder.linearStrategy({
|
|
75
|
-
baseBackoffSeconds: 60,
|
|
76
|
-
maxRetries: 2,
|
|
77
|
-
maxDurationSeconds: 600,
|
|
78
|
-
sameRegion: true,
|
|
79
|
-
}),
|
|
80
|
-
runParallel: true,
|
|
81
|
-
degradedResponseTime: 5000,
|
|
82
|
-
maxResponseTime: 20000,
|
|
83
|
-
request: {
|
|
84
|
-
url: 'https://example.com',
|
|
85
|
-
ipFamily: 'IPv4',
|
|
86
|
-
assertions: [
|
|
87
|
-
UrlAssertionBuilder.statusCode().equals(200),
|
|
88
|
-
],
|
|
89
|
-
},
|
|
90
|
-
})
|
|
91
|
-
```
|
|
92
|
-
|
|
93
|
-
## DNS Monitor
|
|
94
|
-
|
|
95
|
-
- Import the `DnsMonitor` construct from `checkly/constructs`.
|
|
96
|
-
- Reference [the docs for DNS monitors](https://www.checklyhq.com/docs/constructs/dns-monitor/) before generating any code.
|
|
97
|
-
- When adding `assertions`, always use `DnsAssertionBuilder` class.
|
|
98
|
-
|
|
99
|
-
**Reference:** https://www.checklyhq.com/docs/constructs/dns-monitor/
|
|
100
|
-
|
|
101
|
-
```typescript
|
|
102
|
-
import { AlertEscalationBuilder, DnsAssertionBuilder, DnsMonitor, Frequency, RetryStrategyBuilder } from 'checkly/constructs'
|
|
103
|
-
|
|
104
|
-
new DnsMonitor('example-dns-monitor', {
|
|
105
|
-
name: 'Example DNS Monitor',
|
|
106
|
-
degradedResponseTime: 500,
|
|
107
|
-
maxResponseTime: 1000,
|
|
108
|
-
activated: true,
|
|
109
|
-
locations: [
|
|
110
|
-
'eu-central-1',
|
|
111
|
-
'eu-north-1',
|
|
112
|
-
],
|
|
113
|
-
frequency: Frequency.EVERY_10M,
|
|
114
|
-
alertEscalationPolicy: AlertEscalationBuilder.runBasedEscalation(1, {
|
|
115
|
-
amount: 0,
|
|
116
|
-
interval: 5,
|
|
117
|
-
}, {
|
|
118
|
-
enabled: false,
|
|
119
|
-
percentage: 10,
|
|
120
|
-
}),
|
|
121
|
-
retryStrategy: RetryStrategyBuilder.noRetries(),
|
|
122
|
-
request: {
|
|
123
|
-
recordType: 'AAAA',
|
|
124
|
-
query: 'welcome.checklyhq.com',
|
|
125
|
-
assertions: [
|
|
126
|
-
DnsAssertionBuilder.responseCode().equals('NOERROR'),
|
|
127
|
-
],
|
|
128
|
-
},
|
|
129
|
-
})
|
|
130
|
-
```
|
|
131
|
-
|
|
132
|
-
### ICMP Monitor
|
|
133
|
-
|
|
134
|
-
- Import the `IcmpMonitor` construct from `checkly/constructs`.
|
|
135
|
-
- Reference [the docs for ICMP monitors](https://www.checklyhq.com/docs/constructs/icmp-monitor/) before generating any code.
|
|
136
|
-
- When adding `assertions`, always use `IcmpAssertionBuilder` class.
|
|
137
|
-
- Latency assertions require a property parameter: `'avg'`, `'min'`, `'max'`, or `'stdDev'`.
|
|
138
|
-
- Use `degradedPacketLossThreshold` and `maxPacketLossThreshold` for packet loss thresholds (percentages).
|
|
139
|
-
|
|
140
|
-
**Reference:** https://www.checklyhq.com/docs/constructs/icmp-monitor/
|
|
141
|
-
|
|
142
|
-
```typescript
|
|
143
|
-
import { AlertEscalationBuilder, Frequency, IcmpAssertionBuilder, IcmpMonitor, RetryStrategyBuilder } from 'checkly/constructs'
|
|
144
|
-
|
|
145
|
-
new IcmpMonitor('example-icmp-monitor', {
|
|
146
|
-
name: 'Example ICMP Monitor',
|
|
147
|
-
request: {
|
|
148
|
-
hostname: '1.1.1.1',
|
|
149
|
-
pingCount: 10,
|
|
150
|
-
assertions: [
|
|
151
|
-
IcmpAssertionBuilder.latency('avg').lessThan(100),
|
|
152
|
-
IcmpAssertionBuilder.latency('max').lessThan(200),
|
|
153
|
-
],
|
|
154
|
-
},
|
|
155
|
-
degradedPacketLossThreshold: 10,
|
|
156
|
-
maxPacketLossThreshold: 20,
|
|
157
|
-
activated: true,
|
|
158
|
-
locations: [
|
|
159
|
-
'eu-central-1',
|
|
160
|
-
'eu-north-1',
|
|
161
|
-
],
|
|
162
|
-
frequency: Frequency.EVERY_10M,
|
|
163
|
-
alertEscalationPolicy: AlertEscalationBuilder.runBasedEscalation(1, {
|
|
164
|
-
amount: 0,
|
|
165
|
-
interval: 5,
|
|
166
|
-
}, {
|
|
167
|
-
enabled: false,
|
|
168
|
-
percentage: 10,
|
|
169
|
-
}),
|
|
170
|
-
retryStrategy: RetryStrategyBuilder.noRetries(),
|
|
171
|
-
})
|
|
172
|
-
```
|
|
173
|
-
|
|
174
|
-
## Heartbeat Monitor
|
|
175
|
-
|
|
176
|
-
- Import the `HeartbeatMonitor` construct from `checkly/constructs`.
|
|
177
|
-
|
|
178
|
-
**Reference:** https://www.checklyhq.com/docs/constructs/heartbeat-monitor/
|
|
179
|
-
|
|
180
|
-
```typescript
|
|
181
|
-
import { AlertEscalationBuilder, Frequency, HeartbeatMonitor, RetryStrategyBuilder } from 'checkly/constructs'
|
|
182
|
-
|
|
183
|
-
new HeartbeatMonitor('example-heartbeat-monitor', {
|
|
184
|
-
name: 'Example Heartbeat Monitor',
|
|
185
|
-
period: 1,
|
|
186
|
-
periodUnit: 'hours',
|
|
187
|
-
grace: 30,
|
|
188
|
-
graceUnit: 'minutes',
|
|
189
|
-
activated: true,
|
|
190
|
-
frequency: Frequency.EVERY_10S,
|
|
191
|
-
alertEscalationPolicy: AlertEscalationBuilder.runBasedEscalation(1, {
|
|
192
|
-
amount: 0,
|
|
193
|
-
interval: 5,
|
|
194
|
-
}, {
|
|
195
|
-
enabled: false,
|
|
196
|
-
percentage: 10,
|
|
197
|
-
}),
|
|
198
|
-
retryStrategy: RetryStrategyBuilder.linearStrategy({
|
|
199
|
-
baseBackoffSeconds: 60,
|
|
200
|
-
maxRetries: 2,
|
|
201
|
-
maxDurationSeconds: 600,
|
|
202
|
-
sameRegion: true,
|
|
203
|
-
}),
|
|
204
|
-
runParallel: true,
|
|
205
|
-
})
|
|
206
|
-
```
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|