149 lines
5.7 KiB
Markdown
149 lines
5.7 KiB
Markdown
---
|
|
name: sentry-cli-replay
|
|
version: 0.33.0
|
|
description: Search and inspect Session Replays
|
|
requires:
|
|
bins: ["sentry"]
|
|
auth: true
|
|
---
|
|
|
|
# Replay Commands
|
|
|
|
Search and inspect Session Replays
|
|
|
|
### `sentry replay list <org/project>`
|
|
|
|
List recent Session Replays
|
|
|
|
**Flags:**
|
|
- `-n, --limit <value> - Number of replays (1-1000) - (default: "25")`
|
|
- `-q, --query <value> - Search query (Sentry replay search syntax)`
|
|
- `-e, --environment <value>... - Filter by environment (repeatable, comma-separated)`
|
|
- `-s, --sort <value> - Sort by: date, oldest, duration, errors, activity, or a raw replay sort field - (default: "date")`
|
|
- `-t, --period <value> - Time range: "7d", "2026-04-01..2026-05-01", ">=2026-04-01" - (default: "7d")`
|
|
- `-f, --fresh - Bypass cache, re-detect projects, and fetch fresh data`
|
|
- `-c, --cursor <value> - Navigate pages: "next", "prev", "first" (or raw cursor string)`
|
|
|
|
**JSON Fields** (use `--json --fields` to select specific fields):
|
|
|
|
| Field | Type | Description |
|
|
|-------|------|-------------|
|
|
| `activity` | number \| null | Replay activity score |
|
|
| `browser` | object \| null | Browser metadata |
|
|
| `count_dead_clicks` | number \| null | Dead click count |
|
|
| `count_errors` | number \| null | Associated error count |
|
|
| `count_infos` | number \| null | Info event count |
|
|
| `count_rage_clicks` | number \| null | Rage click count |
|
|
| `count_segments` | number \| null | Recording segment count |
|
|
| `count_urls` | number \| null | Visited URL count |
|
|
| `count_warnings` | number \| null | Warning event count |
|
|
| `device` | object \| null | Device metadata |
|
|
| `dist` | string \| null | Distribution |
|
|
| `duration` | number \| null | Replay duration in seconds |
|
|
| `environment` | string \| null | Environment |
|
|
| `error_ids` | array | Linked error IDs |
|
|
| `finished_at` | string \| null | Replay finish timestamp |
|
|
| `has_viewed` | boolean \| null | Whether the current user has viewed the replay |
|
|
| `id` | string | Replay ID |
|
|
| `info_ids` | array | Linked info event IDs |
|
|
| `is_archived` | boolean \| null | Archived flag |
|
|
| `os` | object \| null | Operating system metadata |
|
|
| `ota_updates` | object \| null | OTA update metadata |
|
|
| `platform` | string \| null | Platform |
|
|
| `project_id` | string \| null | Numeric project ID |
|
|
| `releases` | array | Associated releases |
|
|
| `sdk` | object \| null | SDK metadata |
|
|
| `started_at` | string \| null | Replay start timestamp |
|
|
| `tags` | object | Replay tags |
|
|
| `trace_ids` | array | Linked trace IDs |
|
|
| `urls` | array | Visited URLs |
|
|
| `user` | object \| null | User metadata |
|
|
| `warning_ids` | array | Linked warning event IDs |
|
|
|
|
**Examples:**
|
|
|
|
```bash
|
|
# List recent replays for a project
|
|
sentry replay list my-org/frontend
|
|
|
|
# Search across all projects in an org
|
|
sentry replay list my-org/ --query "environment:production"
|
|
|
|
# Change the time window and sort
|
|
sentry replay list my-org/frontend --period 24h --sort errors
|
|
|
|
# Paginate through results
|
|
sentry replay list my-org/frontend -c next
|
|
sentry replay list my-org/frontend -c prev
|
|
|
|
# Output machine-readable data
|
|
sentry replay list my-org/frontend --json
|
|
```
|
|
|
|
### `sentry replay view <replay-id-or-url...>`
|
|
|
|
View a Session Replay
|
|
|
|
**Flags:**
|
|
- `-w, --web - Open in browser`
|
|
- `-f, --fresh - Bypass cache, re-detect projects, and fetch fresh data`
|
|
|
|
**JSON Fields** (use `--json --fields` to select specific fields):
|
|
|
|
| Field | Type | Description |
|
|
|-------|------|-------------|
|
|
| `activity` | array | Summarized replay activity |
|
|
| `browser` | object \| null | Browser metadata |
|
|
| `count_dead_clicks` | number \| null | Dead click count |
|
|
| `count_errors` | number \| null | Associated error count |
|
|
| `count_infos` | number \| null | Info event count |
|
|
| `count_rage_clicks` | number \| null | Rage click count |
|
|
| `count_segments` | number \| null | Recording segment count |
|
|
| `count_urls` | number \| null | Visited URL count |
|
|
| `count_warnings` | number \| null | Warning event count |
|
|
| `device` | object \| null | Device metadata |
|
|
| `dist` | string \| null | Distribution |
|
|
| `duration` | number \| null | Replay duration in seconds |
|
|
| `environment` | string \| null | Environment |
|
|
| `error_ids` | array | Linked error IDs |
|
|
| `finished_at` | string \| null | Replay finish timestamp |
|
|
| `has_viewed` | boolean \| null | Whether the current user has viewed the replay |
|
|
| `id` | string | Replay ID |
|
|
| `info_ids` | array | Linked info event IDs |
|
|
| `is_archived` | boolean \| null | Archived flag |
|
|
| `os` | object \| null | Operating system metadata |
|
|
| `ota_updates` | object \| null | OTA update metadata |
|
|
| `platform` | string \| null | Platform |
|
|
| `project_id` | string \| null | Numeric project ID |
|
|
| `releases` | array | Associated releases |
|
|
| `sdk` | object \| null | SDK metadata |
|
|
| `started_at` | string \| null | Replay start timestamp |
|
|
| `tags` | object | Replay tags |
|
|
| `trace_ids` | array | Linked trace IDs |
|
|
| `urls` | array | Visited URLs |
|
|
| `user` | object \| null | User metadata |
|
|
| `warning_ids` | array | Linked warning event IDs |
|
|
| `clicks` | array | Replay click summaries |
|
|
| `replay_type` | string \| null | Replay type |
|
|
| `org` | string | Organization slug |
|
|
| `relatedIssues` | array | Replay-related issues |
|
|
| `relatedTraces` | array | Replay-related traces |
|
|
|
|
**Examples:**
|
|
|
|
```bash
|
|
# View a replay by ID using auto-detected org/project context
|
|
sentry replay view 346789a703f6454384f1de473b8b9fcc
|
|
|
|
# View a replay with an explicit org
|
|
sentry replay view my-org/346789a703f6454384f1de473b8b9fcc
|
|
|
|
# View a replay with explicit org/project context
|
|
sentry replay view my-org/frontend/346789a703f6454384f1de473b8b9fcc
|
|
|
|
# Open a replay in the browser
|
|
sentry replay view my-org/346789a703f6454384f1de473b8b9fcc --web
|
|
```
|
|
|
|
All commands also support `--json`, `--fields`, `--help`, `--log-level`, and `--verbose` flags.
|