@groundcover/browser 1.0.2 → 1.0.3
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 +6 -5
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -54,8 +54,9 @@ groundcover.init({
|
|
|
54
54
|
```
|
|
55
55
|
|
|
56
56
|
That single call installs every instrumentation (page loads, DOM interactions, network requests,
|
|
57
|
-
errors, console logs, navigation,
|
|
58
|
-
|
|
57
|
+
errors, console logs, navigation, and performance) and starts sending data. Session replay is the
|
|
58
|
+
one exception — it must be started explicitly with
|
|
59
|
+
[`startReplayRecording()`](#session-replay). From here you can enrich it:
|
|
59
60
|
|
|
60
61
|
```ts
|
|
61
62
|
// Tie events to a user
|
|
@@ -121,7 +122,7 @@ groundcover.init({
|
|
|
121
122
|
| `debug` | `boolean` | `false` | Verbose SDK console logging. |
|
|
122
123
|
| `sessionSampleRate` | `number` | `1` | Fraction of sessions captured (0–1). |
|
|
123
124
|
| `eventSampleRate` | `number` | `1` | Fraction of events captured (0–1). |
|
|
124
|
-
| `enabledEvents` | `Array<…>` | `[]` | Instrumentations to enable. **Empty = all.** Members: `dom`, `network`, `exceptions`, `logs`, `pageload`, `navigation`, `performance`, `replay`. |
|
|
125
|
+
| `enabledEvents` | `Array<…>` | `[]` | Instrumentations to enable. **Empty = all.** Members: `dom`, `network`, `exceptions`, `logs`, `pageload`, `navigation`, `performance`, `replay`. Note: `replay` still requires an explicit [`startReplayRecording()`](#session-replay) call — it never auto-starts. |
|
|
125
126
|
| `excludedUrls` | `Array<string \| RegExp>` | — | Network requests matching these are not captured. |
|
|
126
127
|
| `sessionMaxDuration` | `number` | `4h` | Target max session length in ms (1 min – 8 h). See [session lifecycle](#session-lifecycle). |
|
|
127
128
|
| `beforeSend` | `(event) => boolean` | — | Drop gate — return `false` to discard an event. Runs after redaction/enrichment; see [event lifecycle](#architecture). |
|
|
@@ -263,8 +264,8 @@ record-time masking from your [`privacy`](#privacy--data-masking) config:
|
|
|
263
264
|
- `privacy.replay.maskTextFn` / `maskInputFn` → rrweb `maskTextFn` / `maskInputFn`
|
|
264
265
|
- `options.replay.blockedSelectors` → rrweb `blockSelector` (noise reduction)
|
|
265
266
|
|
|
266
|
-
|
|
267
|
-
|
|
267
|
+
Replay recording does **not** start automatically — even when `replay` is in `enabledEvents`. You
|
|
268
|
+
must start it explicitly (e.g. after obtaining user consent):
|
|
268
269
|
|
|
269
270
|
```ts
|
|
270
271
|
groundcover.startReplayRecording();
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@groundcover/browser",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.3",
|
|
4
4
|
"description": "groundcover Real User Monitoring (RUM) SDK for the browser — performance, errors, logs, distributed tracing and session replay",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"module": "dist/index.mjs",
|