DOCSEARCHbyAlgolia
Submit Docs

Checkly Documentation

website·Indexed 39 days ago

https://www.checklyhq.com/docs/learn/playwright/overview/

Build and manage monitoring infrastructure using JavaScript, TypeScript, and the Checkly CLI. Documentation covers CLI Constructs for creating URL, DNS, TCP, ICMP, gRPC, SSL, and Heartbeat monitors, as well as API, Browser, and Playwright check suites. Includes guides on configuring alert escalation policies, retry strategies, dashboards, maintenance windows, and various alert channels including Slack, PagerDuty, Opsgenie, and webhooks.

Tokens
215.6K
Snippets
1.1K
Records
1.5K
Agent score
71%

What's inside Checkly

  1. Overview of checkly test-sessions CLI

    The checkly test-sessions command (available since CLI v8.4.0) allows developers to inspect recorded test sessions from the terminal. It is used to list recent sessions, review specific session details, wait for running sessions to complete, and inspect error groups before performing root cause analysis.

    Prerequisites:

    • Checkly CLI installed
    • Valid authentication (via npx checkly login)
    • A recorded test session ID
    npx checkly test-sessions [arguments] [options]

  2. Overview of Checkly monitoring capabilities

    Checkly is a code-first monitoring platform designed for 'outside-in' reliability. Unlike APMs or log aggregators, it monitors applications from the perspective of the end-user across 22+ global regions. Key capabilities include:

    • Detect: Uptime monitoring (URLs, TCP, DNS, ICMP), Synthetic monitoring (Playwright-based user journeys), API monitoring (payload, schema, and performance validation), and Heartbeat monitoring for cron jobs/workers.
    • Define: Monitoring as Code using TypeScript, JavaScript, Terraform, or Pulumi, allowing monitors to be versioned in Git and deployed via CI.
    • Communicate: Alerting via Slack, PagerDuty, OpsGenie, and SMS, and automated branded Status Pages.
    • Resolve: OpenTelemetry-based distributed tracing and AI-generated root cause analysis via Rocky AI.

  3. Introduction to Checkly CLI Constructs

    Checkly CLI Constructs are JavaScript/TypeScript classes imported from checkly/constructs that represent monitoring resources (e.g., ApiCheck, EmailAlertChannel). These constructs serve as the 'as-code' representation of resources that are created, updated, or deleted on the Checkly cloud when running the deploy command. You must have the Checkly CLI installed to use them.
    import { ApiCheck, AssertionBuilder } from 'checkly/constructs'

new ApiCheck('api-health-check', {
  name: 'API Health Check',
  request: {
    url: 'https://danube-web.shop/api/books',
    method: 'GET',
    assertions: [
      AssertionBuilder.statusCode().equals(200),
    ],
  },
})

  4. Overview of Playwright browser automation

    Playwright is an open-source framework for cross-browser automation and end-to-end (E2E) web application testing. It supports modern rendering engines including Chromium, WebKit, and Firefox across Windows, Linux, and macOS. Unlike tools that use multiple HTTP requests (like Selenium), Playwright communicates with rendering engines via a single, persistent WebSocket connection, which reduces flakiness and increases execution speed. It supports multiple programming languages: TypeScript, JavaScript, Python, .NET, and Java.

  5. Overview of the Checkly Application Reliability Platform

    Checkly is an AI-native application reliability platform designed for modern engineering teams. It integrates three core pillars of reliability into a single platform:

    1. Detect: Identify issues using multiple layers of global detection.
    2. Communicate: Manage notifications via smart alerting, status pages, and dashboards.
    3. Resolve: Debug issues using distributed OpenTelemetry (OTel) tracing, AI-powered insights, and performance analysis.

  6. Overview of Checkly API Monitoring

    Checkly API monitoring validates API health by sending real requests from 22 global locations (and optional private locations). Unlike simple uptime tools, it asserts on the actual response content, treating 'slow' (degraded) and 'down' (failed) as distinct states. It supports intervals as frequent as every 10 seconds and can read up to 25MB of response body for assertions.

  7. Overview of gRPC Monitor modes

    gRPC Monitors in Checkly operate in two distinct modes to verify service availability and performance:

    1. BEHAVIOR: Invokes a specific unary gRPC method and asserts on the response. Requires a fully-qualified method name and either server reflection enabled or an inline .proto file.
    2. HEALTH: Queries the standard grpc.health.v1.Health/Check endpoint to verify if the service is serving.

  8. Overview of the Software Development Life Cycle (SDLC) phases

    The Software Development Life Cycle (SDLC) is a structured framework used by engineering teams to design, develop, test, and release high-quality software. It consists of the following key phases:

    • Planning & Requirements Analysis: Defining project scope, objectives, stakeholder needs, and gathering functional/non-functional requirements.
    • System Design: Making architectural decisions, selecting the tech stack, creating system specifications, and dividing the project into tasks and sprints.
    • Implementation (Coding): Developing features based on design specifications and tracking progress against planned release dates.
    • Testing: Ensuring software meets requirements and is defect-free via unit, integration, system, and acceptance testing.
    • Deployment: Releasing the software to production, typically using automated pipelines in DevOps environments.
    • Maintenance & Operations: Performing bug fixes, performance improvements, and feature updates. This phase relies heavily on monitoring and observability.

  9. Overview of checkly status-pages CLI

    The checkly status-pages command (available since CLI v7.3.0) allows developers to list and inspect status page configurations, cards, and services directly from the terminal. To use these commands, you must have the Checkly CLI installed and be authenticated via npx checkly login.
    npx checkly status-pages [arguments] [options]

  10. Overview of Checkly Traces for root cause analysis

    Checkly Traces is an OpenTelemetry-native tool that connects OTel spans to synthetic checks. Unlike traditional distributed tracing that samples all traffic, Checkly Traces captures only the spans tied to failed synthetic checks. This allows developers to jump from a failed check result, test session, or editor run directly to the exact causative span without navigating multiple dashboards.

  11. Overview of Playwright for Synthetic Monitoring with Checkly

    Playwright serves as the foundation for Checkly's synthetic 'Monitoring as Code' approach. It allows developers to automate web interactions and simulate user behavior to create reliable, programmable monitoring workflows in production using Playwright Check Suites.

  12. Overview of Playwright and Checkly for Production Monitoring

    Playwright is a browser automation framework used for end-to-end (E2E) testing. While Playwright handles the automation of browser and API interactions, Checkly extends this by automating the execution of these tests against production environments on a schedule. This combination allows teams to implement 'Monitoring as Code,' ensuring that critical business functions (e.g., e-commerce checkout flows) are working correctly for real users globally, rather than relying solely on pre-deployment QA or user reports.