Welcome to TestRelic Documentation

Welcome to the official TestRelic documentation. Whether you ship browser suites with Playwright, mobile automation with Appium and WebdriverIO, or Maestro flows, the same idea applies: capture structured execution signals locally, optionally sync them to the cloud, and use dashboards, AI, and integrations to shorten mean time to understand a failure.

This hub page orients new readers: what TestRelic is, which packages to install, how the cloud fits in, and where to read next—including longer blog articles that tie multiple doc sections together for SEO-friendly learning paths.

What is TestRelic?

TestRelic is a Testing Observability Platform that gives engineering teams deep visibility into their automated test suites — whether they run in a browser or on a mobile device. Unlike traditional test reporters that only show pass/fail results, TestRelic captures rich execution data and surfaces it through AI-powered insights, monitoring dashboards, and deep session inspection.

TestRelic has two layers:

• SDK Reporters — lightweight packages that run alongside your tests and capture structured data
• Cloud Platform — a web application at testrelic.ai where that data is visualized, analyzed, and acted on

SDK Reporters

@testrelic/playwright-analytics — Browser Testing

The Playwright reporter captures a rich timeline of your browser test execution including:

• Every page navigation during your tests
• Network request statistics for each page
• Detailed failure diagnostics with code snippets
• CI/CD integration metadata

@testrelic/appium-analytics — Mobile Testing (Android / iOS)

The Appium reporter captures a comprehensive trace of your mobile test execution including:

• Every Appium / WebDriver command with timing and arguments
• Android logcat and iOS syslog device logs per test
• HTTP network traffic captured via CDP, safariNetwork, or proxy fallback
• Device screenshots and screen video recordings
• CI/CD integration metadata

Why TestRelic?

Modern applications run in browsers and on mobile devices. Understanding test failures in either environment requires more context than just an error message. TestRelic provides that context by:

1. Execution Timeline — See exactly which pages your browser tests visited, or which Appium commands your mobile tests issued, and in what order
2. Network Insights — Understand HTTP traffic for both browser and mobile sessions
3. Device Observability — Stream Android logcat and iOS syslog logs aligned to individual test cases
4. Failure Context — Get code snippets and screenshots showing exactly where tests failed
5. CI Integration — Automatically capture CI metadata for correlation with builds

Key Features

Automatic Navigation Tracking (Playwright)

Simply use the TestRelic fixture in your Playwright tests and navigation is tracked automatically:

import { test, expect } from '@testrelic/playwright-analytics/fixture';

test('user journey', async ({ page }) => {
  await page.goto('https://example.com');
  await page.click('a[href="/products"]');
  await page.click('.product:first-child');
  // All navigations tracked automatically!
});

Mobile Test Observability (Appium)

Add TestRelicService and TestRelicReporter to your WDIO config and every Appium command, device log, and network request is captured automatically:

import { TestRelicService } from '@testrelic/appium-analytics/service';
import { TestRelicReporter } from '@testrelic/appium-analytics';

// In your wdio.conf.ts
services: [[TestRelicService, { includeDeviceLogs: true, includeNetworkLogs: true }]],
reporters: [[TestRelicReporter, { htmlReportPath: './test-results/report.html' }]],

Interactive HTML Reports

Both reporters generate self-contained interactive HTML reports with a timeline view for commands, logs, network requests, screenshots, and video — no server required.

Cloud Platform

Upload results to the TestRelic cloud platform to unlock:

• Org-wide test run history and health metrics
• AI-powered session insights and Ask AI chat
• Smoke, regression, and nightly observatory monitoring
• Integrations with GitHub Actions, Jira, Grafana Loki, and Amplitude

CI/CD Ready

TestRelic automatically detects your CI environment and captures:

• Build ID and run number
• Commit SHA and branch name
• CI provider information

Supports GitHub Actions, GitLab CI, Jenkins, CircleCI, and more.

Mobile and Maestro beyond Playwright

Browser coverage is only part of modern quality engineering. For Appium on Android and iOS, the @testrelic/appium-analytics package pairs with WebdriverIO as documented under Appium Introduction and Appium Installation. For Maestro mobile flows, see Maestro Introduction and Maestro Installation. Each stack produces timelines, logs, and media aligned to how that framework actually executes commands—so mobile engineers get parity with the Playwright observability story.

Plans: when cloud AI features unlock

The Introduction compares Starter and Growth plans at a glance (monthly prices, storage, retention, and which tier includes AI insights and Ask AI). Use that table alongside Plans & Billing when procurement asks what changes if you upgrade for Ask AI, session insights, or higher retention limits.

Capability (high level)	Starter	Growth
SDK reporters (Playwright + Appium)	Yes	Yes
Cloud platform	Yes	Yes
AI insights & Ask AI	—	Yes
Storage	500 MB	1 GB
Data retention	14 days	30 days

(Figures from the Introduction page; see Plans & Billing for the authoritative, up-to-date commercial terms.)

Deeper reads on this blog

For narrative guides that span multiple top-level doc areas:

• Playwright testing observability — timelines, unified reports, configuration, and cloud paths.
• TestRelic MCP for AI assistants — hosted vs stdio MCP, tokens, caps, verification.
• Ask AI and org test context — @ mentions, artifacts, streaming, and how Ask AI differs from MCP.

Getting Started

Ready to add TestRelic to your project? It only takes a few minutes.

For Playwright browser testing:

npm install @testrelic/playwright-analytics

Configure the reporter in playwright.config.ts and run npx playwright test.

For Appium mobile testing:

npm install @testrelic/appium-analytics
npm install --save-dev webdriverio @wdio/reporter

Configure TestRelicService and TestRelicReporter in your wdio.conf.ts and run npx wdio run wdio.conf.ts.

Check out the Getting Started guide for complete setup instructions for both frameworks.

What's in the Documentation?

Our documentation covers everything you need:

• Getting Started — Quick installation and setup guide for Playwright and Appium
• Packages — Detailed reference for @testrelic/playwright-analytics and @testrelic/appium-analytics
• Configuration — All available options and how to use them
• Advanced — Merging shard reports and advanced use cases
• Examples — Real-world examples for browser and mobile testing
• Cloud Platform — Full reference for the TestRelic cloud application

Free to Use

TestRelic is free to use and published under the MIT license. Get started today and enhance your test observability!

• npm (Playwright): @testrelic/playwright-analytics
• npm (Appium): @testrelic/appium-analytics
• Support: Contact us for questions or feature requests

What's Next?

• Browse the documentation to learn more
• Try the getting started guide to set up your framework
• Explore the configuration options for the Playwright reporter
• See the Appium package reference for mobile testing
• Check out examples to see TestRelic in action
• Connect your IDE assistant with the MCP overview and quickstart
• Open Ask AI on a Growth plan for conversational suite analysis
• Skim the blog index for opinionated learning paths across the doc set

FAQ: Is TestRelic only for Playwright?

No. Playwright is the default browser story in much of the docs, but Appium and Maestro packages and guides are first-class—see links in this article and the sidebars.

FAQ: Do I need the cloud to get value?

No. Reporters generate local JSON and HTML reports without signup. The cloud adds org history, AI, monitoring, and integrations—see Cloud Platform Overview.

FAQ: Where is the MIT license stated?

The Get Started page notes TestRelic is free to use under the MIT license for the SDK workflow described there.

We're excited to see what you build with TestRelic!