monitoring

Checkly 监控

• 请参阅 Checkly CLI v6.0.0 及更高版本的文档。
• 查看 Checkly CLI 的输出，确定生成配置的文件夹。
• 使用 Checkly CLI 参考文档。
• 使用 Checkly 构造参考文档。
• 在代码中导入和／或引入所需的任何构造，例如从 checkly/constructs 包中导入 ApiCheck、BrowserCheck 或 PlaywrightCheck。
• 始终依据官方文档和本文件中的示例，生成代码和 CLI 命令。

使用 Checkly CLI

• 使用 npx checkly，而不是全局安装 Checkly CLI。
• 切勿编造不存在的命令。
• 使用 npm create checkly@latest 通过 CLI 设置新的 Checkly 项目。

项目结构

• checkly.config.ts - 必需的全局项目和 CLI 配置。我们建议使用 TypeScript。
• *.check.ts|js - 定义检查的 TS／JS 文件。
• *.spec.ts|js - 包含 Browser 和 MultiStep 检查 Playwright 代码的 TS／JS 文件。
• src/__checks__ - 存放所有检查的默认目录。如果该目录已存在，请使用它；否则，请为检查创建一个新目录。
• package.json - 标准 NPM 项目清单。

以下是目录树示例：

. |-- checkly.config.ts |-- package.json -- src -- checks |-- alert-channels.ts |-- api-check.check.ts `-- homepage.spec.ts

项目根目录中的 checkly.config.ts 定义了所有检查的一系列默认值。

参考： https://www.checklyhq.com/docs/constructs/project/

import { defineConfig } from 'checkly'
import { Frequency } from 'checkly/constructs'

export default defineConfig({
  projectName: "Production Monitoring Suite",
  logicalId: "prod-monitoring-2025",
  repoUrl: "https://github.com/acme/monitoring",
  checks: {
    activated: true,
    muted: false,
    runtimeId: "2025.04",
    frequency: Frequency.EVERY_10M,
    locations: ["us-east-1", "eu-west-1", "ap-southeast-1"],
    tags: ["production", "critical"],
    checkMatch: "**/__checks__/*.check.ts",
    ignoreDirectoriesMatch: ["node_modules/**", "dist/**"],
    playwrightConfig: {
      use: {
        baseURL: "https://app.example.com",
      },
    },
    browserChecks: {
      frequency: Frequency.EVERY_30M,
      testMatch: "**/__tests__/*.spec.ts",
    },
  },
  cli: {
    runLocation: "eu-west-1",
    privateRunLocation: "private-dc1",
    retries: 2,
  },
})

检查和监控构造

如果任务涉及创建或管理以下任一 Checkly 构造，请解析并阅读更多参考文档：

• API 检查 - ApiCheck 构造、断言和身份验证设置脚本
• Browser 检查 - 使用 Playwright 测试文件的 BrowserCheck 构造
• Playwright 检查 - 用于多浏览器测试套件的 PlaywrightCheck 构造
• MultiStep 检查 - 用于复杂用户流程的 MultiStepCheck 构造
• 运行时间监控器 - TCP（TcpMonitor）、URL（UrlMonitor）、DNS（DnsMonitor）、ICMP（IcmpMonitor）和心跳监控器（HeartbeatMonitor）
• 检查组 - 用于组织检查的 CheckGroupV2 构造
• 警报渠道 - 电子邮件、电话和 Slack 警报渠道
• 支持构造 - 状态页、仪表板、维护窗口和私有位置

测试和调试

• 使用 npx checkly test 命令测试检查。使用 -e 标志传递环境变量，使用 --record 保存结果，并使用 --verbose 查看所有错误。