@coralogix/browser 1.1.1 → 1.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -109,6 +109,16 @@ CoralogixRum.init({
109
109
  });
110
110
  ```
111
111
 
112
+ #### Recording Manually
113
+ You can always start/stop your session recording manually as follows:
114
+ ```javascript
115
+ // To start manually the Session Recording
116
+ CoralogixRum.startSessionRecording();
117
+
118
+ // To stop the Session Recording
119
+ CoralogixRum.stopSessionRecording();
120
+ ```
121
+
112
122
  #### Privacy & Security
113
123
  To protect your users’ privacy and sensitive information, elements containing certain class names are blocked or masked in recordings, as follows:
114
124
 
@@ -117,20 +127,24 @@ CoralogixRum.init({
117
127
  // ...
118
128
  sessionRecordingConfig: {
119
129
  // ..
120
- blockClass: 'rr-block', // Use a string or RegExp to configure which elements should be blocked.
121
- ignoreClass: 'rr-ignore', // Use a string or RegExp to configure which elements should be ignored.
122
- maskTextClass: 'rr-mask', // Use a string or RegExp to configure which elements should be masked.
130
+ blockClass: 'rr-block', // Use a string or RegExp to redact all elements that contain this class, defaults to rr-block.
131
+ ignoreClass: 'rr-ignore', // Use a string or RegExp to Ignore all events that contain this class, defaults to rr-ignore.
132
+ maskTextClass: 'rr-mask', // Use a string or RegExp to mask all elements that contain this class, defaults to rr-mask.
123
133
  maskAllInputs: false, // Mask all input content as * (Default false), refer to Input types.
124
134
  maskInputOptions: { password:true } // Mask some kinds of input as *, By Default the SDK masking password inputs.
125
135
  },
126
136
  });
127
137
  ```
138
+ Example:
139
+ ```html
140
+ <div class="rr-block">Dont record me</div>
141
+ ```
128
142
 
129
143
 
130
144
  | Element | Action |
131
145
  | --- |---------------------------------------------------------------------------------------------|
132
- | .rr-block | The element will not be recorded. It will replay as a placeholder with the same dimension. |
133
- | .rr-ignore | The element will not recorded. |
146
+ | .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. |
147
+ | .rr-ignore | An element with the class name .rr-ignore will not record its input events |
134
148
  | .rr-mask | All text of elements and their children will be masked. |
135
149
 
136
150
  #### Performance
@@ -147,16 +161,6 @@ CoralogixRum.init({
147
161
  });
148
162
  ```
149
163
 
150
- #### Recording Manually
151
- You can always start/stop your session recording manually as follows:
152
- ```javascript
153
- // To stop the Session Recording
154
- CoralogixRum.stopSessionRecording();
155
-
156
- // To start manually the Session Recording
157
- CoralogixRum.startSessionRecording();
158
- ```
159
-
160
164
  ### Ignore Errors
161
165
  The ignoreErrors option allows you to exclude errors that meet specific criteria.
162
166
  This options accepts a set of strings and regular expressions to match against the event's error message.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@coralogix/browser",
3
- "version": "1.1.1",
3
+ "version": "1.1.2",
4
4
  "description": "Official Coralogix SDK for browsers",
5
5
  "license": "MIT",
6
6
  "dependencies": {
package/src/version.d.ts CHANGED
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "1.1.1";
1
+ export declare const SDK_VERSION = "1.1.2";
package/src/version.js CHANGED
@@ -1,2 +1,2 @@
1
- export const SDK_VERSION = '1.1.1';
1
+ export const SDK_VERSION = '1.1.2';
2
2
  //# sourceMappingURL=version.js.map