@amplitude/session-replay-browser
Advanced tools
Comparing version 1.0.1 to 1.0.2
{ | ||
"name": "@amplitude/session-replay-browser", | ||
"version": "1.0.1", | ||
"version": "1.0.2", | ||
"description": "", | ||
@@ -60,3 +60,3 @@ "author": "Amplitude Inc", | ||
], | ||
"gitHead": "1ab3dbbb380def4d367410f45da41a6dc788ab6b" | ||
"gitHead": "f07f2bf6aaf2817ded4f18eda548d5c2778ee75c" | ||
} |
@@ -78,3 +78,3 @@ <p align="center"> | ||
|`sessionId`|`number`|Yes|`undefined`|Sets an identifier for the users current session. The value must be in milliseconds since epoch (Unix Timestamp).| | ||
|`sampleRate`|`number`|No|`0`|Use this option to control how many sessions will be selected for replay collection. A selected session will be collected for replay, while sessions that are not selected will not. <br></br>The number should be a decimal between 0 and 1, ie `0.4`, representing the fraction of sessions you would like to have randomly selected for replay collection. Over a large number of sessions, `0.4` would select `40%` of those sessions.| | ||
|`sampleRate`|`number`|No|`0`|Use this option to control how many sessions will be selected for replay collection. A selected session will be collected for replay, while sessions that are not selected will not. <br></br>The number should be a decimal between 0 and 1, ie `0.01`, representing the fraction of sessions you would like to have randomly selected for replay collection. Over a large number of sessions, `0.01` would select `1%` of those sessions.| | ||
|`optOut`|`boolean`|No|`false`|Sets permission to collect replays for sessions. Setting a value of true prevents Amplitude from collecting session replays.| | ||
@@ -85,2 +85,4 @@ |`flushMaxRetries`|`number`|No|`5`|Sets the maximum number of retries for failed upload attempts. This is only applicable to retryable errors.| | ||
|`serverZone`|`string`|No|`US`|EU or US. Sets the Amplitude server zone. Set this to EU for Amplitude projects created in EU data center.| | ||
|`privacyConfig`|`object`|No|`undefined`| Supports advanced masking configs with CSS selectors.| | ||
|`debugMode`|`boolean`|No|`false`| Adds additional debug event property to help debug instrumentation issues (such as mismatching apps). Only recommended for debugging initial setup, and not recommended for production.| | ||
@@ -98,1 +100,12 @@ ## Privacy | ||
In your application code, add the class `.amp-block` to any element you would like to have blocked from the collection of the replay. The element will appear in the replay as a placeholder with the same dimensions. | ||
#### 4. Block elements by CSS selectors. | ||
In the SDK initialization code, you can configure the SDK to block elements based on CSS selectors. | ||
```typescript | ||
sessionReplay.init(AMPLITUDE_API_KEY, { | ||
sampleRate: 0.01, | ||
privacyConfig: { | ||
blockSelector: ['.ignoreClass', '#ignoreId'] | ||
} | ||
}) | ||
``` |
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
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
504960
109