@amplitude/session-replay-browser - npm Package Compare versions

Comparing version 0.1.0 to 0.1.1

package.json

		{
		"name": "@amplitude/session-replay-browser",
		"version": "0.1.0",
		"version": "0.1.1",
		"description": "",
		@@ -60,3 +60,3 @@ "author": "Amplitude Inc",
		],
		"gitHead": "bfd0e080e9d91dfbc690a0ed1ea7796ba54fc003"
		"gitHead": "f361d34b9158827f298df4486d2f5110af1a880e"
		}

README.md

		@@ -38,5 +38,5 @@ <p align="center">

		### 2. Initialize session recordings
		### 2. Initialize session replay collection

		The SDK must be configured via the following code. This call kicks off recording for the user.
		The SDK must be configured via the following code. This call kicks off collection of replays for the user.

		@@ -51,4 +51,4 @@ ```typescript

		### 3. Get session recording event properties
		Any event that occurs within the span of a session recording must be tagged with properties that signal to Amplitude to include it in the scope of the recording. The following shows an example of how to use the properties
		### 3. Get session replay event properties
		Any event that occurs within the span of a session replay must be tagged with properties that signal to Amplitude to include it in the scope of the replay. The following shows an example of how to use the properties
		```typescript
		@@ -69,3 +69,3 @@ const sessionRecordingProperties = sessionReplay.getSessionRecordingProperties();
		### 5. Shutdown (optional)
		If at any point you would like to discontinue recording, for example in a part of your application where you would not like sessions to be recorded, you can use the following method to stop recording and remove recording event listeners.
		If at any point you would like to discontinue collection of session replays, for example in a part of your application where you would not like sessions to be collected, you can use the following method to stop collection and remove collection event listeners.
		```typescript
		@@ -81,4 +81,4 @@ sessionReplay.shutdown()
		\|`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\|`undefined`\|Use this option to control how many sessions will be selected for recording. A selected session will be recorded, while sessions that are not selected will not be recorded. <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 recording. Over a large number of sessions, `0.4` would select `40%` of those sessions.\|
		\|`optOut`\|`boolean`\|No\|`false`\|Sets permission to record sessions. Setting a value of true prevents Amplitude from recording sessions.\|
		\|`sampleRate`\|`number`\|No\|`undefined`\|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.\|
		\|`optOut`\|`boolean`\|No\|`false`\|Sets permission to collect replays for sessions. Setting a value of true prevents Amplitude from collecting session replays.\|
		\|`flushMaxRetries`\|`number`\|No\|`5`\|Sets the maximum number of retries for failed upload attempts. This is only applicable to retryable errors.\|
		@@ -90,11 +90,11 @@ \|`logLevel`\|`number`\|No\|`LogLevel.Warn`\|`LogLevel.None` or `LogLevel.Error` or `LogLevel.Warn` or `LogLevel.Verbose` or `LogLevel.Debug`. Sets the log level.\|
		## Privacy
		By default, the session recording will mask all inputs, meaning the text in inputs will appear in a session replay as asterisks: `***`. You may require more specific masking controls based on your use case, so we offer the following controls:
		By default, the session replay will mask all inputs, meaning the text in inputs will appear in a session replay as asterisks: `***`. You may require more specific masking controls based on your use case, so we offer the following controls:

		#### 1. Unmask inputs
		In your application code, add the class `.amp-unmask` to any __input__ whose text you'd like to have unmasked in the recording. In the replay of a recorded session, it will be possible to read the exact text entered into an input with this class, the text will not be converted to asterisks.
		In your application code, add the class `.amp-unmask` to any __input__ whose text you'd like to have unmasked in the replay. In the session replay, it will be possible to read the exact text entered into an input with this class, the text will not be converted to asterisks.

		#### 2. Mask non-input elements
		In your application code, add the class `.amp-mask` to any __non-input element__ whose text you'd like to have masked from the recording. The text in the element, as well as it's children, will all be converted to asterisks.
		In your application code, add the class `.amp-mask` to any __non-input element__ whose text you'd like to have masked from the replay. The text in the element, as well as it's children, will all be converted to asterisks.

		#### 3. Block non-text elements
		In your application code, add the class `.amp-block` to any element you would like to have blocked from the recording. The element will appear in the replay as a placeholder with the same dimensions.
		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.

@amplitude/session-replay-browser - npm Package Compare versions

New alerts

Fixed alerts

Improved metrics