@coralogix/browser 1.0.105 → 1.1.2

package/README.md

@@ -29,7 +29,7 @@ CoralogixRum.init({
     payment: 'visa',
   },
   ignoreErrors: ['some error message to ignore'],
-  sessionSampleRate: 100 // Percentage of overall sessions being tracked, defaults to 100% 
+  sessionSampleRate: 100 // Percentage of overall sessions being tracked, Default to 100% 
 });
 ```
 
@@ -70,8 +70,9 @@ CoralogixRum.log(CoralogixLogSeverity.Error, 'this is a log', { key: 'value' })
 CoralogixRum.error('this is a log with error severity', { key: 'value' })
 ```
 
-### instrumentations
-Turn on/off specific instrumentations, defaults to all true.
+### Instrumentation's
+Turn on/off specific instrumentation, default to all trues.
+Each instrumentation is responsible for which data the SDK will track and collect for you.
 
 ```javascript
 CoralogixRum.init({
@@ -89,6 +90,77 @@ CoralogixRum.init({
 });
 ````
 
+### Session Recording
+Session Recording enhances your user experience monitoring by enabling you to record and visually replay the web browsing activities of your users.
+
+```javascript
+CoralogixRum.init({
+  // ...
+  sessionRecordingConfig: {
+    enable: true, // Must declare.
+    /**
+     * If autoStartSessionRecording is false, you can manually start & stop your session recording.
+     * Refer to Recording Manually Section.
+     **/
+    autoStartSessionRecording: true, // Automatically records your session when SDK is up.
+    recordConsoleEvents: true, // Will record all console events from dev tools. Levels: log, debug, warn, error, info, table etc..
+    sessionRecordingSampleRate: 100, // Percentage of overall sessions recording being tracked, defaults to 100% and applied after the overall sessionSampleRate.
+  },
+});
+```
+
+#### Recording Manually
+You can always start/stop your session recording manually as follows:
+```javascript
+// To start manually the Session Recording
+CoralogixRum.startSessionRecording();
+
+// To stop the Session Recording
+CoralogixRum.stopSessionRecording();
+```
+
+#### Privacy & Security
+To protect your users’ privacy and sensitive information, elements containing certain class names are blocked or masked in recordings, as follows:
+
+```javascript
+CoralogixRum.init({
+  // ...
+  sessionRecordingConfig: {
+    // ..
+    blockClass: 'rr-block', // Use a string or RegExp to redact all elements that contain this class, defaults to rr-block.
+    ignoreClass: 'rr-ignore', // Use a string or RegExp to Ignore all events that contain this class, defaults to rr-ignore.
+    maskTextClass: 'rr-mask', // Use a string or RegExp to mask all elements that contain this class, defaults to rr-mask.
+    maskAllInputs: false, // Mask all input content as * (Default false), refer to Input types.
+    maskInputOptions: { password:true } // Mask some kinds of input as *, By Default the SDK masking password inputs.
+  },
+});
+```
+Example:
+```html
+<div class="rr-block">Dont record me</div>
+```
+
+
+| Element | Action                                                                                      |
+| --- |---------------------------------------------------------------------------------------------|
+| .rr-block | An element with the class name .rr-block will not be recorded. Instead, it will replay as a placeholder with the same dimension. |
+| .rr-ignore | An element with the class name .rr-ignore will not record its input events                                                           |
+| .rr-mask | All text of elements and their children will be masked.                                     |
+
+#### Performance
+Session Recording works by recording incremental DOM changes that occur in your web application.
+To avoid performance issues, Session Recording will stop recording if it detects a large number of mutations (Default: 5,000).
+```javascript
+CoralogixRum.init({
+  // ...
+  sessionRecordingConfig: {
+    // ...
+    // According to MutationObserver API, A large number of DOM mutations can negatively impact performance
+    maxMutations: 5000
+  },
+});
+```
+
 ### Ignore Errors
 The ignoreErrors option allows you to exclude errors that meet specific criteria.
 This options accepts a set of strings and regular expressions to match against the event's error message.
@@ -105,7 +177,6 @@ CoralogixRum.init({
 
 ### Mask elements
 User interactions with specific elements can be masked to prevent sensitive data exposure.
-
 <br>use `maskInputTypes` to specify the types of inputs to mask. defaults to: `['password', 'email', 'tel']`
 <br>use `maskClass` to specify the class name that will be used to mask any element, string or RegExp. default is `cx-mask`.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@coralogix/browser",
-  "version": "1.0.105",
+  "version": "1.1.2",
   "description": "Official Coralogix SDK for browsers",
   "license": "MIT",
   "dependencies": {

package/src/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "1.0.105";
+export declare const SDK_VERSION = "1.1.2";

package/src/version.js

@@ -1,2 +1,2 @@
-export const SDK_VERSION = '1.0.105';
+export const SDK_VERSION = '1.1.2';
 //# sourceMappingURL=version.js.map

package/src/version.js.map

@@ -1 +1 @@
-{"version":3,"file":"version.js","sourceRoot":"","sources":["../../../../libs/browser/src/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,WAAW,GAAG,SAAS,CAAC"}
+{"version":3,"file":"version.js","sourceRoot":"","sources":["../../../../libs/browser/src/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,WAAW,GAAG,OAAO,CAAC"}