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
Copy file name to clipboardExpand all lines: src/docs/product/session-replay/index.mdx
+3-2Lines changed: 3 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,15 @@
1
1
---
2
2
title: "Session Replay"
3
3
sidebar_order: 3
4
-
description: "Session Replay"
4
+
description: "Learn about Sentry's Session Replay, which provides video-like reproductions of user interactions on a site or web app."
5
5
---
6
6
7
7
<Note>
8
8
9
9
Session Replay is currently in beta. Beta features are still in-progress and may have bugs. We recognize the irony. If you have any questions or feedback, please email us at [[email protected]](mailto:[email protected]).
10
10
11
11
**Currently, this feature is supported for only browser JavaScript, including these frameworks:**
12
+
12
13
- Angular
13
14
- Ember
14
15
- Gatsby
@@ -20,7 +21,7 @@ Session Replay is currently in beta. Beta features are still in-progress and may
20
21
21
22
</Note>
22
23
23
-
Get to the root cause of an error or latency issue faster by seeing all the technical details related to that issue in one visual replay on your web application.
24
+
Get to the root cause of an error or latency issue faster by seeing all the technical details related to that issue in one visual replay on your web application.**Session Replay** provides a video-like reproduction of user interactions on a site or web app. All user interactions — including page visits, mouse movements, clicks, and scrolls — are captured, helping developers connect the dots between a known issue and how a user experienced it in the UI.
Copy file name to clipboardExpand all lines: src/platform-includes/session-replay/setup/javascript.mdx
+7-7Lines changed: 7 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
-
To set up the integration, add the following to your Sentry initialization. Several options are supported and passable via the integration constructor. See the [configuration sections](/platforms/javascript/session-replay/) for more details.
1
+
To set up the integration, add the following to your Sentry initialization. Several options are supported and passable using the integration constructor. See the [configuration documentation](/platforms/javascript/session-replay/configuration/) for more details.
2
2
3
3
```javascript {tabTitle: ESM}
4
-
// import Sentry from your framework SDK (e.g. @sentry/react) instead of @sentry/browser
4
+
// import Sentry from your framework SDK (e.g. @sentry/react) instead of @sentry/browser
5
5
import*asSentryfrom"@sentry/browser";
6
6
7
7
import { Replay } from"@sentry/replay";
@@ -21,9 +21,9 @@ Sentry.init({
21
21
newReplay({
22
22
// Additional SDK configuration goes in here, for example:
23
23
maskAllText:true,
24
-
blockAllMedia:true
24
+
blockAllMedia:true,
25
25
// See below for all available options
26
-
})
26
+
}),
27
27
],
28
28
});
29
29
```
@@ -44,9 +44,9 @@ Sentry.init({
44
44
newSentry.Integrations.Replay({
45
45
// Additional SDK configuration goes in here, for example:
46
46
maskAllText:true,
47
-
blockAllMedia:true
47
+
blockAllMedia:true,
48
48
// See below for all available options
49
-
})
49
+
}),
50
50
],
51
51
});
52
52
```
@@ -56,4 +56,4 @@ You can verify that with the following:
| replaysSessionSampleRate | number |`0.1`| The sample rate for replays that begin recording immediately and last the entirety of the user's session. 1.0 will collect all replays, 0 will collect no replays.|
21
-
| replaysOnErrorSampleRate | number |`1.0`| The sample rate for replays that are recorded when an error happens. This type of replay will record up to a minute of events prior to the error and continue recording until the session ends. 1.0 capturing all sessions with an error, and 0 capturing none. |
| replaysSessionSampleRate | number |`0.1`| The sample rate for replays that begin recording immediately and last the entirety of the user's session. `1.0` collects all replays, and `0` collects none. |
21
+
| replaysOnErrorSampleRate | number |`1.0`| The sample rate for replays that are recorded when an error happens. This type of replay will record up to a minute of events prior to the error and continue recording until the session ends. `1.0` captures all sessions with an error, and `0` captures none. |
22
22
23
23
The following options can be configured as options to the integration, in `new Replay({})`:
24
24
25
-
|key| type| default | description|
26
-
| ------------------- | ------- | -------|--- |
27
-
| stickySession | boolean |`true`| Keep track of the user across page loads. Note a single user using multiple tabs will result in multiple sessions. Closing a tab will result in the session being closed as well.|
| stickySession | boolean |`true`| Keep track of the user across page loads. Note, a single user using multiple tabs will result in multiple sessions. Closing a tab will result in the session being closed as well. |
28
28
29
29
## Optimization Configuration
30
30
31
31
The following options can be configured as options to the integration, in `new Replay({})`:
We take privacy seriously so we provide a number of privacy-oriented settings. Learn more about these in our our<PlatformLinkto="/session-replay/privacy/#privacy-configuration">Session Replay privacy documentation</PlatformLink>.
79
+
We take privacy seriously, so we provide a number of privacy-oriented settings. Learn more about these in our our<PlatformLinkto="/session-replay/privacy/#privacy-configuration">Session Replay privacy documentation</PlatformLink>.
Copy file name to clipboardExpand all lines: src/platforms/javascript/common/session-replay/index.mdx
+12-12Lines changed: 12 additions & 12 deletions
Original file line number
Diff line number
Diff line change
@@ -25,43 +25,43 @@ redirect_from:
25
25
26
26
<Includename="beta-note-session-replay.mdx" />
27
27
28
-
With [session replays](/product/session-replay/) you can get to the root cause of an error or latency issue faster by seeing all the technical details related to that issue in one visual replay on your web application. Sentry provides a video-like reproduction of user interactions on a site or web app. All user interactions - including page visits, mouse movements, clicks, and scrolls - are captured, helping developers connect the dots between a known issue and how a user experienced it in the UI.
28
+
With [session replays](/product/session-replay/) you can get to the root cause of an error or latency issue faster by seeing all the technical details related to that issue in one visual replay on your web application. Sentry provides a video-like reproduction of user interactions on a site or web app. All user interactions — including page visits, mouse movements, clicks, and scrolls — are captured, helping developers connect the dots between a known issue and how a user experienced it in the UI.
29
29
30
30
By default, it'll mask all fields, so no personally identifiable information (PII) is collected, eliminating any concerns with General Data Protection Regulation (GDPR). Learn more on <PlatformLinkto="/session-replay/privacy">Session Replay Privacy</PlatformLink>.
31
31
32
32
## Pre-requisites
33
33
34
-
For the sentry-replay integration to work, you must have the [Sentry browser SDK package](https://www.npmjs.com/package/@sentry/browser), or an equivalent framework SDK (e.g.[@sentry/react](https://www.npmjs.com/package/@sentry/react)) installed. The minimum version required for the SDK is `7.24.0`.
34
+
For the sentry-replay integration to work, you must have the [Sentry browser SDK package](https://www.npmjs.com/package/@sentry/browser), or an equivalent framework SDK (for example,[@sentry/react](https://www.npmjs.com/package/@sentry/react)) installed. The minimum version required for the SDK is `7.24.0`.
35
35
36
-
Make sure to use the exact same version of `@sentry/replay` as your other Sentry package(s), e.g.`@sentry/browser` or `@sentry/react`.
36
+
Make sure to use the exact same version of `@sentry/replay` as your other Sentry package(s), such as`@sentry/browser` or `@sentry/react`.
37
37
38
38
`@sentry/replay` requires Node 12+, and browsers newer than IE11.
A user session starts when the Session Replay SDK is first loaded and initialized. The session will continue until five minutes passes without any user interactions with the application **or** until a maximum of 30 minutes have elapsed. Closing the browser tab will end the session immediately according to the rules for [SessionStorage](https://developer.mozilla.org/en-US/docs/Web/API/Window/sessionStorage).
51
51
52
52
<Note>
53
53
54
-
An 'interaction' refers to either a mouse click or a browser navigation event.
54
+
An _interaction_ refers to either a mouse click or a browser navigation event.
55
55
56
56
</Note>
57
57
58
-
### Replay Captures Only on Errors
58
+
### Replay Captures on Errors Only
59
59
60
60
Alternatively, rather than recording an entire session, you can capture a replay only when an error occurs. In this case, the integration will buffer up to one minute worth of events prior to the error being thrown. It will continue to record the session following the rules above regarding session life and activity. Read the [sampling](#sampling) section for configuration options.
61
61
62
62
## Sampling
63
63
64
-
Sampling allows you to control how much of your website's traffic will result in a Session Replay. There are two sample rates you can adjust to get the replays more relevant to your interests:
64
+
Sampling allows you to control how much of your website's traffic will result in a session replay. There are two sample rates you can adjust to get the replays relevant to your interests:
65
65
66
66
1. <PlatformIdentifiername="replays-session-sample-rate" /> - The sample rate for replays that begin recording immediately and last the entirety of the user's session.
67
67
2. <PlatformIdentifiername="replays-on-error-sample-rate" /> - The sample rate for replays that are recorded when an error happens. This type of replay will record up to a minute of events prior to the error and continue recording until the session ends.
@@ -70,14 +70,14 @@ Sampling occurs when the session is first started. <PlatformIdentifier name="rep
70
70
71
71
## Error Linking
72
72
73
-
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/replays. However, please note that it is __possible__ that the error count reported on the Replay Detail page does not match the actual errors that have been captured. The reason for that is that errors can be lost, e.g. a network request fails, or similar. This should not happen to often, but be aware that it is theoretically possible.
73
+
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.
74
74
75
75
## Verify
76
76
77
77
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.
78
78
79
79
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