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
Tweak replay index page to match in-app messaging.mdx (#6986)
In-app we've got a banner that calls out when replays are missing from an error (but were expected to exist)
There are a few reasons, not all are reflected in the docs.
Copy file name to clipboardExpand all lines: src/platforms/javascript/common/session-replay/index.mdx
+13-9Lines changed: 13 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -23,9 +23,9 @@ redirect_from:
23
23
24
24
<Includename="beta-note-session-replay.mdx" />
25
25
26
-
[Session Replay](/product/session-replay/) helps you get to the root cause of an error or latency issue faster by providing you with a video-like reproduction of what was happening in the user's browser before, during, and after the issue. Rewind and replay your application's DOM state, key user interactions like mouseclicks and scrolls, network requests, and console entries in a single combined UI inspired by your browser's DevTools.
26
+
[Session Replay](/product/session-replay/) helps you get to the root cause of an error or latency issue faster by providing you with a video-like reproduction of what was happening in the user's browser before, during, and after the issue. You can rewind and replay your application's DOM state and see key user interactions, like mouse clicks, scrolls, network requests, and console entries, in a single combined UI inspired by your browser's DevTools.
27
27
28
-
By default, our Session Replay SDK masks all DOM text content, images, and user input, giving you heightened confidence that no sensitive data leaves the browser. To learn more, see <PlatformLinkto="/session-replay/privacy">Session Replay Privacy</PlatformLink>.
28
+
By default, our Session Replay SDK masks all DOM text content, images, and user input, giving you heightened confidence that no sensitive data will leave the browser. To learn more, see <PlatformLinkto="/session-replay/privacy">Session Replay Privacy</PlatformLink>.
29
29
30
30
## Pre-requisites
31
31
@@ -64,7 +64,7 @@ By default, our Session Replay SDK masks all DOM text content, images, and user
64
64
65
65
### Content Security Policy (CSP)
66
66
67
-
Session Replay uses a WebWorker to perform work (e.g. compression) off the main UI thread so as not to degrade the performance of your application. Add the below entry to make sure that workers can be loaded:
67
+
Session Replay uses a WebWorker to perform work (for example, compression) off the main UI thread so as not to degrade the performance of your application. Add the below entry to make sure that workers can be loaded:
1.<PlatformIdentifiername="replays-session-sample-rate" /> - The sample rate for
98
98
replays that begin recording immediately and last the entirety of the user's session.
@@ -101,15 +101,19 @@ Sampling allows you to control how much of your website's traffic will result in
101
101
up to a minute of events prior to the error and continue recording until the session
102
102
ends.
103
103
104
-
Sampling occurs when the session is first started. <PlatformIdentifiername="replays-session-sample-rate" /> is evaluated first. If it is sampled, then the replay recording begins. Otherwise, <PlatformIdentifiername="replays-on-error-sample-rate" /> is evaluated and if it is sampled, the integration will begin buffering the replay and will only upload a replay to Sentry when an error occurs. The remainder of the replay will behave similarly to a whole-session replay.
104
+
Sampling begins as soon as a session starts. <PlatformIdentifiername="replays-session-sample-rate" /> is evaluated first. If it's sampled, the replay recording will begin. Otherwise, <PlatformIdentifiername="replays-on-error-sample-rate" /> is evaluated and if it's sampled, the integration will begin buffering the replay and will only upload it to Sentry if an error occurs. The remainder of the replay will behave similarly to a whole-session replay.
105
105
106
106
## Error Linking
107
107
108
-
Currently, errors that happen on the page while a replay is running are linked to the Replay, making it as easy as possible to jump between related issues and replays. However, it is **possible** that the error count reported on the **Replays Details** page does not match the actual errors that have been captured. This is because errors can be lost; for example, a network request may fail or similar. This shouldn't happen often, but it's theoretically possible.
108
+
Errors that happen on the page while a replay is running will be linked to the replay, making it possible to jump between related issues and replays. However, it's **possible** that in some cases the error count reported on the **Replays Details** page won't match the actual errors that have been captured. That's because errors can be lost, and while this is uncommon, there are a few reasons why it could happen:
109
+
110
+
- The replay was rate-imited and couldn't be accepted.
111
+
- The replay was deleted by a member of your org.
112
+
- There were network errors and the replay wasn't saved.
109
113
110
114
## Verify
111
115
112
-
While you're testing, set <PlatformIdentifiername="replays-session-sample-rate" /> to `1.0`, as that ensures that every user session will be sent to Sentry.
116
+
While you're testing, we recommend that you set <PlatformIdentifiername="replays-session-sample-rate" /> to `1.0`. This ensures that every user session will be sent to Sentry.
113
117
114
118
Once testing is complete, **we recommend lowering this value in production**. We still recommend keeping <PlatformIdentifiername="replays-on-error-sample-rate" /> set to `1.0`.
0 commit comments