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: How Checkly runs checks
• Results: Check results
• Global locations: Global locations & scheduling strategies
• Optimizing reliability: Optimizing your monitoring for reliability
• How we store data: How we store data
• Storing secrets: Storing secrets
• Allowlisting traffic: Allowlisting & filtering traffic
• IP information & versions: IP information & versions
• Responsible use: Responsible use

Testing

• Overview: Getting started with testing in Checkly

Command Line Interface (CLI)

• Getting started: Getting started with the Checkly CLI
• Installation: Installing the Checkly CLI
• Project structure: Structuring your project in Checkly
• Using checkMatch and testMatch: Using checkMatch and testMatch
• Using Constructs: Using Constructs
• Environment variables: Using environment variables
• Dynamic monitor creation: Dynamic monitor creation
• Using Git: Using git metadata
• NPM packages & local dependencies: Using NPM packages and local dependencies
• Importing existing resources: Importing your account with the Checkly CLI
• CLI vs. Terraform & Pulumi - Checkly Docs: CLI vs. Terraform & Pulumi
• Constructs Reference: Constructs Reference
• Command Line Reference: Command Line Reference

Traces & OpenTelemetry

• Getting started: Getting started with Checkly Traces and OpenTelemetry
• How it works: Understand Checkly Traces and OpenTelemetry

Resources

API Checks

• Overview: Getting started with API checks
• HTTP request settings: HTTP request settings
• Variables and secrets: Variables and secrets
• API Assertions: Writing assertions for API checks
• Response time limits: API Response time limits
• Setup & teardown scripts: API setup & teardown scripts
• Setup script examples: API setup script examples
• Teardown script examples: API teardown script examples
• Timeouts and timing phases: API timeouts and timing phases
• Client certificates: Client certificates

Browser Checks

• Overview: Getting started with Browser monitoring
• Using Playwright Test Runner: How to use Playwright Test Runner natively within browser checks at Checkly
• Scraping on page elements: How to scrape web page elements like texts, buttons and forms with Google Chrome and Playwright Test.
• Screenshots: Taking screenshots
• File system: File uploads, downloads and the file system
• Login scenarios: Monitoring a login scenario with browser checks
• Variables and secrets: Handling variables and secrets
• Multiple tabs: Monitoring a scenario with multiple tabs
• Timeouts: Timeouts
• Tracing and Web Vitals: Tracing and Web Vitals
• Visual regression & snapshot testing: Visual regression & snapshot testing
• Degraded state: Degraded state with soft assertions

Heartbeat Monitors

• Overview: Getting started with Heartbeat monitors
• Ping examples: Ping examples

URL Monitors

• Overview: Run HTTP health checks with URL monitors

Multistep Checks

• Overview: Getting started with Multistep API Checks
• Degraded state: Degraded state with soft assertions on Multistep checks
• File uploads, downloads and the file system: File uploads, downloads and the file system
• WebSockets: WebSockets on Multistep checks
• Examples: Multistep check examples

TCP Monitors

• Overview: Monitoring your services with TCP monitors

Playwright Check Suites

• Overview: Onboard your Playwright test suite
• Custom dependencies: Using custom dependencies in Playwright Check Suites
• Reference: All options available in Playwright Check Suites
• Add to a group: Adding a Playwright Check Suite to a group

Groups

• Overview: Organizing checks with groups
• API check defaults: API check defaults
• Variables: Environment variables and secrets at the Group level

Alerting & Retries

• Overview: Alerting and retries with Checkly
• Alert settings: Alert settings in Checkly
• Alert channels: Available alerting channels in Checkly
• Custom Alerts: Custom Alerts in Checkly
• Retries: Retrying failed checks in Checkly
• SSL Cert expiration: Monitoring SSL certificate expiration in Checkly
• Alert states: Alert states in Checkly
• SMS: Alerting with SMS in Checkly
• Phone Calls: Alerting with phone calls in Checkly
• Webhooks: Alerting with webhooks in Checkly
• Alert notification log: Alert notification log in Checkly

Maintenance Windows

• Overview: Setting Maintenance Windows

Dashboards

