Playwright Check Suites Configuration

Use the checkly.config.ts/js file to define your Playwright Check Suite. Each Playwright Check Suite can be connected to references in your playwright.config.ts/js file.

A Playwright Check Suite can run up to 15 minutes. Please contact us in the Checkly Web App or get in touch with your account executive if you’re interested in longer runs.

Playwright Check Suite definition

To add Playwright Check Suites to your Checkly monitoring setup, specify the path to your playwright.config.ts/js and add a new playwrightChecks property to the existing checks configuration in your checkly.config.ts/js.

checkly.config.ts

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

export default defineConfig({
  // ...

  checks: {
    playwrightConfigPath: './playwright.config.ts',
    playwrightChecks: [
      {
        name: 'all-pwt-tests',
        logicalId: 'all-tests',
      }
    ],
  },
})

A Playwright Check Suite requires the following properties:

name - a human friendly name for your check suite.
logicalId - a reference for your check suite.

Other available properties like frequency, alertChannels or locations are inherited from the general Checkly configuration if not specified otherwise.

Playwright references

Without limiting and selecting specific tests or Playwright projects, the Checkly infrastructure will run and deploy all your existing Playwright tests (similar to what npx playwright test runs) as monitors. Specify which tests should become part of global end-to-end monitoring by defining these properties:

pwProjects: select an existing project by name from your Playwright configuration to create a Playwright Check Suite.
pwTags: select tagged tests that will be grouped into a Playwright Check Suite.

You can combine pwTags and pwProjects to generate your check suite, too. For example:

checkly.config.ts

export default defineConfig({
  // ...
  checks: {
    playwrightConfigPath: './playwright.config.ts',
    playwrightChecks: [
      {
        name: "Marketing Environment",
        logicalId: "environment-marketing-suite",
        // Run the `environment-marketing` Playwright project
        // in two locations every hour
        pwProjects: ["environment-marketing"],
        frequency: Frequency.EVERY_1H,
        locations: ["us-west-1", "eu-west-2"],
      },
      {
        name: "Critical production tests",
        logicalId: "critical-tests",
        // Run `@critical` tagged Playwright tests
        // in three locations every ten minutes
        pwTags: ["@critical"],
        frequency: Frequency.EVERY_10M,
        locations: ["us-west-1", "eu-west-2", "af-south-1"],
      },
    ],
  },
});

Learn more about best practices to organize and structure your Playwright tests for synthetic monitoring.

Monitoring customizations

A Playwright Check Suite inherits multiple properties from the abstract Check class:

name
activated
muted
locations
tags
frequency
alertChannels
privateLocations
alertEscalationPolicy

Check the reference documentation for more information on these settings.

Checks’ Retry strategy is not applicable for Playwright checks. Playwright includes its own retry features that can be set up directly in your playwright.config.ts/js file with the retries option. This allows for more detailed management of test retries within Playwright, when your check runs.

Additionally, Playwright Check Suites provide specific configuration for your Playwright monitoring.

installCommand: Override the command to install dependencies, by default it’ll use npm install --dev.
testCommand: Override the command to test, by default it uses npx playwright test with the tags, projects, and config file options your check specifies.
groupName: The group this check belongs to.

checkly.config.ts

export default defineConfig({
  // Shared Checkly configuration (scheduling, locations, etc.)
  // ...
  checks: {
    // Specify the relative path to your config file
    playwrightConfigPath: './playwright.config.ts',
    playwrightChecks: [
      {
        /**
         * Run `@e2e` tagged tests across browsers
         * every 5 minute from 4 locations.
         */
        // Human readable name
        name: 'E2E test suite',
        // Reference id
        logicalId: 'e2e-test-suite',
        // Playwright project references defined in `playwright.config`
        pwProjects: ['chromium', 'firefox', 'webkit'],
        // Playwright tags defined in `spec` files
        pwTags: '@e2e',
        // Override default dependencies install command
        installCommand: 'npm install --dev',
        // Append to the resulting test command, respects your pwTags and pwProjects filters.
        testCommand: 'npx playwright test --trace=on',
        // Activate the check so that it runs on a schedule, true by default
        activated: true,
        // Mute the check so that it doesn't send alerts
        muted: false,
        // Add a check to a group
        groupName: 'production-group',
        // Specify a monitoring frequency
        frequency: Frequency.EVERY_5M,
        // Define locations to monitor from
        locations: ['us-east-1', 'eu-west-1','eu-central-1', 'ap-south-1'],
      }
    ]
  },
}

Getting Started

Detect

Communicate

Resolve

Integrations

Playwright Check Suites Configuration

Playwright Check Suite definition

Playwright references

Monitoring customizations

​Playwright Check Suite definition

​Playwright references

​Monitoring customizations

Playwright Check Suite definition

Playwright references

Monitoring customizations