TestRelic for Appium Beta
TestRelic is an AI-driven Testing Observability Platform for engineering teams. The Appium SDK reporter captures rich test analytics from your Android and iOS mobile test runs and sends them to a cloud platform for AI analysis, monitoring, and integrations.
| Layer | What it is | Where it runs |
|---|---|---|
@testrelic/appium-analytics | WebdriverIO service + reporter — captures device logs, WebDriver commands, network traffic, screenshots, video, and CI metadata | Locally, alongside your Appium tests |
| Cloud Platform | Dashboard for visualizing test data, running AI analysis, monitoring quality gates, and connecting tools | testrelic.ai |
What does @testrelic/appium-analytics capture?
Add TestRelicService and TestRelicReporter to your wdio.conf.ts and they automatically:
- Capture every WebDriver command with timing, arguments, and category.
- Stream Android logcat and iOS syslog device logs per test.
- Intercept HTTP network traffic via CDP (Android),
safariNetwork(iOS), or proxy fallback. - Record device screenshots after every test, only on failure, or never.
- Record full screen video (optional).
- Detect CI environment context (GitHub Actions, GitLab CI, Jenkins, CircleCI).
- Upload structured test run data to the TestRelic cloud platform.
- Generate self-contained interactive HTML reports for offline use.
Requirements:
- Node.js ≥ 18 (Appium 3.x requires ≥ 20.19)
- WebdriverIO ≥ 9.0.0
- Appium 3.x
npm install @testrelic/appium-analytics
npm install --save-dev webdriverio @wdio/reporter
Use your AI assistant
Install @testrelic/appium-analytics in this WebdriverIO project and configure wdio.conf.ts:
- Add TestRelicService (from '@testrelic/appium-analytics/service') to services
with includeDeviceLogs: true and screenshotOnEvery: 'failure'
- Add TestRelicReporter (from '@testrelic/appium-analytics') to reporters
with outputPath: './test-results/testrelic-timeline.json' and openReport: true
- Add an onComplete hook: await TestRelicReporter.finalize(process.cwd())
Show me the complete updated wdio.conf.ts.
Cloud Platform
The TestRelic cloud platform (testrelic.ai) receives data from the SDK reporter and provides:
- Test Runs Dashboard — Run history with CI badges, filters, and session drill-down.
- Session Workspace — Inspect device commands, logs, screenshots, network traffic, and video timeline.
- AI Intelligence — Ask AI in natural language, get automated session insights, and generate test reports and plans.
- 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 for the full feature set.
Getting started
Local reporting only
Generate interactive HTML reports locally without the cloud platform:
- Install:
npm install @testrelic/appium-analytics - Add
TestRelicService+TestRelicReportertowdio.conf.ts - Run your tests — HTML reports are written to
./test-results/
With the cloud platform
Get AI insights, monitoring, and the full session workspace:
- Sign up at testrelic.ai
- Complete the onboarding wizard
- Add your API key to the reporter's
cloudconfig - Run your tests — data uploads automatically after
TestRelicReporter.finalize()
Plans
| Starter ($5/mo) | Growth ($20/mo) | |
|---|---|---|
| SDK reporters (Playwright + Appium) | ✓ | ✓ |
| Cloud platform | ✓ | ✓ |
| AI insights & Ask AI | — | ✓ |
| Storage | 500 MB | 1 GB |
| Data retention | 14 days | 30 days |
Testing with Playwright / browser?
For browser-based E2E testing with Playwright, see the Playwright Introduction.