Checkly Monitoring-as-code: Advanced Project

This example project shows how you can use the Checkly CLI in a monitoring as code (MaC) workflow. We are using the https://checklyhq.com website as a monitoring target.

1. Write API Checks and Playwright-powered Browser Checks.
2. Add Alert Channels, and dry-run your Checks on 20+ global locations.
3. Test -> Deploy: now you have your app monitored around the clock. All from your code base.

npm create checkly -- --template advanced-project

Project Structure

This project mimics a typical app where you organize code with top-level defaults and per page, service or component checks.

.
├── .github
│   └── workflow.yml
├── README.md
├── checkly.config.js
├── package.json
└── src
    ├── __checks__
    │   ├── api.check.js
    │   ├── home.check.js
    │   ├── homepage.spec.js
    │   ├── login.spec.js
    │   ├── utils
    │   │   ├── auth-client.js
    │   │   └── setup.js
    │   └── website-group.check.js
    ├── alert-channels.js
    ├── defaults.js
    └── services
        ├── api
        │   └── __checks__
        │       └── api.check.js
        └── top-sellers
            └── __checks__
                └── top-sellers.spec.js

• Running npx checkly test will look for .check.js files and .spec.js in __checks__ directories and execute them in a dry run.

• Running npx check deploy will deploy your checks to Checkly, attach alert channels, and run them on a 10m schedule in the region us-east-1 and eu-west-1

• An example GitHub Actions workflow is in the .github/workflow.yml file. It triggers all the checks in the project and deploys them if they pass.

CLI Commands

Run the core CLI commands with npx checkly <command>

Command	Action
npx checkly test	Dry run all the checks in your project
npx checkly deploy	Deploy your checks to the Checkly cloud
npx checkly login	Log in to your Checkly account
npx checkly --help	Show help for each command.

Check the docs for the full CLI reference.

Adding and running @playwright/test

You can add @playwright/test to this project to get full code completion and run .spec.js files for local debugging. It's best to install the Playwright npm package version that matches your Checkly runtime.

npm install --save-dev @playwright/[email protected]

Questions?

Check our CLI docs, the main Checkly docs or join our Slack community.