Skip to content

Commit d33a360

Browse files
sfanahataShannon Anahatamichellewzhang
authored
feat(replay): session replay updates to add AI summary for web (#14794)
**Waiting to merge when officially goes open beta** closes https://linear.app/getsentry/issue/REPLAY-528/add-docs ## DESCRIBE YOUR PR Updating the replay details and web replay pages to add in AI summaries info. Details page: https://sentry-docs-git-session-replay-ai-summary-ea.sentry.dev/product/explore/session-replay/replay-details/ Replay for web: https://sentry-docs-git-session-replay-ai-summary-ea.sentry.dev/product/explore/session-replay/web/ ## IS YOUR CHANGE URGENT? Help us prioritize incoming PRs by letting us know when the change needs to go live. - [ ] Urgent deadline (GA date, etc.): <!-- ENTER DATE HERE --> - [] Other deadline: - [x] None: Waiting on official EA (open beta) release ## SLA - Teamwork makes the dream work, so please add a reviewer to your PRs. - Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it. Thanks in advance for your help! ## PRE-MERGE CHECKLIST *Make sure you've checked the following before merging your changes:* - [ ] Checked Vercel preview for correctness, including links - [ ] PR was reviewed and approved by any necessary SMEs (subject matter experts) - [ ] PR was reviewed and approved by a member of the [Sentry docs team](https://github.com/orgs/getsentry/teams/docs) --------- Co-authored-by: Shannon Anahata <[email protected]> Co-authored-by: Michelle Zhang <[email protected]>
1 parent bcc8874 commit d33a360

File tree

9 files changed

+104
-36
lines changed

9 files changed

+104
-36
lines changed
124 KB
Loading
153 KB
Loading
301 KB
Loading
220 KB
Loading

docs/product/explore/session-replay/replay-details.mdx

Lines changed: 97 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -6,61 +6,123 @@ description: "Learn more about how information is organized on the Replay Detail
66

77
<Include name="session-replay-web-report-bug.mdx" />
88

9-
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. Its 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:
9+
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.
1010

1111
![Session Replay details user interface](./img/replay-details.png)
1212

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/).
13+
## Components Overview
1514

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).
15+
### Replay Player
2316

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.
17+
The video-like reproduction of a user session allows you to visualize exactly what actions the user took during their session and how the application behaved within their specific environment, including device, OS, latency, settings, and more. Most importantly, you can see which actions led to an error, which takes the guesswork out of debugging.
2518

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.
19+
<Alert>
2720

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.
21+
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/).
2922

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).
23+
</Alert>
3124

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.
25+
### AI-Powered Replay Summary [Web Only]
3326

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.
27+
<Alert>
28+
This feature is currently in Beta, which means that this feature is still in-progress and may have bugs. We recognize the irony.
29+
</Alert>
3630

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.
31+
Sentry now provides **AI-powered replay summaries** that automatically analyze what happened during a user session and give you a short play-by-play to help debug issues faster. Rather than watch an entire replay, you can now get a quick overview of what happened and focus on the specific interactions that led to the issue. This tab includes:
3932

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.
33+
- **AI Summary:** An LLM-powered description of the user's journey
34+
- **Chapters:** Each chapter summarizes related sets of breadcrumbs, network requests, and console logs, ordered by time range. Click a chapter to expand its contents and see the underlying events. Red chapters highlight errors, pink chapters highlight feedback
4135

36+
### Breadcrumbs
4237