• Overview: Checkly Dashboards
• Customization: Customizing your dashboard
• Private Dashboards: Creating Private Dashboards
• Custom CSS: Customizing Your Dashboard with Custom CSS
• Incidents: Incident & Maintenance messages

Status Pages

• Overview: Checkly Status Pages
• Incidents: Incidents

Accounts & Users

• About Roles in Checkly - Checkly Docs: About Roles in Checkly
• Adding team members: Adding team members to your Checkly account
• Changing email or password: Changing your email or password in Checkly
• Multi-Factor Authentication: Multi-Factor Authentication in Checkly
• Creating an API key: Creating an API key in Checkly
• Single Sign-on: Single Sign-on in Checkly
• SAML: SAML for Single Sign-on in Checkly
• Microsoft Azure AD: Using Microsoft Azure AD for Single Sign-on in Checkly

Private Locations

• Overview: Getting started with Private Locations
• Checkly Agent Configuration: Checkly Agent Configuration
• Running on Kubernetes: Running Checkly on Kubernetes
• Scaling and Redundancy: Scaling and Redundancy on Private Locations
• Using HTTP proxies: Using HTTP proxies

Reporting

• Overview: Reporting Dashboard

Analytics

• Overview

Runtimes

• Overview: How runtimes work
• Runtime specification: Runtime specification

Integrations

Integrations Overview

• Overview: Checkly Integrations
• Slack: Sending Alerts to Slack
• PagerDuty: Learn how Checkly integrates seamlessly with PagerDuty, delivering real-time failure and recovery alerts to your PagerDuty account.
• Opsgenie: Learn how to integrate Checkly with Opsgenie and deliver failure, degradation, and recovery events to any Opsgenie team. Check our guide!
• Incident.io: Send Alerts to Incident.io
• Rootly: Send Alerts to Rootly
• GitLab Alerts: Integrating GitLab Alerts
• Microsoft Teams: Send Alerts to Microsoft Teams
• Discord: Send Alerts to Discord
• Telegram: Find out how Checkly integrates with Telegram to send failure, degradation, and recovery messages to any chat.
• Spike.sh: Integrating Spike.sh
• Splunk On-Call: Send Alerts via Splunk On-Call
• StatusPage: Integrating StatusPage
• Prometheus V2: Exporting Metrics & Data via Prometheus V2
• Prometheus: Exporting Metrics & Data via Prometheus
• Pulumi: Integrating Pulumi with Checkly
• FireHydrant: Send Alerts to FireHydrant
• Coralogix: Export Metrics & Data via Coralogix
• ilert: Send Alerts to ilert

CI/CD Integration

• Overview: Integrating Checkly in your CI/CD pipeline
• Vercel Deployment Protection: Vercel Deployment Protection
• GitHub Actions: Integrating Checkly in GitHub Actions
• Managing Users and Plans with Vercel: Managing Users and Plans with Vercel
• Jenkins: Integrating Checkly in a Jenkins pipeline
• GitLab CI: Integrating Checkly in GitLab CI
• Vercel: Integrate Checkly with Vercel for app development and deployment to benefit from automated browser checks and production deployment testing.
• GitHub deployments: Integrating Checkly with GitHub deployments
• Command Line triggers: Command Line triggers

Terraform Provider

• Overview: Getting started with the Terraform provider for Checkly
• Checks and groups: Checks and groups for Terraform
• Alert channels and settings: Alert channels and settings for Terraform
• Snippets and environment variables in Terraform - Checkly Docs: Snippets and environment variables in Terraform
• Dashboards: Dashboards in Terraform
• Service maintenance windows: Service maintenance windows in Terraform
• Command line triggers: Command line triggers for Terraform
• Testing Terraform scripts locally - Checkly Docs: Testing Terraform scripts locally
• Parameterized resources in Terraform - Checkly Docs: Parameterized resources in Terraform
• CI/CD pipelines: CI/CD pipelines for Terraform
• Common issues: Common issues with the Terraform provider

Pulumi Provider

• Overview: Getting started with the Pulumi provider for Checkly

API Reference

• Checkly API Documentation: Complete REST API reference for managing checks, alerts, and dashboards programmatically