@sentry/replay
Advanced tools
@sentry/replay - npm Package Compare versions
Comparing version 7.116.0 to 7.117.0
| { | ||
| "name": "@sentry/replay", | ||
| "version": "7.116.0", | ||
| "version": "7.117.0", | ||
| "description": "User replays for Sentry", | ||
@@ -8,2 +8,6 @@ "main": "cjs/index.js", | ||
| "types": "types/index.d.ts", | ||
| "publishConfig": { | ||
| "access": "public", | ||
| "tag": "v7" | ||
| }, | ||
| "typesVersions": { | ||
@@ -35,3 +39,3 @@ "<4.9": { | ||
| "@babel/core": "^7.17.5", | ||
| "@sentry-internal/replay-worker": "7.116.0", | ||
| "@sentry-internal/replay-worker": "7.117.0", | ||
| "@sentry-internal/rrweb": "2.15.0", | ||
@@ -43,6 +47,6 @@ "@sentry-internal/rrweb-snapshot": "2.15.0", | ||
| "dependencies": { | ||
| "@sentry-internal/tracing": "7.116.0", | ||
| "@sentry/core": "7.116.0", | ||
| "@sentry/types": "7.116.0", | ||
| "@sentry/utils": "7.116.0" | ||
| "@sentry-internal/tracing": "7.117.0", | ||
| "@sentry/core": "7.117.0", | ||
| "@sentry/types": "7.117.0", | ||
| "@sentry/utils": "7.117.0" | ||
| }, | ||
@@ -49,0 +53,0 @@ "engines": { |
183
README.md
@@ -13,2 +13,10 @@ <p align="center"> | ||
| ## Package Discontinued | ||
| The standalone `@sentry/replay` package is no longer published with version 8.0.0 of the Sentry JavaScript SDKs. | ||
| Instead, the replay integration is now directly exported in all client-side SDK packages (e.g `@sentry/react` or | ||
| `@sentry/nextjs`). Head over to our v8 | ||
| [Migration Guide](https://docs.sentry.io/platforms/javascript/migration/v7-to-v8/#removal-of-sentryreplay-package) for | ||
| more information. | ||
| ## Pre-requisites | ||
@@ -20,4 +28,4 @@ | ||
| Replay can be imported from `@sentry/browser`, or a respective SDK package like `@sentry/react` or `@sentry/vue`. | ||
| You don't need to install anything in order to use Session Replay. The minimum version that includes Replay is 7.27.0. | ||
| Replay can be imported from `@sentry/browser`, or a respective SDK package like `@sentry/react` or `@sentry/vue`. You | ||
| don't need to install anything in order to use Session Replay. The minimum version that includes Replay is 7.27.0. | ||
@@ -28,4 +36,4 @@ For details on using Replay when using Sentry via the CDN bundles, see [CDN bundle](#loading-replay-as-a-cdn-bundle). | ||
| 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 section](#configuration) below for more details. | ||
| 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 section](#configuration) below for more details. | ||
@@ -51,5 +59,5 @@ ```javascript | ||
| maskAllText: true, | ||
| blockAllMedia: true | ||
| blockAllMedia: true, | ||
| // See below for all available options | ||
| }) | ||
| }), | ||
| ], | ||
@@ -62,5 +70,4 @@ // ... | ||
| Replay will start automatically when you add the integration. | ||
| If you do not want to start Replay immediately (e.g. if you want to lazy-load it), | ||
| you can also use `addIntegration` to load it later: | ||
| Replay will start automatically when you add the integration. If you do not want to start Replay immediately (e.g. if | ||
| you want to lazy-load it), you can also use `addIntegration` to load it later: | ||
@@ -86,8 +93,10 @@ ```js | ||
| 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`](https://docs.sentry.io/platforms/javascript/enriching-events/identify-user/). | ||
| 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`](https://docs.sentry.io/platforms/javascript/enriching-events/identify-user/). | ||
| ```javascript | ||
| import * as Sentry from "@sentry/browser"; | ||
| import * as Sentry from '@sentry/browser'; | ||
| Sentry.setUser({ email: "jane.doe@example.com" }); | ||
| Sentry.setUser({ email: 'jane.doe@example.com' }); | ||
| ``` | ||
@@ -97,3 +106,4 @@ | ||
| Replay recording only starts when it is included in the `integrations` array when calling `Sentry.init` or calling `addIntegration` from the a Sentry client instance. To stop recording you can call `stop()`. | ||
| Replay recording only starts when it is included in the `integrations` array when calling `Sentry.init` or calling | ||
| `addIntegration` from the a Sentry client instance. To stop recording you can call `stop()`. | ||
@@ -119,4 +129,4 @@ ```js | ||
| When both `replaysSessionSampleRate` and `replaysOnErrorSampleRate` are `0`, recording will _not_ start. | ||
| In this case, you can manually start recording: | ||
| When both `replaysSessionSampleRate` and `replaysOnErrorSampleRate` are `0`, recording will _not_ start. In this case, | ||
| you can manually start recording: | ||
@@ -128,8 +138,7 @@ ```js | ||
| ## Loading Replay as a CDN Bundle | ||
| As an alternative to the NPM package, you can use Replay as a CDN bundle. | ||
| Please refer to the [Session Replay installation guide](https://docs.sentry.io/platforms/javascript/session-replay/#install) for CDN bundle instructions. | ||
| As an alternative to the NPM package, you can use Replay as a CDN bundle. Please refer to the | ||
| [Session Replay installation guide](https://docs.sentry.io/platforms/javascript/session-replay/#install) for CDN bundle | ||
| instructions. | ||
@@ -143,11 +152,6 @@ <details> | ||
| ```html | ||
| <script | ||
| src="https://browser.sentry-cdn.com/7.41.0/bundle.min.js" | ||
| crossorigin="anonymous" | ||
| ></script> | ||
| <script | ||
| src="https://browser.sentry-cdn.com/7.41.0/replay.min.js" | ||
| crossorigin="anonymous" | ||
| ></script> | ||
| <script src="https://browser.sentry-cdn.com/7.41.0/bundle.min.js" crossorigin="anonymous"></script> | ||
| <script src="https://browser.sentry-cdn.com/7.41.0/replay.min.js" crossorigin="anonymous"></script> | ||
| ``` | ||
| </details> | ||
@@ -157,3 +161,6 @@ | ||
| 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[^1] 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). | ||
| 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[^1] 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). | ||
@@ -164,21 +171,26 @@ [^1]: An 'interaction' refers to either a mouse click or a browser navigation event. | ||
| You can get the ID of the currently running session via `replay.getReplayId()`. | ||
| This will return `undefined` if no session is ongoing. | ||
| You can get the ID of the currently running session via `replay.getReplayId()`. This will return `undefined` if no | ||
| session is ongoing. | ||
| ### 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. | ||
| 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: | ||
| 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: | ||
| - `replaysSessionSampleRate` - The sample rate for replays that begin recording immediately and last the entirety of the user's session. | ||
| - `replaysOnErrorSampleRate` - 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. | ||
| - `replaysSessionSampleRate` - The sample rate for replays that begin recording immediately and last the entirety of the | ||
| user's session. | ||
| - `replaysOnErrorSampleRate` - 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. | ||
| When Replay is initialized, we check the `replaysSessionSampleRate`. | ||
| If it is sampled, then we start recording & sending Replay data immediately. | ||
| Else, if `replaysOnErrorSampleRate > 0`, we'll start recording in buffering mode. | ||
| In this mode, whenever an error occurs we'll check `replaysOnErrorSampleRate`. | ||
| If it is sampled, when we'll upload the Replay to Sentry and continue recording normally. | ||
| When Replay is initialized, we check the `replaysSessionSampleRate`. If it is sampled, then we start recording & sending | ||
| Replay data immediately. Else, if `replaysOnErrorSampleRate > 0`, we'll start recording in buffering mode. In this mode, | ||
| whenever an error occurs we'll check `replaysOnErrorSampleRate`. If it is sampled, when we'll upload the Replay to | ||
| Sentry and continue recording normally. | ||
@@ -191,8 +203,7 @@ ## Configuration | ||
| | key | type | default | description | | ||
| | ------------------------ | ------ | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | replaysSessionSampleRate | number | `0` | 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 | `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. | | ||
| | key | type | default | description | | ||
| | ------------------- | ------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | replaysSessionSampleRate | number | `0` | 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 | `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. | ||
| ### General Integration Configuration | ||
@@ -202,7 +213,6 @@ | ||
| | 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. | | ||
| | 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. | | ||
| ### Privacy Configuration | ||
@@ -212,40 +222,54 @@ | ||
| | key | type | default | description | | ||
| | ---------------- | ------------------------ | --------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | maskAllText | boolean | `true` | Mask _all_ text content. Will pass text content through `maskFn` before sending to server. | | ||
| | maskAllInputs | boolean | `true` | Mask values of `<input>` elements. Passes input values through `maskInputFn` before sending to server. | | ||
| | blockAllMedia | boolean | `true` | Block _all_ media elements (`img, svg, video, object, picture, embed, map, audio`) | | ||
| | maskFn | (text: string) => string | `(text) => '*'.repeat(text.length)` | Function to customize how text content is masked before sending to server. By default, masks text with `*`. | | ||
| | block | Array<string> | `.sentry-block, [data-sentry-block]` | Redact any elements that match the DOM selectors. See [privacy](#blocking) section for an example. | | ||
| | unblock | Array<string> | `.sentry-unblock, [data-sentry-unblock]`| Do not redact any elements that match the DOM selectors. Useful when using `blockAllMedia`. See [privacy](#blocking) section for an example. | | ||
| | mask | Array<string> | `.sentry-mask, [data-sentry-mask]` | Mask all elements that match the given DOM selectors. See [privacy](#masking) section for an example. | | ||
| | unmask | Array<string> | `.sentry-unmask, [data-sentry-unmask]` | Unmask all elements that match the given DOM selectors. Useful when using `maskAllText`. See [privacy](#masking) section for an example. | | ||
| | ignore | Array<string> | `.sentry-ignore, [data-sentry-ignore]` | Ignores all events on the matching input fields. See [privacy](#ignoring) section for an example. | | ||
| | key | type | default | description | | ||
| | ------------- | ------------------------ | ---------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | maskAllText | boolean | `true` | Mask _all_ text content. Will pass text content through `maskFn` before sending to server. | | ||
| | maskAllInputs | boolean | `true` | Mask values of `<input>` elements. Passes input values through `maskInputFn` before sending to server. | | ||
| | blockAllMedia | boolean | `true` | Block _all_ media elements (`img, svg, video, object, picture, embed, map, audio`) | | ||
| | maskFn | (text: string) => string | `(text) => '*'.repeat(text.length)` | Function to customize how text content is masked before sending to server. By default, masks text with `*`. | | ||
| | block | Array<string> | `.sentry-block, [data-sentry-block]` | Redact any elements that match the DOM selectors. See [privacy](#blocking) section for an example. | | ||
| | unblock | Array<string> | `.sentry-unblock, [data-sentry-unblock]` | Do not redact any elements that match the DOM selectors. Useful when using `blockAllMedia`. See [privacy](#blocking) section for an example. | | ||
| | mask | Array<string> | `.sentry-mask, [data-sentry-mask]` | Mask all elements that match the given DOM selectors. See [privacy](#masking) section for an example. | | ||
| | unmask | Array<string> | `.sentry-unmask, [data-sentry-unmask]` | Unmask all elements that match the given DOM selectors. Useful when using `maskAllText`. See [privacy](#masking) section for an example. | | ||
| | ignore | Array<string> | `.sentry-ignore, [data-sentry-ignore]` | Ignores all events on the matching input fields. See [privacy](#ignoring) section for an example. | | ||
| #### Deprecated options | ||
| In order to streamline our privacy options, the following have been deprecated in favor for the respective options above. | ||
| | deprecated key | replaced by | description | | ||
| | ---------------- | ----------- | ----------- | | ||
| | maskInputOptions | mask | Use CSS selectors in `mask` in order to mask all inputs of a certain type. For example, `input[type="address"]` | | ||
| | blockSelector | block | The selector(s) can be moved directly in the `block` array. | | ||
| | blockClass | block | Convert the class name to a CSS selector and add to `block` array. For example, `first-name` becomes `.first-name`. Regexes can be moved as-is. | | ||
| | maskClass | mask | Convert the class name to a CSS selector and add to `mask` array. For example, `first-name` becomes `.first-name`. Regexes can be moved as-is. | | ||
| | maskSelector | mask | The selector(s) can be moved directly in the `mask` array. | | ||
| In order to streamline our privacy options, the following have been deprecated in favor for the respective options | ||
| above. | ||
| | deprecated key | replaced by | description | | ||
| | ---------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | | ||
| | maskInputOptions | mask | Use CSS selectors in `mask` in order to mask all inputs of a certain type. For example, `input[type="address"]` | | ||
| | blockSelector | block | The selector(s) can be moved directly in the `block` array. | | ||
| | blockClass | block | Convert the class name to a CSS selector and add to `block` array. For example, `first-name` becomes `.first-name`. Regexes can be moved as-is. | | ||
| | maskClass | mask | Convert the class name to a CSS selector and add to `mask` array. For example, `first-name` becomes `.first-name`. Regexes can be moved as-is. | | ||
| | maskSelector | mask | The selector(s) can be moved directly in the `mask` array. | | ||
| | ignoreClass | ignore | Convert the class name to a CSS selector and add to `ignore` array. For example, `first-name` becomes `.first-name`. Regexes can be moved as-is. | | ||
| ## Privacy | ||
| 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. | ||
| 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: `<table class="sentry-mask">...</table>`. | ||
| 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>`. | ||
|  | ||
| ### 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: `<table data-sentry-block>...</table>`. | ||
| 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: `<table data-sentry-block>...</table>`. | ||
|  | ||
| ### 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 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. | ||
| https://user-images.githubusercontent.com/79684/192815134-a6451c3f-d3cb-455f-a699-7c3fe04d0a2e.mov | ||
@@ -255,13 +279,12 @@ | ||
| 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. | ||
| 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. | ||
| ## Manually sending replay data | ||
| You can use `replay.flush()` to immediately send all currently captured replay data. | ||
| When Replay is currently in buffering mode, this will send up to the last 60 seconds of replay data, | ||
| and also continue sending afterwards, similar to when an error happens & is recorded. | ||
| You can use `replay.flush()` to immediately send all currently captured replay data. When Replay is currently in | ||
| buffering mode, this will send up to the last 60 seconds of replay data, and also continue sending afterwards, similar | ||
| to when an error happens & is recorded. |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by0.02%
3783512
- Number of lines in readme file
- increased by9.13%
275
Dependency changes
+ Added@sentry-internal/tracing@7.117.0(transitive)
+ Added@sentry/core@7.117.0(transitive)
+ Added@sentry/types@7.117.0(transitive)
+ Added@sentry/utils@7.117.0(transitive)
- Removed@sentry-internal/tracing@7.116.0(transitive)
- Removed@sentry/core@7.116.0(transitive)
- Removed@sentry/types@7.116.0(transitive)
- Removed@sentry/utils@7.116.0(transitive)
Updated@sentry/core@7.117.0
Updated@sentry/types@7.117.0
Updated@sentry/utils@7.117.0