43-
## Share Replays
38+
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.
4439

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.
40+
**Both web and mobile replays include:**
41+
- **Custom Breadcrumbs:** Learn more about configuring [custom breadcrumbs](/product/sentry-basics/integrate-backend/configuration-options/#breadcrumbs)
4642

47-
![Highlight the button to share a replay](./img/replay-details-share.png)
43+
**Web-specific breadcrumbs include:**
44+
- **User Clicks:** including [rage clicks](/product/issues/issue-details/replay-issues/rage-clicks/) and [dead clicks](/product/issues/issue-details/replay-issues/rage-clicks/#detection-criteria)
45+
- **Navigations and Page Loads:** [Learn more about spans](/product/sentry-basics/distributed-tracing/)
46+
- **Web Vitals:** and an overall performance score [Learn more](/product/insights/web-vitals/)
47+
48+
**Mobile-specific breadcrumbs include:**
49+
- Backgrounding and foregrounding
50+
- Network connectivity changes
51+
- Battery usage
52+
53+
<Alert>
54+
55+
Some [breadcrumb types](/product/issues/issue-details/breadcrumbs/) visible in **Issue Details** are not a one-to-one representation of 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.
56+
57+
</Alert>
58+
59+
### Timeline
60+
61+
The timeline 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.
62+
63+
### Console
64+
65+
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.
66+
67+
### Network
68+
69+
This tab contains 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.
70+
71+
<Alert>
72+
73+
If configured for web, Sentry can also show the actual [HTTP request body and headers](/platform-redirect/?next=/session-replay/configuration/#network-details).
74+
75+
</Alert>
76+
77+
### Errors
78+
79+
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.
80+
81+
### Trace
4882

49-
## Delete Replays
83+
Connects all the [trace(s)](/product/sentry-basics/tracing/distributed-tracing/#traces-transactions-and-spans) that happened during the replay.
5084

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.
85+
<Alert>
5286

53-
## Tags
87+
Due to transaction sampling, this view may be missing traces.
5488

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.
89+
</Alert>
5690

57-
![Highlight the button to share a replay](./img/replay-details-tags.png)
91+
### Memory [Web Only]
5892

59-
## Retention
93+
The view shows a heap size chart displaying the total amount of memory being used by JavaScript objects.
94+
95+
<Alert>
96+
97+
This view is only available when the replay was recorded on a [Chromium-based](https://www.chromium.org/chromium-projects/) browser.
98+
99+
</Alert>
100+
101+
### Tags
102+
103+
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.
104+
105+
![Tags tab on Replay Details.](./img/replay-details-tags.png)
106+
107+
## Replay Actions
108+
109+
### Share Replays
110+
111+
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.
112+
113+
![Highlight the button to share a replay](./img/replay-details-share.png)
114+
115+
### Delete Replays
116+
117+
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. **Deleting replays does not affect your quota.**
118+
119+
## Retention and Filtering
120+
121+
### Retention
60122

61123
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.
62124

63-
## Inbound Filtering
125+
### Inbound Filtering
64126

65127
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.
66128

@@ -69,4 +131,8 @@ If you've chosen not to capture certain errors by applying any of the below inbo
69131
- Request URLs
70132
- User-Agents
71133

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.
134+
<Alert>
135+
136+
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.
137+
138+
</Alert>

docs/product/explore/session-replay/replay-page-and-filters.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ You can search for or browse replays of user sessions on the **Replay** page, wh
1212
- **Start Time**: How long ago the replay was triggered. (Replays can appear here while the recording is still in progress.)
1313
- **Duration**: The length of the replay. (Recordings can range from 1 second to 60 minutes.)
1414
- **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-
- **Activity**: The activity level as determined by the number of errors encountered, their duration, and the number of UI events.
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-
- **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.
15+
- **Activity**: The activity level as determined by the number of errors encountered, their duration, and the number of UI events
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+
- **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
1818

1919
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.
2020

246 KB
Loading
67.9 KB
Loading

docs/product/explore/session-replay/web/index.mdx

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,17 @@ sidebar_order: 10
44
description: "Learn about Session Replay and its video-like reproductions of user interactions, which can help you see when users are frustrated and build a better web experience."
55
---
66

7-
Session Replay allows you to see video-like reproductions of user sessions which can help you understand what happened before, during, and after an error or performance issue occurred. You'll be able to gain deeper debugging context into issues so that you can reproduce and resolve problems faster without the guesswork. As you play back each session, you'll be able to see every user interaction in relation to network requests, DOM events, and console messages. It’s effectively like having [DevTools](https://developer.chrome.com/docs/devtools/overview/) active in your production user sessions.
7+
Session Replay allows you to see video-like reproductions of user sessions which can help you understand what happened before, during, and after an error or performance issue occurred. You'll be able to gain deeper debugging context into issues so that you can reproduce and resolve problems faster without the guesswork. As you play back each session, you'll be able to see every user interaction in relation to network requests, DOM events, and console messages. It’s effectively like having [DevTools](https://developer.chrome.com/docs/devtools/overview/) active in your production user sessions.
8+
9+
Session Replay for web now includes an AI-powered replay summary that automatically analyzes what happened during a user session, and gives a short play-by-play to help debug issues faster. Rather than watch an entire replay, you can now get a quick overview of what happened and focus on the specific interactions that led to the issue. **Note: This feature is currently in Beta, which means that this feature is still in-progress and may have bugs. We recognize the irony.**
810

911
Replays are integrated with other parts of the Sentry product so you can see how the user experience is impacted by errors and slow transactions. You'll see session replays associated with error events on the [Issue Details](/product/issues/issue-details/) page, and those associated with slow transactions on the [Transaction Summary](/product/insights/overview/transaction-summary/) page. For [backend error replays](/product/explore/session-replay/web/getting-started/#replays-for-backend-errors), any contributing backend errors will be included in the replay's timeline, [breadcrumbs](/product/issues/issue-details/breadcrumbs/), and errors.
1012

1113
![Session Replay User Interface](./img/session-replay.png)
1214

1315
## What is Session Replay?
1416

15-
A session replay is **not** a video recording. It’s a video-like reproduction of a user session, built using the [rrweb recording library](https://www.rrweb.io/). Replays are created from snapshots of your web application’s DOM state (the browser’s in-memory representation of HTML). When each snapshot is played back, you will see a video-like recording of what the user did throughout their entire session. The user session includes any pageloads, refreshes, and navigations that happened while the user was on your site.
17+
A session replay is **not** a video recording. It’s a video-like reproduction of a user session, built using the [rrweb recording library](https://www.rrweb.io/). Replays are created from snapshots of your web application’s DOM state (the browser’s in-memory representation of HTML). When each snapshot is played back, you'll see a video-like recording of what the user did throughout their entire session. The user session includes any pageloads, refreshes, and navigations that happened while the user was on your site.
1618

1719
![Session Replay User Interface](./img/session-replay-what-is-a-replay.png)
1820

0 commit comments

Comments
 (0)