monitoring

Checkly Monitoring

• Checkly CLI v6.0.0 以降のドキュメントを参照してください。
• Checkly CLI の出力を確認し、セットアップが生成されたフォルダーを特定してください。
• Checkly CLI のリファレンスドキュメントを使用してください。
• Checkly construct のリファレンスドキュメントを使用してください。
• checkly/constructs パッケージから ApiCheck、BrowserCheck、PlaywrightCheck など、コードで必要な construct をインポート、または require してください。
• 生成するコードと CLI コマンドは、必ず公式ドキュメントおよびこのファイル内の例に基づいてください。

Checkly CLI の使用

• Checkly CLI をグローバルにインストールせず、npx checkly を使用してください。
• 存在しないコマンドを絶対に作り出さないでください。
• CLI を使用して新しい Checkly プロジェクトをセットアップするには、npm create checkly@latest を使用してください。

プロジェクト構造

• 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,
  },
})

チェックおよびモニターの construct

以下の Checkly construct の作成または管理を依頼された場合は、該当するリファレンスドキュメントを読み、詳細を確認してください。

• API Checks - ApiCheck construct、アサーション、認証のセットアップスクリプト
• Browser Checks - Playwright テストファイルを使用する BrowserCheck construct
• Playwright Checks - 複数のブラウザーを対象とするテストスイート用の PlaywrightCheck construct
• MultiStep Checks - 複雑なユーザーフロー用の MultiStepCheck construct
• Uptime Monitors - TCP（TcpMonitor）、URL（UrlMonitor）、DNS（DnsMonitor）、ICMP（IcmpMonitor）、ハートビートモニター（HeartbeatMonitor）
• Check Groups - チェックを整理する CheckGroupV2 construct
• Alert Channels - メール、電話、Slack のアラートチャネル
• Supporting Constructs - ステータスページ、ダッシュボード、メンテナンスウィンドウ、プライベートロケーション

テストとデバッグ

• npx checkly test コマンドを使用してチェックをテストしてください。環境変数は -e フラグで渡し、--record を使用して結果を保存し、--verbose を使用してすべてのエラーを表示してください。