You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
ref(replay): Refactor pages inside the Product Walkthrough > Replay area (#14712)
Inside `/product/explore/session-replay/` i noticed we had sort of two
paths for users to follow: web or mobile. There was a lot of the same
information in each side, but they were not structured in the same way.
So i tried to merge things together where it makes sense, and keep the
web vs. mobile split for as few things as possible.
The big change is that mobile doesn't have it's own `## Replay Details`
section anymore. And `replay-details.mdx` is less web-specific.
Now we have:
- unified `Replays Page and Filters` docs
- unified `Replays Details` docs
- high-level `Replay for Web` page with "What is Replay", "Supported
SDKs", "Backend Errors" sections, performance sub-page
- high-level `Replay for Mobile` page with "What is Replay", "Supported
SDKs", "Backend Errors" sections (also FAQ), performance sub-page
<img width="301" height="225" alt="SCR-20250825-njmd"
src="https://github.com/user-attachments/assets/b09e3580-d218-4085-a6a4-8787737598ca"
/>
<img width="303" height="228" alt="SCR-20250825-njmz"
src="https://github.com/user-attachments/assets/0535f311-3190-470d-99c9-cd6cf48aaff7"
/>
---------
Co-authored-by: Jasmin <77064737+jas-kas@users.noreply.github.com>
Co-authored-by: Michelle Zhang <56095982+michellewzhang@users.noreply.github.com>
Copy file name to clipboardExpand all lines: docs/product/explore/session-replay/index.mdx
+3-6Lines changed: 3 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,11 +6,8 @@ description: "Use Session Replay to get reproductions of user sessions to improv
6
6
7
7
Sentry supports Session Replay for Web and Mobile. This includes browser-based applications and certain native mobile platforms, such as Android, iOS, and React Native. Both versions of Replay (Web and Mobile) are generally available and stable.
8
8
9
-
For browser-based applications (Web replay), this includes static websites, single-page applications, and also server-side rendered applications -- for example, platforms such as Electron, Next.js, and Remix.
9
+
For browser-based applications, this includes static websites, single-page applications, and also server-side rendered applications -- for example, platforms such as Electron, Next.js, and Remix.
10
10
11
-
To learn more about which SDKs we support, please visit our docs for [Web](web/getting-started/#supported-sdks) and [Mobile](mobile/#sdks-supported).
11
+
To learn more about which SDKs we support, please visit our docs for [Web](web/#supported-sdks) and [Mobile](mobile/#supported-sdks).
Every replay has a detailed view that contains the embedded video player and rich debugging context. Playing back the video will allow you to see every user interaction in relation to network requests, frontend and backend errors, backend spans, and more. Almost every component on this page is connected through timestamps.
26
-
27
-
The below list shows the breakdown of each component and why it’s valuable:
28
-
29
-
-**Breadcrumbs:** The replay breadcrumbs show when key user interactions took place, specifically: user taps with the relevant component, navigations, when the user put the app in background or foreground, and [custom breadcrumbs](/product/sentry-basics/integrate-backend/configuration-options/#breadcrumbs) set by your organization. Breadcrumbs also provide insight into the device of a given user session at particular timestamps:
30
-
- `device battery` (when battery level or charging status changes)
31
-
- `orientation` (when the user rotates the device)
32
-
- `connectivity` (when this status changes between wifi, cellular, and offline).
33
-
34
-
These breadcrumbs are synced with the replay player and will auto-scroll as the video plays. Some [breadcrumb types](/product/issues/issue-details/breadcrumbs/) visible in Issue Details are not 1:1 to the replay breadcrumbs list. On the Replay Details page, the trail of events typically seen in the Issue Details page are instead displayed in the Network and Console components.
35
-
36
-
37
-
-**Timeline:** This is the section at the bottom of the Replay Details page that illustrates where significant events (such as errors, device battery, and user interactions) happen over the course of the replay. This allows users to easily scrub to key events by dragging across the timeline. It also visually conveys the amount of time that took place between events and has a zoom functionality so you can easily zoom-in to distinguish between events that happened close together.
38
-
39
-
-**Network:** This is a list of all network requests that were initiated by the app while the replay recording was active. As the video plays, there’s a visual indicator that tracks through the table of network requests, highlighting which requests happened prior to, or next to this point in the video. When a request fails, it is highlighted in red. You can also click the timestamp on the far right of each request to bring yourself to that point in the replay player.
40
-
41
-
-**Console:** Some debugging messages that don't belong in the breadcrumb list will show up here. For example, a custom `console.log` in React Native. Logs from [Logcat](https://docs.sentry.io/platforms/android/integrations/logcat/) and [Timber](https://docs.sentry.io/platforms/android/integrations/timber/) are also supported and will show up here.
42
-
43
-
-**Errors:** All the errors that occurred in the replay (including in your backend), with links to the corresponding events and [issue(s)](/product/issues/issue-details/error-issues/), as well as the impact these issues have had holistically across all users on your application, seen when you hover over the issue ID.
44
-
45
-
-**Tags:** A complete list of built-in fields and custom tags associated with a replay, such as operating system version and name, device specs, release, and user details.
46
-
47
-
-**Trace:** A view that connects all the [trace(s)](/product/sentry-basics/tracing/distributed-tracing/#traces-transactions-and-spans) that happened during the replay.
48
-
49
-
## SDKs Supported
23
+
## Supported SDKs
50
24
51
25
Session Replay for mobile is currently available for Android and iOS on both native SDKs, as well as for React Native and Flutter.
52
26
@@ -57,6 +31,56 @@ We recommend updating to the latest version, but the minimum versions supported
Every replay has a detailed view that contains the embedded video player and rich debugging context. Playing back the video will allow you to see every user interaction in relation to frontend and backend errors, console messages, DOM events, network requests and more depending on your platform. It’s like having [DevTools](https://developer.chrome.com/docs/devtools/overview/) active for your production user sessions. Almost every component on this page is connected through timestamps. See the breakdown of each component and why it’s valuable:
10
+
11
+
12
+
13
+
-**Replay Player:** Video-like reproduction of a user session. This is where you can visualize exactly what actions the user took during a user session and how the application behaved within this specific user’s environment, including device, OS, latency, settings, and so on. Most importantly, you can see which actions led to an error, which takes the guesswork out of debugging.
14
+
- By default, the Session Replay SDK is configured to redact all text, user input, and media elements. See all privacy configuration options [here](/platform-redirect/?next=/session-replay/privacy/).
15
+
16
+
***Breadcrumbs:** The replay breadcrumbs show when key user interactions took place. Breadcrumbs are synced with the replay player and will auto-scroll as the video plays.
17
+
Specifically:
18
+
-**User Clicks or Taps:** including rage and dead clicks on Web.
19
+
-**Navigations, Page Loads, & View Changes:**[Learn more about spans](/product/sentry-basics/distributed-tracing/).
20
+
-**Mobile specific:** Backgrounding as well as foregrounding, network connectivity, and battery usage.
21
+
-**Web Vitals:** and an overall performance score [Learn more](/product/insights/web-vitals/)
22
+
-**Custom Breadcrumbs:** Learn more about configuring [custom breadcrumbs](/product/sentry-basics/integrate-backend/configuration-options/#breadcrumbs).
23
+
24
+
Some [breadcrumb types](/product/issues/issue-details/breadcrumbs/) visible in **Issue Details** are not 1:1 to the replay breadcrumbs list. The trail of events typically seen in the Issue Details page are now displayed in the Console and Network components of the **Replay Details** page.
25
+
26
+
-**Timeline:** This section at the bottom of the **Replay Details** page illustrates where significant events (such as errors, user interactions, and more) happen over the course of the replay. This allows users to easily scrub to key events by dragging across the timeline. It also visually conveys the amount of time that took place between events and has a zoom functionality, so you can easily zoom in to distinguish between events that happen close together.
27
+
28
+
***Console:** A list of debugging messages that don't belong in the breadcrumbs list will appear here. For web, this includes `console.log` statements and browser-generated messages to the developer. For React Native, custom `console.log` will appear here, and in Android, logs from [Logcat](/platforms/android/integrations/logcat/) and [Timber](/platforms/android/integrations/timber/) are also supported.
29
+
30
+
-**Network:** A list of all network requests that were initiated by the app while the replay recording was active. As the video plays, there is a visual indicator that tracks through the table of network requests, highlighting which requests happened prior to or next to this point in the video. You can also click the timestamp on the far right of each request to bring yourself to that point in the replay player. If configured for web, Sentry can also show the actual [HTTP request body and headers](/platform-redirect/?next=/session-replay/configuration/#network-details).
31
+
32
+
-**Errors:** See all the errors that occurred in the replay (including in your backend), with links to the corresponding events and [issue(s)](/product/issues/issue-details/error-issues/), as well as the impact these issues have had holistically across all users on your application.
33
+
34
+
-**Trace:** Connects all the [trace(s)](/product/sentry-basics/tracing/distributed-tracing/#traces-transactions-and-spans) that happened during the replay.
35
+
- Due to transaction sampling, this view may be missing traces.
36
+
37
+
-**Memory (web):** The view shows a heap size chart displaying the total amount of memory being used by JavaScript objects.
38
+
- This view is only available when the replay was recorded on a Chromium-based browser.
39
+
40
+
-**Tags:** A complete list of built-in fields and custom tags associated with a replay, such as operating system version and name, device specs, release, and user details.
41
+
42
+
43
+
## Share Replays
44
+
45
+
Share a replay at a specific timestamp with a Sentry member by clicking the “Share” button in the top-right corner of the **Replay Details** page. This allows you to share replays at the point of a critical event or user flow with other Sentry members in your organization.
46
+
47
+
48
+
49
+
## Delete Replays
50
+
51
+
Delete an individual replay by clicking the “Delete” button in the top-right corner of **the Replay Details** page. You cannot delete replays that are in progress. Please note that deleting replays does not affect your quota.
52
+
53
+
## Tags
54
+
55
+
Find a complete list of built-in fields and custom tags associated with a replay under the “Tags” tab for additional context around the replay you’re viewing.
56
+
57
+
58
+
59
+
## Retention
60
+
61
+
Replays are retained for 90 days in Sentry for paid plans (the same retention period as other event types, such as Errors and Transactions). For free plans, replays are retained for 30 days in Sentry. The retention period is not configurable.
62
+
63
+
## Inbound Filtering
64
+
65
+
If you've chosen not to capture certain errors by applying any of the below inbound filter rules, those same rules will also apply to Session Replays.
66
+
67
+
- IP Addresses
68
+
- Releases
69
+
- Request URLs
70
+
- User-Agents
71
+
72
+
**Note**: Because filtered outcomes are emitted per **segment** whereas successful outcomes are emitted per **replay** (a replay being a collection of segments), you may see a noticeable increase in filtered outcomes on your [Stats](https://sentry.io/orgredirect/organizations/:orgslug/stats) page. This is not an error.
Copy file name to clipboardExpand all lines: docs/product/explore/session-replay/replay-page-and-filters.mdx
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
---
2
2
title: "Replays Page and Filters"
3
-
sidebar_order: 12
3
+
sidebar_order: 71
4
4
description: "Learn how to navigate the Replays page and filter user sessions that meet specific conditions."
5
5
---
6
6
@@ -11,22 +11,22 @@ You can search for or browse replays of user sessions on the **Replay** page, wh
11
11
-**Project**: The project in which the session was recorded.
12
12
-**Start Time**: How long ago the replay was triggered. (Replays can appear here while the recording is still in progress.)
13
13
-**Duration**: The length of the replay. (Recordings can range from 1 second to 60 minutes.)
14
-
-**Errors:** The number of frontend errors identified by Sentry, as encountered in the replay. (Sometimes the error count reported is different from the actual errors captured. Read more in [Error Linking](/platforms/javascript/session-replay/#error-linking).)
14
+
-**Errors:** The number of frontend errors identified by Sentry, as encountered in the replay. (Sometimes the error count reported is different from the actual errors captured. Read more in [Error Linking](/platform-redirect/?next=/session-replay/#error-linking).)
15
15
-**Activity**: The activity level as determined by the number of errors encountered, their duration, and the number of UI events.
16
16
-**Dead Clicks**: User clicks on `a` and `button` tags that do not result in any page activity after 7 seconds (i.e. no HTML was added, removed, or updated; no visual changes were observed in the page).
17
17
-**Rage Clicks**: Five or more clicks on a dead element (it exhibits no page activity after 7 seconds.) Rage clicks are a subset of dead clicks.
18
18
19
19
The **Replay** page also has two widgets titled "Most Dead Clicks" and "Most Rage Clicks" that show the selectors with the most rage or dead clicks. Expanding the selector will show example replays where that selector was clicked. You can also click the "See all selectors" button to view all selectors that have gotten rage or dead clicks. SDK version `7.60.1` or higher is required to see rage and dead click data on the **Replay** page.
20
20
21
-
By default, the IP address is used to identify each replay on this page. This can be changed in your organization and project settings. If you’d like to set an email or a username instead, call [Sentry.setUser()](/platforms/javascript/enriching-events/identify-user) in your client-side configuration.If you’ve enabled the option to “Prevent Storing of IP Addresses” in either your project-level or organization-wide settings, the IP address will appear redacted on the **Replay** page. For more information, read about [several data scrubbing options](/security-legal-pii/scrubbing/server-side-scrubbing/) in the Sentry app on either an organization-wide or a project level.
21
+
By default, the IP address is used to identify each replay on this page. This can be changed in your organization and project settings. If you’d like to set an email or a username instead, call [Sentry.setUser()](/platform-redirect/?next=/enriching-events/identify-user) in your client-side configuration.If you’ve enabled the option to prevent storing of IP addresses in either your project-level or organization-wide settings, the IP address will appear redacted on the **Replay** page. For more information, read about [several data scrubbing options](/security-legal-pii/scrubbing/server-side-scrubbing/) in the Sentry app on either an organization or a project level.
22
22
23
23
Replays can appear on this page while they’re still in progress. You can’t delete in-progress replays.
24
24
25
25
Each replay will bring users to the [**Replay Details**](/product/explore/session-replay/web/replay-details/) page.
26
26
27
27
## Filtering Replays
28
28
29
-
All replays have built-in key fields, and may have [custom tags](/platforms/javascript/enriching-events/tags/) if you have them set up. The search bar operates similarly to the one in the Discover [Query Builder](/product/explore/discover-queries/query-builder/#filter-by-search-conditions). Use it to enter these keys and assign them values. This will filter down your list of replays so you can quickly find the ones with the criteria you care about. For example, you can refine your replays search to a specific browser by using `browser.version:` as a key field and assigning the version as a value. For a list of all the built-in key fields/replay properties, check out our [Searchable Properties](/concepts/search/searchable-properties/#replay-properties) documentation.
29
+
All replays have built-in key fields, and may have [custom tags](/platform-redirect/?next=/enriching-events/tags/) if you have them set up. The search bar operates similarly to the one in the Discover [Query Builder](/product/explore/discover-queries/query-builder/#filter-by-search-conditions). Use it to search for keys and specific values. This will filter down your list of replays so you can quickly find the ones with the criteria you care about. For example, you can refine your replays search to a specific browser by using `browser.version:` as a key field and assigning the version as a value. For a list of all the built-in key fields and replay properties, check out our [Searchable Properties](/concepts/search/searchable-properties/session-replay/) documentation.
30
30
31
31
32
32
@@ -40,8 +40,8 @@ To delete a [single replay](/product/explore/session-replay/web/replay-details/#
40
40
41
41
To delete multiple replays at once, go to the **Replay** page and use the checkboxes next to each replay row to select the ones you want to delete. Then, click the "Delete" button to remove the selected replays. Deleting a large number of replays takes some time to complete. If a job is running you will see a banner at the top of the Replay list and a link to 'Track Progress'. You can also visit Settings > Project > MyProject > Replays to see the history of previous deletion jobs.
42
42
43
-
43
+
44
44
45
45
Alternatively, you can delete all replays that match a search query by clicking "Select all" at the top of the results list. This selects every replay matching the current filters, not just those visible on the page.
0 commit comments