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/platform-includes/session-replay/setup-session-replay/javascript.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
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/custom-instrumentation/) for more details.
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.
2
2
3
3
```javascript {tabTitle: ESM}
4
4
// import Sentry from your framework SDK (e.g. @sentry/react) instead of @sentry/browser
@@ -21,35 +11,6 @@ description: "Learn about the general Session Replay configuration fields."
21
11
22
12
<Includename="beta-note-session-replay.mdx" />
23
13
24
-
## Identifying Users
25
-
26
-
If you have only followed the above instructions to setup session replays, you will only see IP addresses in Sentry's UI. In order to associate a user identity to a session replay, use [setUser](/platforms/javascript/enriching-events/identify-user/).
Replay recording only starts automatically when it is included in the integrations key when calling Sentry.init. Otherwise you can initialize the plugin and manually call the start() method on the integration instance. To stop recording you can call the stop().
36
-
37
-
```javascript {tabTitle: ESM}
38
-
constreplay=newReplay(); // This will *NOT* begin recording replays
39
-
40
-
replay.start(); // Start recording
41
-
42
-
replay.stop(); // Stop recording
43
-
```
44
-
45
-
```javascript {tabTitle: CDN}
46
-
constreplay=newSentry.Integrations.Replay(); // This will *NOT* begin recording replays
47
-
48
-
replay.start(); // Start recording
49
-
50
-
replay.stop(); // Stop recording
51
-
```
52
-
53
14
## General Integration Configuration
54
15
55
16
The following options can be configured on the root level of your browser-based Sentry SDK, in `init({})`:
@@ -75,6 +36,14 @@ The following options can be configured as options to the integration, in `new R
75
36
| inlineImages | boolean |`false`| Should inline `<image>` content |
76
37
| inlineStylesheet | boolean |`true`| Should inline stylesheets used in the recording |
77
38
39
+
## Identifying Users
40
+
41
+
You can use the Sentry SDK to set the user of a session. To associate a user identity to a session replay, refer to the <PlatformLinkto="/enriching-events/identify-user">Identifying User Docs</PlatformLink>.
In addition to the options described above, you can also directly pass configuration to [rrweb](https://github.com/rrweb-io/rrweb/blob/rrweb%401.1.3/guide.md), which is the underlying library used to make the recordings:
@@ -84,3 +53,27 @@ new Replay({
84
53
// any further configuration here is passed directly to rrweb
85
54
});
86
55
```
56
+
57
+
## Start and Stop Recording
58
+
59
+
Replay recording only starts automatically when it's included in the integrations key when calling `Sentry.init`. Otherwise, you can initialize the plugin and manually call the `start()` method on the integration instance. To stop recording you can call the `stop()`:
60
+
61
+
```javascript {tabTitle: ESM}
62
+
constreplay=newReplay(); // This will *NOT* begin recording replays
63
+
64
+
replay.start(); // Start recording
65
+
66
+
replay.stop(); // Stop recording
67
+
```
68
+
69
+
```javascript {tabTitle: CDN}
70
+
constreplay=newSentry.Integrations.Replay(); // This will *NOT* begin recording replays
71
+
72
+
replay.start(); // Start recording
73
+
74
+
replay.stop(); // Stop recording
75
+
```
76
+
77
+
## Privacy
78
+
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
+2-10Lines changed: 2 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,16 +1,6 @@
1
1
---
2
2
title: Set Up Session Replay
3
3
sidebar_order: 4000
4
-
supported:
5
-
- javascript
6
-
- javascript.angular
7
-
- javascript.ember
8
-
- javascript.gatsby
9
-
- javascript.nextjs
10
-
- javascript.react
11
-
- javascript.remix
12
-
- javascript.svelte
13
-
- javascript.vue
14
4
notSupported:
15
5
- javascript.capacitor
16
6
- javascript.cordova
@@ -35,6 +25,8 @@ redirect_from:
35
25
36
26
<Includename="beta-note-session-replay.mdx" />
37
27
28
+
Sentry's Replay product is geared toward developers. 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>.
29
+
38
30
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.
Copy file name to clipboardExpand all lines: src/platforms/javascript/common/session-replay/privacy.mdx
+3-12Lines changed: 3 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,16 +1,6 @@
1
1
---
2
-
title: Privacy Configuration
2
+
title: Privacy
3
3
sidebar_order: 4200
4
-
supported:
5
-
- javascript
6
-
- javascript.angular
7
-
- javascript.ember
8
-
- javascript.gatsby
9
-
- javascript.nextjs
10
-
- javascript.react
11
-
- javascript.remix
12
-
- javascript.svelte
13
-
- javascript.vue
14
4
notSupported:
15
5
- javascript.capacitor
16
6
- javascript.cordova
@@ -21,9 +11,10 @@ description: "Configuring Session Replay to maintain user and data privacy."
21
11
22
12
<Includename="beta-note-session-replay.mdx" />
23
13
24
-
There are several ways to deal with PII (personally identifiable information). By default, the integration will mask all text content with `*` and block all media elements (`img, svg, video, object, picture, embed, map, audio`). This can be disabled by setting `maskAllText` to `false`. It is also possible to add the following CSS classes to specific DOM elements to prevent recording its contents: `sentry-block`, `sentry-ignore`, and `sentry-mask`. The following sections will show examples of how content is handled by the differing methods.
14
+
There are several ways to deal with personally identifiable information (PII). By default, the integration will mask all text content with `*` and block all media elements (`img`, `svg`, `video`, `object`, `picture`, `embed`, `map`, `audio`). This can be disabled by setting `maskAllText` to `false`. It's also possible to add the following CSS classes to specific DOM elements to prevent recording their contents: `sentry-block`, `sentry-ignore`, and `sentry-mask`. The following sections will show examples of how content is handled by the differing methods.
25
15
26
16
### Masking
17
+
27
18
Masking replaces the text content with something else. The default masking behavior is to replace each character with a `*`. In this example the relevant html code is: `<table class="sentry-mask">...</table>`.
Copy file name to clipboardExpand all lines: src/wizard/javascript/replay-onboarding/angular/2.configure.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,14 +7,14 @@ type: language
7
7
8
8
#### Configure
9
9
10
-
Add the following to your SDK config. There are several privacy and sampling options available, all of which can be set via the `integrations` constructor. Learn more about configuring Session Replay by reading the [configuration docs](https://docs.sentry.io/platforms/javascript/guides/angular/session-replay/custom-instrumentation/).
10
+
Add the following to your SDK config. There are several privacy and sampling options available, all of which can be set via the `integrations` constructor. Learn more about configuring Session Replay by reading the [configuration docs](https://docs.sentry.io/platforms/javascript/guides/angular/session-replay/).
Copy file name to clipboardExpand all lines: src/wizard/javascript/replay-onboarding/ember/2.configure.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,14 +7,14 @@ type: language
7
7
8
8
#### Configure
9
9
10
-
Add the following to your SDK config. There are several privacy and sampling options available, all of which can be set via the `integrations` constructor. Learn more about configuring Session Replay by reading the [configuration docs](https://docs.sentry.io/platforms/javascript/guides/ember/session-replay/custom-instrumentation/).
10
+
Add the following to your SDK config. There are several privacy and sampling options available, all of which can be set via the `integrations` constructor. Learn more about configuring Session Replay by reading the [configuration docs](https://docs.sentry.io/platforms/javascript/guides/ember/session-replay/).
0 commit comments