Checkly

# Checkly Documentation

Important notes:

- Checkly is a synthetic monitoring platform designed for developers and DevOps teams
- Provides API monitoring, browser monitoring with Playwright, and monitoring as code workflows
- Supports monitoring as code through CLI, Terraform, and Pulumi for version-controlled monitoring
- Offers uptime monitoring, alerting, dashboards, and integrations with popular tools
- Built for modern development workflows with CI/CD integration and deployment testing
- Before getting started make sure to understand the project structure
- For backend projects identify all resources which can be tested
- For frontend projects identify all pages and user journeys which can be tested
- Understand the authentication setup for the users app so you can support it
- Store required credentials in Checkly
- Make sure to guide the user when setting up a new project, use the `npm create checkly@latest` command to get started
- To generate the first checks/tests explain the user the available check types and ask them which one they want to use
- Make sure to only use npm packages in scripts which are available in Checkly runtimes, Checkly doesn't support all npm packages
- Never use the imports in the namespace '@checkly'. they are outdated. Always import from 'checkly/constructs'
- Make sure that generated test files names match the patterns set in Checkly config file
- Make sure when using environment variables or secrets to store them in Checkly using Checkly's cli

## Core Platform

### Monitoring
- [How Checkly runs checks](https://www.checklyhq.com/docs/monitoring/): How Checkly runs checks
- [Results](https://www.checklyhq.com/docs/monitoring/check-results/): Check results
- [Global locations](https://www.checklyhq.com/docs/monitoring/global-locations/): Global locations & scheduling strategies
- [Optimizing reliability](https://www.checklyhq.com/docs/monitoring/optimizing-reliability/): Optimizing your monitoring for reliability
- [How we store data](https://www.checklyhq.com/docs/monitoring/how-we-store-data/): How we store data
- [Storing secrets](https://www.checklyhq.com/docs/monitoring/storing-secrets/): Storing secrets
- [Allowlisting traffic](https://www.checklyhq.com/docs/monitoring/allowlisting/): Allowlisting & filtering traffic
- [IP information & versions](https://www.checklyhq.com/docs/monitoring/ip-info/): IP information & versions
- [Responsible use](https://www.checklyhq.com/docs/monitoring/responsible-use/): Responsible use

### Testing
- [Overview](https://www.checklyhq.com/docs/testing/): Getting started with testing in Checkly


### Command Line Interface (CLI)
- [Getting started](https://www.checklyhq.com/docs/cli/): Getting started with the Checkly CLI
- [Installation](https://www.checklyhq.com/docs/cli/installation/): Installing the Checkly CLI
- [Project structure](https://www.checklyhq.com/docs/cli/project-structure/): Structuring your project in Checkly
- [Using `checkMatch` and `testMatch`](https://www.checklyhq.com/docs/cli/using-check-test-match/): Using `checkMatch` and `testMatch`
- [Using Constructs](https://www.checklyhq.com/docs/cli/using-constructs/): Using Constructs
- [Environment variables](https://www.checklyhq.com/docs/cli/using-environment-variables/): Using environment variables
- [Dynamic monitor creation](https://www.checklyhq.com/docs/cli/dynamic-check-creation/): Dynamic monitor creation
- [Using Git](https://www.checklyhq.com/docs/cli/using-git/): Using git metadata
- [NPM packages & local dependencies](https://www.checklyhq.com/docs/cli/npm-packages/): Using NPM packages and local dependencies
- [Importing existing resources](https://www.checklyhq.com/docs/cli/import/): Importing your account with the Checkly CLI
- [CLI vs. Terraform & Pulumi - Checkly Docs](https://www.checklyhq.com/docs/cli/cli-vs-terraform-pulumi/): CLI vs. Terraform & Pulumi
- [Constructs Reference](https://www.checklyhq.com/docs/cli/constructs-reference/): Constructs Reference
- [Command Line Reference](https://www.checklyhq.com/docs/cli/command-line-reference/): Command Line Reference

### Traces & OpenTelemetry
- [Getting started](https://www.checklyhq.com/docs/traces-open-telemetry/): Getting started with Checkly Traces and OpenTelemetry
- [How it works](https://www.checklyhq.com/docs/traces-open-telemetry/how-it-works/): Understand Checkly Traces and OpenTelemetry

## Resources

### API Checks
- [Overview](https://www.checklyhq.com/docs/api-checks/): Getting started with API checks
- [HTTP request settings](https://www.checklyhq.com/docs/api-checks/request-settings/): HTTP request settings
- [Variables and secrets](https://www.checklyhq.com/docs/api-checks/variables/): Variables and secrets
- [API Assertions](https://www.checklyhq.com/docs/api-checks/assertions/): Writing assertions for API checks
- [Response time limits](https://www.checklyhq.com/docs/api-checks/limits/): API Response time limits
- [Setup & teardown scripts](https://www.checklyhq.com/docs/api-checks/setup-teardown-scripts/): API setup & teardown scripts
- [Setup script examples](https://www.checklyhq.com/docs/api-checks/setup-script-examples/): API setup script examples
- [Teardown script examples](https://www.checklyhq.com/docs/api-checks/teardown-script-examples/): API teardown script examples
- [Timeouts and timing phases](https://www.checklyhq.com/docs/api-checks/timeouts-timing/): API timeouts and timing phases
- [Client certificates](https://www.checklyhq.com/docs/api-checks/client-certificates/): Client certificates

### Browser Checks
- [Overview](https://www.checklyhq.com/docs/browser-checks/): Getting started with Browser monitoring
- [Using Playwright Test Runner](https://www.checklyhq.com/docs/browser-checks/playwright-test/): How to use Playwright Test Runner natively within browser checks at Checkly
- [Scraping on page elements](https://www.checklyhq.com/docs/browser-checks/scraping-onpage-elements/): How to scrape web page elements like texts, buttons and forms with Google Chrome and Playwright Test.
- [Screenshots](https://www.checklyhq.com/docs/browser-checks/screenshots/): Taking screenshots
- [File system](https://www.checklyhq.com/docs/browser-checks/file-system/): File uploads, downloads and the file system
- [Login scenarios](https://www.checklyhq.com/docs/browser-checks/login-scenarios/): Monitoring a login scenario with browser checks
- [Variables and secrets](https://www.checklyhq.com/docs/browser-checks/variables/): Handling variables and secrets
- [Multiple tabs](https://www.checklyhq.com/docs/browser-checks/multiple-tabs/): Monitoring a scenario with multiple tabs
- [Timeouts](https://www.checklyhq.com/docs/browser-checks/timeouts/): Timeouts
- [Tracing and Web Vitals](https://www.checklyhq.com/docs/browser-checks/tracing-web-vitals/): Tracing and Web Vitals
- [Visual regression & snapshot testing](https://www.checklyhq.com/docs/browser-checks/visual-regression-snapshot-testing/): Visual regression & snapshot testing
- [Degraded state](https://www.checklyhq.com/docs/browser-checks/degraded-state/): Degraded state with soft assertions

### Heartbeat Monitors
- [Overview](https://www.checklyhq.com/docs/heartbeat-monitors/): Getting started with Heartbeat monitors
- [Ping examples](https://www.checklyhq.com/docs/heartbeat-monitors/ping-examples/): Ping examples

### URL Monitors
- [Overview](https://www.checklyhq.com/docs/url-monitors/): Run HTTP health checks with URL monitors

### Multistep Checks
- [Overview](https://www.checklyhq.com/docs/multistep-checks/): Getting started with Multistep API Checks
- [Degraded state](https://www.checklyhq.com/docs/multistep-checks/degraded-state/): Degraded state with soft assertions on Multistep checks
- [File uploads, downloads and the file system](https://www.checklyhq.com/docs/multistep-checks/upload-downloads-filesystem/): File uploads, downloads and the file system
- [WebSockets](https://www.checklyhq.com/docs/multistep-checks/websockets/): WebSockets on Multistep checks
- [Examples](https://www.checklyhq.com/docs/multistep-checks/example-checks/): Multistep check examples

### TCP Monitors