Checkly CLI Skills

✓ Monitoring as Code 工作流首选

通过代码定义监控,支持TypeScript原生工作流,本地测试后部署至Checkly云,实现CI/CD集成与版本控制

收藏
5.3k
安装
1.4k
版本
1.0.5
CLS 安全扫描中
预计需要 3 分钟...

使用说明

核心用法

Checkly CLI 提供了一套完整的 Monitoring as Code(MaC)工作流,允许开发者使用 TypeScript/JavaScript 定义合成监控。核心命令包括 npm create checkly@latest 初始化项目、npx checkly test 本地测试、npx checkly deploy 部署到云端。支持 API 检查(HTTP 请求+断言)、浏览器检查(Playwright 规格文件)以及多步骤检查,并可通过 checkly.config.ts 进行项目级配置。

显著优点

1. 代码优先:监控配置与业务代码同仓库管理,支持 PR 评审和版本回滚
2. 原生 Playwright 支持:可直接复用现有的 @playwright/test 测试文件

3. 本地测试闭环npx checkly test 在本地验证后再部署,降低线上风险

4. CI/CD 原生:无缝集成 GitHub Actions、GitLab CI 等流水线

5. 导入现有资源npx checkly import 可将 Web UI 中已创建的检查反向生成代码

潜在局限

  • 学习曲线:需要理解 Constructs 对象模型和配置层级(Check > Group > Config > Account)
  • Node.js 依赖:必须维护 npm 包版本兼容性,浏览器检查需额外安装 Playwright
  • 运行时差异:本地 Playwright 与 Checkly 云端运行时可能存在环境差异,需用 npx checkly test 二次验证
  • 告警配置受限:复杂告警策略(如 Escalation)仍需在 Web UI 中配置
  • 私有机密管理:敏感凭证需通过环境变量注入,无内置 Secrets Manager 集成

适合人群

  • 已采用"监控即代码"实践的现代 DevOps/SRE 团队
  • 使用 Playwright 进行 E2E 测试的前端/全栈开发者
  • 需要为多个环境(staging/production)维护多套检查配置的工程团队
  • 追求将监控配置纳入 GitOps 工作流的组织

常规风险

1. 凭证泄露CHECKLY_API_KEY 若提交至代码仓库会导致账户被盗用,建议配置 .gitignore 并使用 CI/CD Secrets
2. 破坏性部署npx checkly deploy 会覆盖云端状态,生产环境建议先 --preview 或使用 dry-run 模式

3. 资源误删npx checkly checks delete 操作不可逆,需确认依赖关系

4. 频率配置错误:过高的检查频率(如 10s 一次)可能导致目标服务被压测或产生高额账单

5. 本地与云端结果不一致:断言依赖的时区、DNS 解析在本地与 Checkly 全球节点可能表现不同

Checkly CLI Skills 内容

checkly-advanced文件夹
checkly-assets文件夹
checkly-auth文件夹
checkly-checks文件夹
checkly-config文件夹
checkly-constructs文件夹
checkly-deploy文件夹
checkly-groups文件夹
checkly-import文件夹
checkly-members文件夹
checkly-monitors文件夹
checkly-playwright文件夹
checkly-test文件夹
references文件夹
scripts文件夹
templates文件夹
手动下载zip · 49.6 kB
SKILL.mdtext/markdown
请选择文件