Skip to main content
Ask AI

TestRelic Documentation

TestRelic is an AI-driven test analytics platform built for engineering teams who use Playwright. It has two integrated layers that work together:

LayerWhat it isWhere it runs
SDK Reporter (@testrelic/playwright-analytics)A Playwright reporter that captures rich test data — navigation timelines, network stats, failure diagnostics, CI metadata — and uploads it to the cloud platformLocally, alongside your tests
Cloud PlatformA web application for visualizing test data, running AI analysis, monitoring test health, and connecting your toolstestrelic.ai

SDK Reporter

The @testrelic/playwright-analytics package is the data collection layer. Add it as a reporter in your playwright.config.ts and it automatically:

  • Captures step-by-step navigation timelines.
  • Records network requests, console output, and performance metrics.
  • Detects CI environment context (GitHub Actions, GitLab CI, Jenkins, CircleCI).
  • Uploads structured test run data to the TestRelic cloud platform.
  • Generates local reports (browser, API, unified) for offline use.

Requirements:

  • Node.js ≥ 18
  • Playwright ≥ 1.40
npm install --save-dev @testrelic/playwright-analytics

See Getting Started for full setup instructions.

Cloud Platform

The TestRelic cloud platform (testrelic.ai) receives data from the SDK reporter and provides:

  • Test Runs Dashboard — Org-wide run history with CI badges, filters, and session drill-down.
  • Session Workspace — DevTools-style inspection with video, steps, console, network, and performance panels.
  • AI Intelligence — Ask AI in natural language, get automated session insights, and generate reports and test plans.
  • Test Navigation — Pathfinder and tree-view maps of browser flow coverage.
  • Monitoring — Smoke, regression, and nightly observatory dashboards for quality gates.
  • Integrations — Native connections to GitHub Actions, Jira, Grafana Loki, and Amplitude.

See Cloud Platform Overview to understand the full platform.

Two paths to getting started

Path 1 — SDK only (local reporting)

If you want to generate structured test reports locally without using the cloud platform:

  1. Install the reporter: npm install --save-dev @testrelic/playwright-analytics
  2. Add it to playwright.config.ts
  3. Run your tests — reports are generated in testrelic-output/

Installation guide

Path 2 — SDK + Cloud Platform (full value)

To get AI insights, monitoring, and the full session workspace:

  1. Sign up at testrelic.ai
  2. Complete the onboarding wizard
  3. Connect your repository and configure the reporter with your API key
  4. Run your tests — data flows to the cloud automatically

Cloud Platform Quickstart

Plans

TestRelic offers two plans:

Starter ($5/mo)Growth ($20/mo)
SDK reporter
Cloud platform
AI insights & Ask AI
Storage500 MB1 GB
Data retention14 days30 days

Full plan comparison

Was this doc helpful?
Last updated on by Srivishnu Ayyagari