Checkly CLI Skills

🔍 代码定义合成监控,Playwright 原生支持

Checkly CLI 提供 Monitoring as Code 能力,支持用 TypeScript/JavaScript 定义 API/Browser 监控检查,本地测试后通过 CI/CD 部署,适合 DevOps 团队实现可版本控制的合成监控。

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

使用说明

核心用法

Checkly CLI 是一款Monitoring as Code (MaC) 工具,允许开发者用 TypeScript/JavaScript 代码定义合成监控检查,包括 API 检查和基于 Playwright 的浏览器检查。核心工作流为:

1. 项目初始化npm create checkly@latest 创建标准项目结构
2. 本地开发:使用 npx checkly test 在本地验证检查逻辑

3. 部署上线npx checkly deploy 将检查部署到 Checkly 云端,按设定频率持续运行

检查类型

  • API Check:HTTP 请求 + 多维度断言(状态码、响应时间、响应体等)
  • Browser Check:单 Playwright 测试文件,模拟真实用户交互
  • Playwright Check Suite:多测试项目并行,支持复杂矩阵配置
  • Monitors:轻量级健康检查(Heartbeat/TCP/DNS/URL),无需代码执行

配置层级

配置遵循"具体覆盖通用"原则:检查级 > 检查组级 > checkly.config.ts 项目级 > 账户默认值。

显著优点

| 优势 | 说明 |
|------|------|
| **代码化版本控制** | 监控配置纳入 Git 工作流,支持 PR Review 和回滚 |
| **本地可测试** | `npx playwright test` 快速迭代 + `npx checkly test` 运行时验证 |
| **原生 Playwright** | 复用现有 `@playwright/test` 技能栈,无需学习新 DSL |
| **CI/CD 原生** | 无缝集成 GitHub Actions/Jenkins 等流水线 |
| **反向导入** | `npx checkly import` 将 Web UI 现有检查迁移为代码 |
| **灵活配置** | 支持 Constructs 编程模型、Check Groups 分组管理 |

潜在缺点与局限性

  • 学习曲线:需掌握 Checkly Constructs API 和配置层级概念
  • Browser Check 调试成本:Playwright 本地运行与 Checkly 云端运行时存在环境差异,部分问题仅能在 npx checkly test 阶段暴露
  • Monitors 功能边界:轻量级 Monitors(URL/DNS 等)功能较 API Check 简陋,无法执行自定义脚本
  • Multi-Step Check 已弃用:复杂流程建议改用 Browser Check 或 Playwright Check Suite
  • Node.js 生态绑定:非 Node 技术栈团队需要额外环境配置

适合人群

  • DevOps/SRE 工程师:需要将监控纳入 Infrastructure as Code 体系
  • 前端/全栈开发者:已使用 Playwright 进行 E2E 测试,希望复用测试代码做生产监控
  • 平台工程团队:需要为多个服务统一标准化监控配置
  • 追求 GitOps 的组织:希望监控变更走代码审查流程

常规风险

| 风险类型 | 说明 |
|---------|------|
| **凭证管理** | `CHECKLY_API_KEY` 和 `CHECKLY_ACCOUNT_ID` 需安全存储,避免泄露至版本控制 |
| **配置漂移** | Web UI 手动修改与代码定义可能冲突,建议禁用 UI 编辑或建立同步机制 |
| **部署权限** | CI/CD 中的 `checkly deploy` 需 API Key 具备写权限,需最小权限原则配置 |
| **运行时差异** | Playwright 版本、Node 版本、依赖包版本可能导致本地通过但云端失败 |
| **频率与成本** | 高频检查(如每分钟)可能产生较高费用,需合理配置 `frequency` 参数 |

最佳实践建议

1. 分层测试:本地 playwright testcheckly test 验证 → checkly deploy
2. 使用 checkly import 迁移现有资产,避免重复劳动

3. 利用 CheckGroup 管理共享配置(告警通道、运行位置、频率)

4. 生产环境建议通过 CHECKLY_API_KEY 环境变量注入,避免 npx checkly login 交互式认证

Checkly CLI Skills 内容

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