-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Session Replay for mobile product docs #10628
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 1 commit
Commits
Show all changes
32 commits
Select commit
Hold shift + click to select a range
ff57cec
replay for mobile prod structure
bruno-garcia ab04d54
Update docs/product/explore/session-replay/web/index.mdx
jas-kas fab9949
Update docs/product/explore/session-replay/mobile/index.mdx
jas-kas d63c978
Update docs/product/explore/session-replay/web/index.mdx
jas-kas 12b0156
Update docs/product/explore/session-replay/index.mdx
jas-kas 6cfbc7e
Update docs/product/explore/session-replay/mobile/index.mdx
lizokm 8638306
Update docs/product/explore/session-replay/mobile/index.mdx
jas-kas 23cd78f
Update docs/product/explore/session-replay/mobile/index.mdx
jas-kas a3ed3fe
Update docs/product/explore/session-replay/mobile/index.mdx
jas-kas 403e71b
Update docs/product/explore/session-replay/mobile/index.mdx
jas-kas 244c392
Update docs/product/explore/session-replay/web/index.mdx
jas-kas fbd3aec
Update docs/product/explore/session-replay/web/index.mdx
jas-kas be5603c
Update docs/product/explore/session-replay/mobile/index.mdx
jas-kas 3d9e2b3
Update docs/product/explore/session-replay/mobile/index.mdx
jas-kas 70c1c97
Update docs/product/explore/session-replay/mobile/index.mdx
jas-kas 0f8ebf2
Update docs/product/explore/session-replay/mobile/index.mdx
jas-kas 50fe36a
Update docs/product/explore/session-replay/mobile/index.mdx
jas-kas da8ffa1
Update docs/product/explore/session-replay/mobile/index.mdx
jas-kas 088fcad
Update docs/product/explore/session-replay/mobile/index.mdx
jas-kas 238f535
Update docs/product/explore/session-replay/mobile/index.mdx
jas-kas 9ffbe5f
Update docs/product/explore/session-replay/mobile/index.mdx
jas-kas b9d997b
Update docs/product/explore/session-replay/mobile/index.mdx
jas-kas 8ad0a69
Merge branch 'master' into replay/mobile-product
bruno-garcia 74adb3a
fix frontmatter
bruno-garcia 66cb4de
console desc and min version
bruno-garcia 5cc9b10
index for session replay product docs
bruno-garcia 9039948
style
bruno-garcia 8bdecc4
style
bruno-garcia 24bd1fd
fix relative links
bruno-garcia 1fa49fc
Update docs/product/explore/session-replay/mobile/index.mdx
bruno-garcia 4b7bb3a
Update docs/product/explore/session-replay/mobile/index.mdx
bruno-garcia 7a20cb0
Apply suggestions from code review
bruno-garcia File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,41 +1,5 @@ | ||
| --- | ||
| title: "Session Replay" | ||
| sidebar_order: 70 | ||
| description: "Use Session Replay to get video-like reproductions of user interactions to improve your website or app experience." | ||
| description: "Sentry Session Replay for Web or Mobile applications." | ||
| --- | ||
bruno-garcia marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| <Include name="feature-stage-beta-session-replay.mdx" /> | ||
|
|
||
| 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. | ||
|
|
||
| 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/performance/transaction-summary/) page. For [backend error replays](/product/explore/session-replay/getting-started#replays-for-backend-errors), any contributing backend errors will be included in the replay's timeline, [breadcrumbs](https://docs.sentry.io/product/issues/issue-details/breadcrumbs/), and errors. | ||
|
|
||
|  | ||
|
|
||
| ## What Is a Session Replay? | ||
|
|
||
| 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. | ||
|
|
||
|  | ||
|
|
||
| The start of a session replay recording can be triggered by: | ||
|
|
||
| - A user session being part of a sampling rate, as controlled by [`replaysSessionSampleRate`](/platforms/javascript/session-replay/#sampling). (When a user loads a page, a decision is made whether to sample it or not.) | ||
| - An error occurring during a session that’s not being recorded. The session is then recorded based on [`replaysOnErrorSampleRate`](/platforms/javascript/session-replay/#sampling). | ||
| - Manually calling the [`replay.start()`](/platforms/javascript/session-replay/understanding-sessions/#manually-starting-replay) method. | ||
|
|
||
| The end of a session replay recording can be triggered by: | ||
|
|
||
| - User inactivity within the tab or page that’s being recorded. (It's considered inactivity when a user doesn’t click or navigate around the site for more than 15 minutes. Mouse scrolls, mouse movements, and keyboard events don’t currently qualify as activity.) | ||
| - A recording reaching the maximum replay duration limit. (Currently, this is 60 minutes.) | ||
| - Manually calling the [`replay.stop()`](/platforms/javascript/session-replay/understanding-sessions/#manually-stopping-replay) method. | ||
|
|
||
| <Note> | ||
|
|
||
| Unlike [sessions](/product/releases/health/#session) on the **Releases** page, user sessions in Session Replay can span multiple page loads. | ||
|
|
||
| </Note> | ||
|
|
||
| ## Learn More About Session Replay | ||
|
|
||
| <PageGrid /> | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| title: "Session Replay for Mobile" | ||
| sidebar_order: 20 | ||
| description: "Sentry Session Replay for Mobile applications." | ||
jas-kas marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| --- | ||
jas-kas marked this conversation as resolved.
Show resolved
Hide resolved
|
||
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| --- | ||
| title: "Session Replay for Web" | ||
| sidebar_order: 10 | ||
| description: "Use Session Replay to get video-like reproductions of user interactions to improve your website or app experience." | ||
jas-kas marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| --- | ||
|
|
||
| <Include name="feature-stage-beta-session-replay.mdx" /> | ||
|
|
||
| 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. | ||
|
|
||
| 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/performance/transaction-summary/) page. For [backend error replays](/product/explore/session-replay/getting-started#replays-for-backend-errors), any contributing backend errors will be included in the replay's timeline, [breadcrumbs](https://docs.sentry.io/product/issues/issue-details/breadcrumbs/), and errors. | ||
|
|
||
|  | ||
|
|
||
| ## What Is a Session Replay? | ||
|
|
||
| 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. | ||
|
|
||
|  | ||
|
|
||
| The start of a session replay recording can be triggered by: | ||
|
|
||
| - A user session being part of a sampling rate, as controlled by [`replaysSessionSampleRate`](/platforms/javascript/session-replay/#sampling). (When a user loads a page, a decision is made whether to sample it or not.) | ||
| - An error occurring during a session that’s not being recorded. The session is then recorded based on [`replaysOnErrorSampleRate`](/platforms/javascript/session-replay/#sampling). | ||
| - Manually calling the [`replay.start()`](/platforms/javascript/session-replay/understanding-sessions/#manually-starting-replay) method. | ||
|
|
||
| The end of a session replay recording can be triggered by: | ||
|
|
||
| - User inactivity within the tab or page that’s being recorded. (It's considered inactivity when a user doesn’t click or navigate around the site for more than 15 minutes. Mouse scrolls, mouse movements, and keyboard events don’t currently qualify as activity.) | ||
jas-kas marked this conversation as resolved.
Show resolved
Hide resolved
jas-kas marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| - A recording reaching the maximum replay duration limit. (Currently, this is 60 minutes.) | ||
| - Manually calling the [`replay.stop()`](/platforms/javascript/session-replay/understanding-sessions/#manually-stopping-replay) method. | ||
|
|
||
| <Note> | ||
|
|
||
| Unlike [sessions](/product/releases/health/#session) on the **Releases** page, user sessions in Session Replay can span multiple page loads. | ||
|
|
||
| </Note> | ||
|
|
||
| ## Learn More About Session Replay | ||
|
|
||
| <PageGrid /> | ||
File renamed without changes.
File renamed without changes.
File renamed without changes.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.