diff --git a/src/components/platformSidebar.tsx b/src/components/platformSidebar.tsx index a18600d84a25d..2dd0ae5e1058d 100644 --- a/src/components/platformSidebar.tsx +++ b/src/components/platformSidebar.tsx @@ -79,6 +79,7 @@ export const PlatformSidebar = ({ `/${pathRoot}/enriching-events/`, `/${pathRoot}/data-management/`, `/${pathRoot}/performance/`, + `/${pathRoot}/session-replay/`, `/${pathRoot}/profiling/`, `/${pathRoot}/guides/`, ]} @@ -90,6 +91,15 @@ export const PlatformSidebar = ({ suppressMissing tree={tree} /> + + + + + +``` diff --git a/src/platform-includes/session-replay/setup-session-replay/javascript.mdx b/src/platform-includes/session-replay/setup-session-replay/javascript.mdx new file mode 100644 index 0000000000000..97aec25ad8bad --- /dev/null +++ b/src/platform-includes/session-replay/setup-session-replay/javascript.mdx @@ -0,0 +1,52 @@ +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. + +```javascript {tabTitle: ESM} +import * as Sentry from "@sentry/browser"; +import { Replay } from "@sentry/replay"; + +Sentry.init({ + dsn: "___PUBLIC_DSN___", + + // This sets the sample rate to be 10%. You may want this to be 100% while + // in development and sample at a lower rate in production + replaysSessionSampleRate: 0.1, + + // If the entire session is not sampled, use the below sample rate to sample + // sessions when an error occurs. + replaysOnErrorSampleRate: 1.0, + + integrations: [ + new Replay({ + // Additional SDK configuration goes in here, for example: + maskAllText: true, + blockAllMedia: true + // See below for all available options + }) + ], + // ... +}); +``` + +```javascript {tabTitle: CDN} +Sentry.init({ + dsn: "___PUBLIC_DSN___", + + // This sets the sample rate to be 10%. You may want this to be 100% while + // in development and sample at a lower rate in production + replaysSessionSampleRate: 0.1, + + // If the entire session is not sampled, use the below sample rate to sample + // sessions when an error occurs. + replaysOnErrorSampleRate: 1.0, + + integrations: [ + new Sentry.Integrations.Replay({ + // Additional SDK configuration goes in here, for example: + maskAllText: true, + blockAllMedia: true + // See below for all available options + }) + ], + // ... +}); +``` diff --git a/src/platforms/javascript/common/session-replay/configuration.mdx b/src/platforms/javascript/common/session-replay/configuration.mdx new file mode 100644 index 0000000000000..cdc37cb86c3e7 --- /dev/null +++ b/src/platforms/javascript/common/session-replay/configuration.mdx @@ -0,0 +1,84 @@ +--- +title: Configuration +sidebar_order: 410 +supported: + - javascript + - javascript.angular + - javascript.ember + - javascript.gatsby + - javascript.nextjs + - javascript.react + - javascript.remix + - javascript.svelte + - javascript.vue +notSupported: + - javascript.capacitor + - javascript.cordova + - javascript.electron + - javascript.wasm +description: "Learn about the general Session Replay configuration fields." +--- + +## General Integration Configuration + +The following options can be configured on the root level of your browser-based Sentry SDK, in `init({})`: + +| key | type | default | description | +| ------------------------ | ------- | ------- | --- | +| 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. | +| 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. | + +The following options can be configured as options to the integration, in `new Replay({})`: + +| key | type | default | description | +| ------------------- | ------- | ------- | --- | +| 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. | + +## Optimization Configuration + +The following options can be configured as options to the integration, in `new Replay({})`: + +| key | type | default | description | +| ---------------- | ----------------------- | ------- | --- | +| collectFonts | boolean | `false` | Should collect fonts used on the website | +| inlineImages | boolean | `false` | Should inline `` content | +| inlineStylesheet | boolean | `true` | Should inline stylesheets used in the recording | +| recordCanvas | boolean | `false` | Should record `` elements | + +## Identifying Users + +You can use the Sentry SDK to set the user of a session, in order to associate a user identity to a session replay, refer to the Identifying User Docs. + +Here's a short example using e-mail: + +```javascript +import * as Sentry from "@sentry/browser"; +Sentry.setUser({ email: "sentaur@sentry.dev" }); +``` + +## rrweb Configuration + +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: + +```javascript +new Replay({ + // any further configuration here is passed directly to rrweb +}); +``` + +## Start and Stop Recording Manually + +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()`. + +```javascript +const replay = new Replay(); // This will *NOT* begin recording replays + +replay.start(); // Start recording + +replay.stop(); // Stop recording +``` + + +## Privacy + +A series of privacy oriented settings exist. You can find it in adedicated page about Session Replay Privacy. \ No newline at end of file diff --git a/src/platforms/javascript/common/session-replay/index.mdx b/src/platforms/javascript/common/session-replay/index.mdx new file mode 100644 index 0000000000000..6b64f22060c7e --- /dev/null +++ b/src/platforms/javascript/common/session-replay/index.mdx @@ -0,0 +1,75 @@ +--- +title: Set Up Session Replay +sidebar_order: 4000 +supported: + - javascript + - javascript.angular + - javascript.ember + - javascript.gatsby + - javascript.nextjs + - javascript.react + - javascript.remix + - javascript.svelte + - javascript.vue +notSupported: + - javascript.capacitor + - javascript.cordova + - javascript.electron + - javascript.wasm +description: "Learn how to enable session replay in your app if it is not already set up." +--- + +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. + +## Pre-requisites + +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`. + +Make sure to use the exact same version of `@sentry/replay` as your other Sentry package(s), e.g. `@sentry/browser` or `@sentry/react`. + +`@sentry/replay` requires Node 12+, and browsers newer than IE11. + +## Installation + + + +## Set up + + + +## Sessions + +A session starts when the Session Replay SDK is first loaded and initialized. The session will continue until 5 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). + + + +An 'interaction' refers to either a mouse click or a browser navigation event. + + + +### Replay Captures Only on Errors + +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. + +## Sampling + +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: + +1. - The sample rate for replays that begin recording immediately and last the entirety of the user's session. +2. - 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. + +Sampling occurs when the session is first started. is evaluated first. If it is sampled, then the replay recording begins. Otherwise, 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. + +## Error Linking + +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. + +## Verify + +While you're testing, set to `1.0`, as that ensures that every user session will be sent to Sentry. + +Once testing is complete, **we recommend lowering this value in production**. We still recommend keeping set to `1.0`. + +**Next Steps:** + + diff --git a/src/platforms/javascript/common/session-replay/privacy.mdx b/src/platforms/javascript/common/session-replay/privacy.mdx new file mode 100644 index 0000000000000..3a2f829fbd994 --- /dev/null +++ b/src/platforms/javascript/common/session-replay/privacy.mdx @@ -0,0 +1,42 @@ +--- +title: Privacy +sidebar_order: 4200 +description: "Configuring Session Replay to maintain user and data privacy." +--- + +Sentry's Replay product is geared toward developers. By default, it'll mask all fiends, so no PII (personally identifiable information) is collected, eliminating any concerns with GDPR. + +There are several ways to deal with 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 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. + +### Masking +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: `...
`. +![Masking example](session-replay-masking.png) + + +### Blocking +Blocking replaces the element with a placeholder that has the same dimensions. The recording will show an empty space where the content was. In this example the relevant html code is: `...
`. +![Blocking example](session-replay-blocking.png) + + +### Ignoring +Ignoring only applies to form inputs. Events will be ignored on the input element so that the replay does not show what occurs inside of the input. In the below example, notice how the results in the table below the input changes, but no text is visible in the input. + +![Ignoring Example](session-replay-ignore-input.mp4) + +### Privacy Configuration + +The following options can be configured as options to the integration, in `new Replay({})`: + +| key | type | default | description | +| ---------------- | ------------------------ | ----------------------------------- | --- | +| maskAllText | boolean | `true` | Mask _all_ text content. Will pass text content through `maskTextFn` before sending to server. | +| blockAllMedia | boolean | `true` | Block _all_ media elements (`img, svg, video, object, picture, embed, map, audio`) | +| maskTextFn | (text: string) => string | `(text) => '*'.repeat(text.length)` | Function to customize how text content is masked before sending to server. By default, masks text with `*`. | +| maskAllInputs | boolean | `true` | Mask values of `` elements. Passes input values through `maskInputFn` before sending to server. | +| maskInputOptions | Record | `{ password: true }` | Customize which inputs `type` to mask.
Available `` types: `color, date, datetime-local, email, month, number, range, search, tel, text, time, url, week, textarea, select, password`. | +| maskInputFn | (text: string) => string | `(text) => '*'.repeat(text.length)` | Function to customize how form input values are masked before sending to server. By default, masks values with `*`. | +| blockClass | string \| RegExp | `'sentry-block'` | Redact all elements that match the class name. See [Blocking](#blocking) above for an example. | +| blockSelector | string | `'[data-sentry-block]'` | Redact all elements that match the DOM selector. See [Blocking](#blocking) above for an example. | +| ignoreClass | string \| RegExp | `'sentry-ignore'` | Ignores all events on the matching input field. See [Ignoring](#ignoring) above for an example. | +| maskTextClass | string \| RegExp | `'sentry-mask'` | Mask all elements that match the class name. See [Masking](#masking) above for an example. | +| maskTextSelector | string | `undefined` | Mask all elements that match the given DOM selector. See [Masking](#masking) above for an example. | diff --git a/src/platforms/javascript/common/session-replay/session-replay-blocking.png b/src/platforms/javascript/common/session-replay/session-replay-blocking.png new file mode 100644 index 0000000000000..7bfaa766cc4a3 Binary files /dev/null and b/src/platforms/javascript/common/session-replay/session-replay-blocking.png differ diff --git a/src/platforms/javascript/common/session-replay/session-replay-ignore-input.mp4 b/src/platforms/javascript/common/session-replay/session-replay-ignore-input.mp4 new file mode 100644 index 0000000000000..7e3f657859ece Binary files /dev/null and b/src/platforms/javascript/common/session-replay/session-replay-ignore-input.mp4 differ diff --git a/src/platforms/javascript/common/session-replay/session-replay-masking.png b/src/platforms/javascript/common/session-replay/session-replay-masking.png new file mode 100644 index 0000000000000..1132d4abdb30c Binary files /dev/null and b/src/platforms/javascript/common/session-replay/session-replay-masking.png differ