@kubesense/kubesense-browser-rum-core 1.3.0 → 1.5.0
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 +8 -1
- package/cjs/boot/preStartRum.js +18 -0
- package/cjs/boot/preStartRum.js.map +1 -1
- package/cjs/domain/configuration/configuration.d.ts +31 -0
- package/cjs/domain/configuration/configuration.js +2 -0
- package/cjs/domain/configuration/configuration.js.map +1 -1
- package/cjs/domain/configuration/index.d.ts +2 -0
- package/cjs/domain/configuration/index.js +2 -0
- package/cjs/domain/configuration/index.js.map +1 -1
- package/cjs/domain/configuration/remoteSdkConfiguration.d.ts +18 -0
- package/cjs/domain/configuration/remoteSdkConfiguration.js +142 -0
- package/cjs/domain/configuration/remoteSdkConfiguration.js.map +1 -0
- package/cjs/domain/configuration/sessionReplayRoutes.d.ts +35 -0
- package/cjs/domain/configuration/sessionReplayRoutes.js +70 -0
- package/cjs/domain/configuration/sessionReplayRoutes.js.map +1 -0
- package/cjs/domain/contexts/defaultContext.js +1 -1
- package/cjs/index.d.ts +2 -1
- package/cjs/index.js +4 -1
- package/cjs/index.js.map +1 -1
- package/cjs/rumEvent.types.d.ts +4 -0
- package/esm/boot/preStartRum.js +19 -1
- package/esm/boot/preStartRum.js.map +1 -1
- package/esm/domain/configuration/configuration.d.ts +31 -0
- package/esm/domain/configuration/configuration.js +2 -0
- package/esm/domain/configuration/configuration.js.map +1 -1
- package/esm/domain/configuration/index.d.ts +2 -0
- package/esm/domain/configuration/index.js +2 -0
- package/esm/domain/configuration/index.js.map +1 -1
- package/esm/domain/configuration/remoteSdkConfiguration.d.ts +18 -0
- package/esm/domain/configuration/remoteSdkConfiguration.js +137 -0
- package/esm/domain/configuration/remoteSdkConfiguration.js.map +1 -0
- package/esm/domain/configuration/sessionReplayRoutes.d.ts +35 -0
- package/esm/domain/configuration/sessionReplayRoutes.js +65 -0
- package/esm/domain/configuration/sessionReplayRoutes.js.map +1 -0
- package/esm/domain/contexts/defaultContext.js +1 -1
- package/esm/index.d.ts +2 -1
- package/esm/index.js +1 -0
- package/esm/index.js.map +1 -1
- package/esm/rumEvent.types.d.ts +4 -0
- package/package.json +13 -3
- package/src/boot/preStartRum.ts +23 -0
- package/src/domain/configuration/configuration.ts +35 -0
- package/src/domain/configuration/index.ts +2 -0
- package/src/domain/configuration/remoteSdkConfiguration.ts +190 -0
- package/src/domain/configuration/sessionReplayRoutes.ts +96 -0
- package/src/index.ts +2 -0
- package/src/rumEvent.types.ts +4 -0
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"preStartRum.js","sourceRoot":"","sources":["../../src/boot/preStartRum.ts"],"names":[],"mappings":"AACA,OAAO,EACL,mBAAmB,EACnB,OAAO,EACP,iBAAiB,EACjB,8BAA8B,EAC9B,uBAAuB,EACvB,IAAI,EACJ,YAAY,EACZ,SAAS,EACT,cAAc,EACd,gBAAgB,EAChB,yBAAyB,EACzB,mBAAmB,EACnB,kBAAkB,EAClB,0BAA0B,EAC1B,yBAAyB,EACzB,uBAAuB,EACvB,YAAY,EACZ,QAAQ,GACT,MAAM,mCAAmC,CAAA;AAE1C,OAAO,EACL,gCAAgC,EAChC,gCAAgC,EAChC,yBAAyB,
|
|
1
|
+
{"version":3,"file":"preStartRum.js","sourceRoot":"","sources":["../../src/boot/preStartRum.ts"],"names":[],"mappings":"AACA,OAAO,EACL,mBAAmB,EACnB,OAAO,EACP,iBAAiB,EACjB,8BAA8B,EAC9B,uBAAuB,EACvB,IAAI,EACJ,YAAY,EACZ,SAAS,EACT,cAAc,EACd,gBAAgB,EAChB,yBAAyB,EACzB,mBAAmB,EACnB,kBAAkB,EAClB,0BAA0B,EAC1B,yBAAyB,EACzB,uBAAuB,EACvB,YAAY,EACZ,QAAQ,GACT,MAAM,mCAAmC,CAAA;AAE1C,OAAO,EACL,gCAAgC,EAChC,gCAAgC,EAChC,yBAAyB,EACzB,2BAA2B,EAC3B,+BAA+B,GAChC,MAAM,yBAAyB,CAAA;AAQhC,OAAO,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAA;AACvF,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAA;AAIrD,MAAM,UAAU,sBAAsB,CACpC,EAAE,mCAAmC,GAAG,IAAI,EAAE,kBAAkB,EAAuB,EACvF,oBAA0C,EAC1C,iBAAoC,EACpC,UAImB;IAEnB,MAAM,cAAc,GAAG,mBAAmB,EAAkB,CAAA;IAE5D,wJAAwJ;IACxJ,MAAM,aAAa,GAAG,yBAAyB,EAAE,CAAA;IACjD,kBAAkB,CAAC,aAAa,EAAE,kBAAkB,CAAC,aAAa,EAAE,cAAc,CAAC,CAAA;IAEnF,MAAM,WAAW,GAAG,uBAAuB,EAAE,CAAA;IAC7C,kBAAkB,CAAC,WAAW,EAAE,kBAAkB,CAAC,WAAW,EAAE,cAAc,CAAC,CAAA;IAE/E,MAAM,cAAc,GAAG,0BAA0B,EAAE,CAAA;IACnD,kBAAkB,CAAC,cAAc,EAAE,kBAAkB,CAAC,cAAc,EAAE,cAAc,CAAC,CAAA;IAErF,IAAI,kBAES,CAAA;IACb,IAAI,aAAwC,CAAA;IAE5C,IAAI,uBAAyD,CAAA;IAC7D,IAAI,mBAAiD,CAAA;IAErD,MAAM,gCAAgC,GAAG,oBAAoB,CAAC,UAAU,CAAC,SAAS,CAAC,WAAW,CAAC,CAAA;IAE/F,MAAM,YAAY,GAAY,EAAE,CAAA;IAEhC,SAAS,WAAW;QAClB,IAAI,CAAC,uBAAuB,IAAI,CAAC,mBAAmB,IAAI,CAAC,oBAAoB,CAAC,SAAS,EAAE,EAAE,CAAC;YAC1F,OAAM;QACR,CAAC;QAED,gCAAgC,CAAC,WAAW,EAAE,CAAA;QAE9C,IAAI,kBAA2C,CAAA;QAE/C,IAAI,mBAAmB,CAAC,kBAAkB,EAAE,CAAC;YAC3C,IAAI,CAAC,kBAAkB,EAAE,CAAC;gBACxB,OAAM;YACR,CAAC;YACD,uDAAuD;YACvD,0FAA0F;YAC1F,QAAQ;YACR,4FAA4F;YAC5F,4FAA4F;YAC5F,QAAQ;YACR,cAAc,CAAC,MAAM,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAA;YAClD,kBAAkB,GAAG,kBAAkB,CAAC,OAAO,CAAA;QACjD,CAAC;QAED,MAAM,cAAc,GAAG,UAAU,CAAC,mBAAmB,EAAE,aAAa,EAAE,kBAAkB,CAAC,CAAA;QAEzF,cAAc,CAAC,KAAK,CAAC,cAAc,CAAC,CAAA;IACtC,CAAC;IAED,SAAS,MAAM,CAAC,iBAAuC,EAAE,UAAmB;QAC1E,MAAM,oBAAoB,GAAG,iBAAiB,EAAE,CAAA;QAChD,IAAI,oBAAoB,EAAE,CAAC;YACzB,iBAAiB,GAAG,kCAAkC,CAAC,iBAAiB,CAAC,CAAA;QAC3E,CAAC;QAED,MAAM,6BAA6B,GAAG,CAAC,CAAC,iBAAiB,CAAC,4BAA4B,CAAA;QACtF,IAAI,6BAA6B,EAAE,CAAC;YAClC,oFAAoF;YACpF,mFAAmF;YACnF,MAAM,sBAAsB,GAAG,2BAA2B,CAAC,iBAAiB,CAAC,CAAA;YAC7E,iBAAiB,GAAG,sBAAsB,CAAC,iBAAiB,CAAA;YAE5D,IAAI,CAAC,sBAAsB,CAAC,UAAU,EAAE,CAAC;gBACvC,oFAAoF;gBACpF,sFAAsF;gBACtF,uBAAuB,GAAG,iBAAiB,CAAA;gBAC3C,+BAA+B,CAAC,iBAAiB,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,CAAA;gBACtE,OAAM;YACR,CAAC;QACH,CAAC;QAED,gGAAgG;QAChG,uBAAuB,GAAG,iBAAiB,CAAA;QAC3C,yBAAyB,CAAC,yBAAyB,CAAC,iBAAiB,CAAC,CAAC,CAAA;QAEvE,IAAI,mBAAmB,EAAE,CAAC;YACxB,8BAA8B,CAAC,eAAe,EAAE,iBAAiB,CAAC,CAAA;YAClE,OAAM;QACR,CAAC;QAED,MAAM,aAAa,GAAG,gCAAgC,CAAC,iBAAiB,EAAE,UAAU,CAAC,CAAA;QACrF,IAAI,CAAC,aAAa,EAAE,CAAC;YACnB,OAAM;QACR,CAAC;QAED,IAAI,CAAC,oBAAoB,IAAI,CAAC,aAAa,CAAC,wBAAwB,EAAE,CAAC;YACrE,OAAO,CAAC,IAAI,CAAC,8DAA8D,CAAC,CAAA;YAC5E,OAAM;QACR,CAAC;QAED,IAAI,aAAa,CAAC,sBAAsB,IAAI,CAAC,oBAAoB,IAAI,kBAAkB,EAAE,CAAC;YACxF,aAAa,GAAG,kBAAkB,CAChC,aAAa,EACb,gBAAgB;YAChB,sFAAsF;YACtF,2FAA2F;YAC3F,kFAAkF;YAClF,IAAI,CACL,CAAA;YACD,IAAI,CAAC,aAAa,EAAE,CAAC;gBACnB,gFAAgF;gBAChF,OAAM;YACR,CAAC;QACH,CAAC;QAED,mBAAmB,GAAG,aAAa,CAAA;QACnC,6CAA6C;QAC7C,sEAAsE;QACtE,2EAA2E;QAC3E,8EAA8E;QAC9E,mBAAmB,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,CAAA;QAErC,oBAAoB,CAAC,SAAS,CAAC,aAAa,CAAC,eAAe,CAAC,CAAA;QAC7D,WAAW,EAAE,CAAA;QAEb,IAAI,6BAA6B,EAAE,CAAC;YAClC,yFAAyF;YACzF,+BAA+B,CAAC,iBAAiB,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,CAAA;QACxE,CAAC;IACH,CAAC;IAED,MAAM,gBAAgB,GAAG,CAAC,KAAoB,EAAE,EAAE;QAChD,cAAc,CAAC,GAAG,CAAC,CAAC,cAAc,EAAE,EAAE,CAAC,cAAc,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,CAAA;IAChF,CAAC,CAAA;IAED,MAAM,qBAAqB,GAAG,CAC5B,IAAY,EACZ,QAAyB,EACzB,OAAiC,EACjC,aAA6B,EAC7B,EAAE;QACF,cAAc,CAAC,GAAG,CAAC,CAAC,cAAc,EAAE,EAAE,CACpC,cAAc,CAAC,qBAAqB,CAClC,QAAQ,CAAC,IAAI,CAAE,EACf,QAAQ,EACR,QAAQ,CAAC,OAAO,CAA4B,EAC5C,QAAQ,CAAC,aAAa,CAA8B,CACrD,CACF,CAAA;IACH,CAAC,CAAA;IAED,MAAM,QAAQ,GAAa;QACzB,IAAI,CAAC,iBAAiB,EAAE,SAAS,EAAE,UAAU;YAC3C,IAAI,CAAC,iBAAiB,EAAE,CAAC;gBACvB,OAAO,CAAC,KAAK,CAAC,uBAAuB,CAAC,CAAA;gBACtC,OAAM;YACR,CAAC;YACD,6FAA6F;YAC7F,gBAAgB,CAAC,iBAAiB,CAAC,0BAA0B,CAAC,CAAA;YAE9D,yEAAyE;YACzE,uBAAuB,GAAG,iBAAiB,CAAA;YAE3C,4FAA4F;YAC5F,6FAA6F;YAC7F,8FAA8F;YAC9F,0FAA0F;YAC1F,IAAI,mCAAmC,IAAI,uBAAuB,EAAE,EAAE,CAAC;gBACrE,OAAM;YACR,CAAC;YAED,iBAAiB,CAAC,iBAAiB,CAAC,OAAO,EAAE,QAAQ,EAAE,EAAE,iBAAiB,EAAE,SAAS,EAAE,CAAC,CAAA;YAExF,IAAI,iBAAiB,CAAC,qBAAqB,EAAE,CAAC;gBAC5C,gCAAgC,CAAC,iBAAiB,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,OAAO,EAAE,aAAa,EAAE,CAAC;qBAC/F,IAAI,CAAC,CAAC,iBAAiB,EAAE,EAAE;oBAC1B,IAAI,iBAAiB,EAAE,CAAC;wBACtB,MAAM,CAAC,iBAAiB,EAAE,UAAU,CAAC,CAAA;oBACvC,CAAC;gBACH,CAAC,CAAC;qBACD,KAAK,CAAC,YAAY,CAAC,CAAA;YACxB,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,iBAAiB,EAAE,UAAU,CAAC,CAAA;YACvC,CAAC;QACH,CAAC;QAED,IAAI,iBAAiB;YACnB,OAAO,uBAAuB,CAAA;QAChC,CAAC;QAED,kBAAkB,EAAE,IAAuB;QAE3C,WAAW,EAAE,IAAI;QAEjB,SAAS,CAAC,IAAI,EAAE,IAAI,GAAG,YAAY,EAAE;YACnC,cAAc,CAAC,GAAG,CAAC,CAAC,cAAc,EAAE,EAAE,CAAC,cAAc,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAA;QAC9E,CAAC;QAED,SAAS,CAAC,OAAO,EAAE,WAAW,GAAG,SAAS,EAAE;YAC1C,MAAM,QAAQ,GAAG,CAAC,cAA8B,EAAE,EAAE;gBAClD,cAAc,CAAC,SAAS,CAAC,OAAO,EAAE,WAAW,CAAC,CAAA;YAChD,CAAC,CAAA;YACD,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;YAE5B,IAAI,CAAC,kBAAkB,EAAE,CAAC;gBACxB,kBAAkB,GAAG,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAA;gBAC1C,WAAW,EAAE,CAAA;YACf,CAAC;QACH,CAAC;QAED,WAAW,CAAC,IAAI;YACd,cAAc,CAAC,GAAG,CAAC,CAAC,cAAc,EAAE,EAAE,CAAC,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAA;QAC1E,CAAC;QAED,oBAAoB;QAEpB,cAAc,CAAC,OAAO;YACpB,cAAc,CAAC,GAAG,CAAC,CAAC,cAAc,EAAE,EAAE,CAAC,cAAc,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAA;QAChF,CAAC;QAED,sBAAsB,CAAC,GAAG,EAAE,KAAK;YAC/B,cAAc,CAAC,GAAG,CAAC,CAAC,cAAc,EAAE,EAAE,CAAC,cAAc,CAAC,sBAAsB,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAA;QAC3F,CAAC;QAED,cAAc,EAAE,GAAG,EAAE,CAAC,YAAY;QAElC,aAAa;QACb,WAAW;QACX,cAAc;QAEd,SAAS,CAAC,MAAM;YACd,cAAc,CAAC,GAAG,CAAC,CAAC,cAAc,EAAE,EAAE,CAAC,cAAc,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAA;QAC1E,CAAC;QAED,QAAQ,CAAC,aAAa;YACpB,cAAc,CAAC,GAAG,CAAC,CAAC,cAAc,EAAE,EAAE,CAAC,cAAc,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC,CAAA;QAChF,CAAC;QAED,wBAAwB,CAAC,GAAG,EAAE,KAAK;YACjC,cAAc,CAAC,GAAG,CAAC,CAAC,cAAc,EAAE,EAAE,CAAC,cAAc,CAAC,wBAAwB,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAA;QAC7F,CAAC;QAED,kBAAkB,CAAC,IAAI,EAAE,OAAO;YAC9B,OAAO,kBAAkB,CAAC,iBAAiB,EAAE,IAAI,EAAE,OAAO,CAAC,CAAA;QAC7D,CAAC;QAED,iBAAiB,CAAC,IAAI,EAAE,OAAO;YAC7B,iBAAiB,CAAC,gBAAgB,EAAE,iBAAiB,EAAE,IAAI,EAAE,OAAO,CAAC,CAAA;QACvE,CAAC;QAED,gBAAgB;QAChB,qBAAqB;KACtB,CAAA;IAED,OAAO,QAAQ,CAAA;AACjB,CAAC;AAED,SAAS,kCAAkC,CAAC,iBAAuC;;IACjF,OAAO;QACL,GAAG,iBAAiB;QACpB,aAAa,EAAE,sCAAsC;QACrD,WAAW,EAAE,OAAO;QACpB,iBAAiB,EAAE,GAAG;QACtB,mBAAmB,EAAE,MAAA,iBAAiB,CAAC,mBAAmB,mCAAI,MAAA,cAAc,EAAE,0CAAE,eAAe,EAAE;KAClG,CAAA;AACH,CAAC;AAED,SAAS,kBAAkB,CACzB,sBAAsC,EACtC,IAAwB,EACxB,cAA6C;IAE7C,sBAAsB,CAAC,gBAAgB,CAAC,SAAS,CAAC,GAAG,EAAE;QACrD,MAAM,OAAO,GAAG,sBAAsB,CAAC,UAAU,EAAE,CAAA;QACnD,cAAc,CAAC,GAAG,CAAC,CAAC,cAAc,EAAE,EAAE,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAA;IAClF,CAAC,CAAC,CAAA;AACJ,CAAC"}
|
|
@@ -4,6 +4,7 @@ import type { RumEventDomainContext } from '../../domainContext.types';
|
|
|
4
4
|
import type { RumEvent } from '../../rumEvent.types';
|
|
5
5
|
import type { RumPlugin } from '../plugins';
|
|
6
6
|
import type { PropagatorType, TracingOption } from '../tracing/tracer.types';
|
|
7
|
+
import type { SessionReplayRoutes } from './sessionReplayRoutes';
|
|
7
8
|
export declare const DEFAULT_PROPAGATOR_TYPES: PropagatorType[];
|
|
8
9
|
/**
|
|
9
10
|
* Init Configuration for the RUM browser SDK.
|
|
@@ -88,6 +89,17 @@ export interface RumInitConfiguration extends InitConfiguration {
|
|
|
88
89
|
* @internal
|
|
89
90
|
*/
|
|
90
91
|
remoteConfigurationProxy?: string | undefined;
|
|
92
|
+
/**
|
|
93
|
+
* Enable dashboard-managed SDK settings served by the Kubesense collector.
|
|
94
|
+
*
|
|
95
|
+
* The configuration document is fetched asynchronously after the SDK starts and cached in
|
|
96
|
+
* local storage, so it never delays initialization. Cached settings are applied on the next
|
|
97
|
+
* page load. Local `init()` values are used until a document has been fetched, and any
|
|
98
|
+
* setting absent from the document keeps its local value.
|
|
99
|
+
*
|
|
100
|
+
* @defaultValue false
|
|
101
|
+
*/
|
|
102
|
+
enableRemoteSdkConfiguration?: boolean | undefined;
|
|
91
103
|
/**
|
|
92
104
|
* A list of request URLs used to inject tracing headers.
|
|
93
105
|
* See [Connect RUM and Traces](https://docs.kubesense.ai/real_user_monitoring/platform/connect_rum_and_traces/?tab=browserrum) for further information.
|
|
@@ -143,6 +155,24 @@ export interface RumInitConfiguration extends InitConfiguration {
|
|
|
143
155
|
* @category Session Replay
|
|
144
156
|
*/
|
|
145
157
|
startSessionReplayRecordingManually?: boolean | undefined;
|
|
158
|
+
/**
|
|
159
|
+
* Restrict Session Replay recording to specific routes.
|
|
160
|
+
*
|
|
161
|
+
* Recording starts and stops as the user navigates: it runs only while the current route
|
|
162
|
+
* matches `include` (when provided) and does not match `exclude`. Rules are matched against
|
|
163
|
+
* the path (`pathname` + `search` + `hash`), and string entries match by prefix, so
|
|
164
|
+
* `/checkout` also covers `/checkout/payment`.
|
|
165
|
+
*
|
|
166
|
+
* These rules only narrow recording — a session that was not sampled in by
|
|
167
|
+
* `sessionReplaySampleRate` is never recorded, whatever the routes say.
|
|
168
|
+
*
|
|
169
|
+
* @category Session Replay
|
|
170
|
+
* @example
|
|
171
|
+
* ```ts
|
|
172
|
+
* sessionReplayRoutes: { include: ['/checkout', '/signup'], exclude: ['/checkout/card'] }
|
|
173
|
+
* ```
|
|
174
|
+
*/
|
|
175
|
+
sessionReplayRoutes?: SessionReplayRoutes | undefined;
|
|
146
176
|
/**
|
|
147
177
|
* Enables privacy control for action names.
|
|
148
178
|
*
|
|
@@ -255,6 +285,7 @@ export interface RumConfiguration extends Configuration {
|
|
|
255
285
|
enablePrivacyForActionName: boolean;
|
|
256
286
|
sessionReplaySampleRate: number;
|
|
257
287
|
startSessionReplayRecordingManually: boolean;
|
|
288
|
+
sessionReplayRoutes: SessionReplayRoutes | undefined;
|
|
258
289
|
trackUserInteractions: boolean;
|
|
259
290
|
trackViewsManually: boolean;
|
|
260
291
|
trackResources: boolean;
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { getType, isMatchOption, serializeConfiguration, DefaultPrivacyLevel, TraceContextInjection, display, objectHasValue, validateAndBuildConfiguration, isSampleRate, isNumber, isNonEmptyArray, } from '@kubesense/kubesense-browser-core';
|
|
2
2
|
import { isTracingOption } from '../tracing/tracer';
|
|
3
|
+
import { validateSessionReplayRoutes } from './sessionReplayRoutes';
|
|
3
4
|
export const DEFAULT_PROPAGATOR_TYPES = ['tracecontext', 'kubesense'];
|
|
4
5
|
export function validateAndBuildRumConfiguration(initConfiguration, errorStack) {
|
|
5
6
|
var _a, _b, _c, _d, _e, _f, _g, _h;
|
|
@@ -36,6 +37,7 @@ export function validateAndBuildRumConfiguration(initConfiguration, errorStack)
|
|
|
36
37
|
startSessionReplayRecordingManually: initConfiguration.startSessionReplayRecordingManually !== undefined
|
|
37
38
|
? !!initConfiguration.startSessionReplayRecordingManually
|
|
38
39
|
: sessionReplaySampleRate === 0,
|
|
40
|
+
sessionReplayRoutes: validateSessionReplayRoutes(initConfiguration.sessionReplayRoutes),
|
|
39
41
|
traceSampleRate: (_b = initConfiguration.traceSampleRate) !== null && _b !== void 0 ? _b : 100,
|
|
40
42
|
rulePsr: isNumber(initConfiguration.traceSampleRate) ? initConfiguration.traceSampleRate / 100 : undefined,
|
|
41
43
|
allowedTracingUrls,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"configuration.js","sourceRoot":"","sources":["../../../src/domain/configuration/configuration.ts"],"names":[],"mappings":"AACA,OAAO,EACL,OAAO,EACP,aAAa,EACb,sBAAsB,EACtB,mBAAmB,EACnB,qBAAqB,EACrB,OAAO,EACP,cAAc,EACd,6BAA6B,EAC7B,YAAY,EACZ,QAAQ,EACR,eAAe,GAChB,MAAM,mCAAmC,CAAA;AAI1C,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AAGnD,MAAM,CAAC,MAAM,wBAAwB,GAAqB,CAAC,cAAc,EAAE,WAAW,CAAC,CAAA;AA+
|
|
1
|
+
{"version":3,"file":"configuration.js","sourceRoot":"","sources":["../../../src/domain/configuration/configuration.ts"],"names":[],"mappings":"AACA,OAAO,EACL,OAAO,EACP,aAAa,EACb,sBAAsB,EACtB,mBAAmB,EACnB,qBAAqB,EACrB,OAAO,EACP,cAAc,EACd,6BAA6B,EAC7B,YAAY,EACZ,QAAQ,EACR,eAAe,GAChB,MAAM,mCAAmC,CAAA;AAI1C,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AAGnD,OAAO,EAAE,2BAA2B,EAAE,MAAM,uBAAuB,CAAA;AAEnE,MAAM,CAAC,MAAM,wBAAwB,GAAqB,CAAC,cAAc,EAAE,WAAW,CAAC,CAAA;AA+UvF,MAAM,UAAU,gCAAgC,CAC9C,iBAAuC,EACvC,UAAmB;;IAEnB,IACE,iBAAiB,CAAC,0BAA0B,KAAK,SAAS;QAC1D,CAAC,KAAK,CAAC,OAAO,CAAC,iBAAiB,CAAC,0BAA0B,CAAC,EAC5D,CAAC;QACD,OAAO,CAAC,IAAI,CAAC,+CAA+C,CAAC,CAAA;IAC/D,CAAC;IAED,IAAI,CAAC,iBAAiB,CAAC,aAAa,EAAE,CAAC;QACrC,OAAO,CAAC,KAAK,CAAC,kEAAkE,CAAC,CAAA;QACjF,OAAM;IACR,CAAC;IAED,IACE,CAAC,YAAY,CAAC,iBAAiB,CAAC,uBAAuB,EAAE,gBAAgB,CAAC;QAC1E,CAAC,YAAY,CAAC,iBAAiB,CAAC,eAAe,EAAE,OAAO,CAAC,EACzD,CAAC;QACD,OAAM;IACR,CAAC;IAED,IAAI,iBAAiB,CAAC,oBAAoB,KAAK,SAAS,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,iBAAiB,CAAC,oBAAoB,CAAC,EAAE,CAAC;QACnH,OAAO,CAAC,KAAK,CAAC,2CAA2C,CAAC,CAAA;QAC1D,OAAM;IACR,CAAC;IAED,MAAM,kBAAkB,GAAG,8BAA8B,CAAC,iBAAiB,CAAC,CAAA;IAC5E,IAAI,CAAC,kBAAkB,EAAE,CAAC;QACxB,OAAM;IACR,CAAC;IAED,MAAM,iBAAiB,GAAG,6BAA6B,CAAC,iBAAiB,EAAE,UAAU,CAAC,CAAA;IAEtF,MAAM,kBAAkB,GAAG,8BAA8B,CAAC,iBAAiB,CAAC,CAAA;IAE5E,IAAI,CAAC,iBAAiB,EAAE,CAAC;QACvB,OAAM;IACR,CAAC;IAED,MAAM,uBAAuB,GAAG,MAAA,iBAAiB,CAAC,uBAAuB,mCAAI,CAAC,CAAA;IAE9E,OAAO;QACL,aAAa,EAAE,iBAAiB,CAAC,aAAa;QAC9C,mBAAmB,EAAE,iBAAiB,CAAC,mBAAmB;QAC1D,uBAAuB;QACvB,mCAAmC,EACjC,iBAAiB,CAAC,mCAAmC,KAAK,SAAS;YACjE,CAAC,CAAC,CAAC,CAAC,iBAAiB,CAAC,mCAAmC;YACzD,CAAC,CAAC,uBAAuB,KAAK,CAAC;QACnC,mBAAmB,EAAE,2BAA2B,CAAC,iBAAiB,CAAC,mBAAmB,CAAC;QACvF,eAAe,EAAE,MAAA,iBAAiB,CAAC,eAAe,mCAAI,GAAG;QACzD,OAAO,EAAE,QAAQ,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,iBAAiB,CAAC,eAAe,GAAG,GAAG,CAAC,CAAC,CAAC,SAAS;QAC1G,kBAAkB;QAClB,oBAAoB,EAAE,MAAA,iBAAiB,CAAC,oBAAoB,mCAAI,EAAE;QAClE,SAAS,EAAE,iBAAiB,CAAC,SAAS;QACtC,sBAAsB,EAAE,CAAC,CAAC,iBAAiB,CAAC,sBAAsB;QAClE,qBAAqB,EAAE,CAAC,CAAC,CAAC,MAAA,iBAAiB,CAAC,qBAAqB,mCAAI,IAAI,CAAC;QAC1E,kBAAkB,EAAE,CAAC,CAAC,iBAAiB,CAAC,kBAAkB;QAC1D,cAAc,EAAE,CAAC,CAAC,CAAC,MAAA,iBAAiB,CAAC,cAAc,mCAAI,IAAI,CAAC;QAC5D,cAAc,EAAE,CAAC,CAAC,CAAC,MAAA,iBAAiB,CAAC,cAAc,mCAAI,IAAI,CAAC;QAC5D,iBAAiB,EAAE,CAAC,CAAC,iBAAiB,CAAC,iBAAiB;QACxD,kBAAkB,EAAE,CAAC,CAAC,iBAAiB,CAAC,kBAAkB;QAC1D,SAAS,EAAE,iBAAiB,CAAC,SAAS;QACtC,mBAAmB,EAAE,cAAc,CAAC,mBAAmB,EAAE,iBAAiB,CAAC,mBAAmB,CAAC;YAC7F,CAAC,CAAC,iBAAiB,CAAC,mBAAmB;YACvC,CAAC,CAAC,mBAAmB,CAAC,IAAI;QAC5B,0BAA0B,EAAE,CAAC,CAAC,iBAAiB,CAAC,0BAA0B;QAC1E,qBAAqB,EAAE,cAAc,CAAC,qBAAqB,EAAE,iBAAiB,CAAC,qBAAqB,CAAC;YACnG,CAAC,CAAC,iBAAiB,CAAC,qBAAqB;YACzC,CAAC,CAAC,qBAAqB,CAAC,OAAO;QACjC,OAAO,EAAE,iBAAiB,CAAC,OAAO,IAAI,EAAE;QACxC,0BAA0B,EAAE,iBAAiB,CAAC,0BAA0B,IAAI,EAAE;QAC9E,mBAAmB,EAAE,MAAA,iBAAiB,CAAC,mBAAmB,mCAAI,CAAC;QAC/D,qBAAqB,EAAE,CAAC,CAAC,iBAAiB,CAAC,qBAAqB;QAChE,kBAAkB;QAClB,iBAAiB,EAAE,MAAA,iBAAiB,CAAC,iBAAiB,mCAAI,EAAE;QAC5D,GAAG,iBAAiB;KACrB,CAAA;AACH,CAAC;AAED;;GAEG;AACH,SAAS,8BAA8B,CAAC,iBAAuC;IAC7E,IAAI,iBAAiB,CAAC,kBAAkB,KAAK,SAAS,EAAE,CAAC;QACvD,OAAO,EAAE,CAAA;IACX,CAAC;IACD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,iBAAiB,CAAC,kBAAkB,CAAC,EAAE,CAAC;QACzD,OAAO,CAAC,KAAK,CAAC,yCAAyC,CAAC,CAAA;QACxD,OAAM;IACR,CAAC;IACD,IAAI,iBAAiB,CAAC,kBAAkB,CAAC,MAAM,KAAK,CAAC,IAAI,iBAAiB,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;QACjG,OAAO,CAAC,KAAK,CAAC,wDAAwD,CAAC,CAAA;QACvE,OAAM;IACR,CAAC;IACD,yFAAyF;IACzF,MAAM,cAAc,GAAoB,EAAE,CAAA;IAC1C,iBAAiB,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;QACtD,IAAI,aAAa,CAAC,MAAM,CAAC,EAAE,CAAC;YAC1B,cAAc,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,eAAe,EAAE,wBAAwB,EAAE,CAAC,CAAA;QACnF,CAAC;aAAM,IAAI,eAAe,CAAC,MAAM,CAAC,EAAE,CAAC;YACnC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QAC7B,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,IAAI,CACV,wGAAwG,EACxG,MAAM,CACP,CAAA;QACH,CAAC;IACH,CAAC,CAAC,CAAA;IAEF,OAAO,cAAc,CAAA;AACvB,CAAC;AAED;;GAEG;AACH,SAAS,6BAA6B,CAAC,aAAmC;IACxE,MAAM,sBAAsB,GAAG,IAAI,GAAG,EAAkB,CAAA;IAExD,IAAI,eAAe,CAAC,aAAa,CAAC,kBAAkB,CAAC,EAAE,CAAC;QACtD,aAAa,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;YAClD,IAAI,aAAa,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC1B,wBAAwB,CAAC,OAAO,CAAC,CAAC,cAAc,EAAE,EAAE,CAAC,sBAAsB,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,CAAA;YAClG,CAAC;iBAAM,IAAI,OAAO,CAAC,MAAM,CAAC,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,eAAe,CAAC,EAAE,CAAC;gBACjF,+FAA+F;gBAC/F,MAAM,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,cAAc,EAAE,EAAE,CAAC,sBAAsB,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,CAAA;YAChG,CAAC;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAA;AAC3C,CAAC;AAED;;GAEG;AACH,SAAS,8BAA8B,CAAC,iBAAuC;IAC7E,IAAI,CAAC,iBAAiB,CAAC,kBAAkB,EAAE,CAAC;QAC1C,OAAO,EAAE,CAAA;IACX,CAAC;IAED,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,iBAAiB,CAAC,kBAAkB,CAAC,EAAE,CAAC;QACzD,OAAO,CAAC,IAAI,CAAC,uCAAuC,CAAC,CAAA;QACrD,OAAO,EAAE,CAAA;IACX,CAAC;IAED,MAAM,cAAc,GAAuB,EAAE,CAAA;IAE7C,iBAAiB,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;QACtD,IAAI,aAAa,CAAC,MAAM,CAAC,EAAE,CAAC;YAC1B,cAAc,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,KAAK,EAAE,mBAAmB,EAAE,KAAK,EAAE,CAAC,CAAA;QACzF,CAAC;aAAM,IAAI,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,OAAO,IAAI,MAAM,IAAI,aAAa,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;YACpG,cAAc,CAAC,IAAI,CAAC;gBAClB,KAAK,EAAE,MAAM,CAAC,KAAK;gBACnB,YAAY,EAAE,CAAC,CAAC,MAAM,CAAC,YAAY;gBACnC,mBAAmB,EAAE,CAAC,CAAC,MAAM,CAAC,mBAAmB;aAClD,CAAC,CAAA;QACJ,CAAC;IACH,CAAC,CAAC,CAAA;IAEF,OAAO,cAAc,CAAA;AACvB,CAAC;AAED,SAAS,yBAAyB,CAAC,kBAA8D;IAC/F,OAAO,CACL,eAAe,CAAC,kBAAkB,CAAC;QACnC,kBAAkB,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;YACjC,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,cAAc,IAAI,MAAM,EAAE,CAAC;gBAC3D,OAAO,CAAC,CAAC,MAAM,CAAC,YAAY,CAAA;YAC9B,CAAC;YACD,OAAO,KAAK,CAAA;QACd,CAAC,CAAC,CACH,CAAA;AACH,CAAC;AAED,SAAS,gCAAgC,CAAC,kBAA8D;IACtG,OAAO,CACL,eAAe,CAAC,kBAAkB,CAAC;QACnC,kBAAkB,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;YACjC,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,qBAAqB,IAAI,MAAM,EAAE,CAAC;gBAClE,OAAO,CAAC,CAAC,MAAM,CAAC,mBAAmB,CAAA;YACrC,CAAC;YACD,OAAO,KAAK,CAAA;QACd,CAAC,CAAC,CACH,CAAA;AACH,CAAC;AAED,MAAM,UAAU,yBAAyB,CAAC,aAAmC;;IAC3E,MAAM,2BAA2B,GAAG,sBAAsB,CAAC,aAAa,CAAC,CAAA;IAEzE,OAAO;QACL,0BAA0B,EAAE,aAAa,CAAC,uBAAuB;QACjE,uCAAuC,EAAE,aAAa,CAAC,mCAAmC;QAC1F,iBAAiB,EAAE,aAAa,CAAC,eAAe;QAChD,uBAAuB,EAAE,aAAa,CAAC,qBAAqB;QAC5D,uBAAuB,EAAE,aAAa,CAAC,qBAAqB;QAC5D,qBAAqB,EAAE,aAAa,CAAC,mBAAmB;QACxD,wBAAwB,EAAE,eAAe,CAAC,aAAa,CAAC,kBAAkB,CAAC;QAC3E,yBAAyB,EAAE,eAAe,CAAC,aAAa,CAAC,kBAAkB,CAAC;QAC5E,0BAA0B,EAAE,yBAAyB,CAAC,aAAa,CAAC,kBAAkB,CAAC;QACvF,kCAAkC,EAAE,gCAAgC,CAAC,aAAa,CAAC,kBAAkB,CAAC;QACtG,4BAA4B,EAAE,6BAA6B,CAAC,aAAa,CAAC;QAC1E,qBAAqB,EAAE,aAAa,CAAC,mBAAmB;QACxD,8BAA8B,EAAE,aAAa,CAAC,0BAA0B;QACxE,0BAA0B,EAAE,eAAe,CAAC,aAAa,CAAC,oBAAoB,CAAC;QAC/E,cAAc,EAAE,CAAC,CAAC,aAAa,CAAC,SAAS;QACzC,wBAAwB,EAAE,aAAa,CAAC,sBAAsB;QAC9D,oBAAoB,EAAE,aAAa,CAAC,kBAAkB;QACtD,uBAAuB,EAAE,aAAa,CAAC,qBAAqB;QAC5D,eAAe,EAAE,aAAa,CAAC,cAAc;QAC7C,eAAe,EAAE,aAAa,CAAC,cAAc;QAC7C,mBAAmB,EAAE,aAAa,CAAC,iBAAiB;QACpD,oBAAoB,EAAE,aAAa,CAAC,kBAAkB;QACtD,OAAO,EAAE,MAAA,aAAa,CAAC,OAAO,0CAAE,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;;YAAC,OAAA,CAAC;gBAC/C,IAAI,EAAE,MAAM,CAAC,IAAI;gBACjB,GAAG,MAAA,MAAM,CAAC,yBAAyB,sDAAI;aACxC,CAAC,CAAA;SAAA,CAAC;QACH,8BAA8B,EAAE,aAAa,CAAC,0BAA0B;QACxE,uBAAuB,EAAE,aAAa,CAAC,qBAAqB;QAC5D,qBAAqB,EAAE,aAAa,CAAC,mBAAmB;QACxD,8BAA8B,EAAE,CAAC,CAAC,aAAa,CAAC,wBAAwB;QACxE,GAAG,2BAA2B;KACK,CAAA;AACvC,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/domain/configuration/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAA;AAC/B,cAAc,uBAAuB,CAAA"}
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/domain/configuration/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAA;AAC/B,cAAc,uBAAuB,CAAA;AACrC,cAAc,0BAA0B,CAAA;AACxC,cAAc,uBAAuB,CAAA"}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import type { RemoteSdkConfig } from '@kubesense/kubesense-browser-core';
|
|
2
|
+
import type { RumInitConfiguration } from './configuration';
|
|
3
|
+
export interface RemoteSdkConfigurationResult {
|
|
4
|
+
initConfiguration: RumInitConfiguration;
|
|
5
|
+
/** `false` when the dashboard has switched RUM off entirely. */
|
|
6
|
+
rumEnabled: boolean;
|
|
7
|
+
}
|
|
8
|
+
/**
|
|
9
|
+
* Read the cached document and merge it into the init configuration. Synchronous and
|
|
10
|
+
* network-free: this runs on the initialization path.
|
|
11
|
+
*/
|
|
12
|
+
export declare function applyCachedSdkConfiguration(initConfiguration: RumInitConfiguration): RemoteSdkConfigurationResult;
|
|
13
|
+
export declare function applySdkConfiguration(initConfiguration: RumInitConfiguration, remoteConfig: RemoteSdkConfig): RemoteSdkConfigurationResult;
|
|
14
|
+
/**
|
|
15
|
+
* Refresh the cache for the next page load. Must be called *after* the SDK has started so it
|
|
16
|
+
* never delays initialization.
|
|
17
|
+
*/
|
|
18
|
+
export declare function scheduleSdkConfigurationRefresh(initConfiguration: RumInitConfiguration): Promise<void>;
|
|
@@ -0,0 +1,137 @@
|
|
|
1
|
+
import { DefaultPrivacyLevel, TraceContextInjection, getCachedSdkConfig, readBoolean, readEnum, readSampleRate, readString, refreshSdkConfig, } from '@kubesense/kubesense-browser-core';
|
|
2
|
+
/**
|
|
3
|
+
* Applies the dashboard-managed configuration document to the user's init configuration.
|
|
4
|
+
*
|
|
5
|
+
* Only scalar settings travel: anything that is a function or a matcher (`beforeSend`,
|
|
6
|
+
* `allowedTracingUrls`, `excludedActivityUrls`, plugins) stays in application code. Identity and
|
|
7
|
+
* endpoint settings (`clientToken`, `applicationId`, `kubesenseRumEndpoint`, `proxy`) are also
|
|
8
|
+
* excluded — they determine where the configuration request itself goes, and letting them be
|
|
9
|
+
* remotely rewritten would be a redirection risk.
|
|
10
|
+
*
|
|
11
|
+
* Every field is applied only when present and valid, so the user's own init configuration —
|
|
12
|
+
* and failing that, the SDK default — always wins over a missing or malformed remote value.
|
|
13
|
+
*/
|
|
14
|
+
const PRIVACY_LEVELS = [
|
|
15
|
+
DefaultPrivacyLevel.ALLOW,
|
|
16
|
+
DefaultPrivacyLevel.MASK,
|
|
17
|
+
DefaultPrivacyLevel.MASK_USER_INPUT,
|
|
18
|
+
];
|
|
19
|
+
const TRACE_CONTEXT_INJECTIONS = [TraceContextInjection.ALL, TraceContextInjection.SAMPLED];
|
|
20
|
+
/**
|
|
21
|
+
* Read the cached document and merge it into the init configuration. Synchronous and
|
|
22
|
+
* network-free: this runs on the initialization path.
|
|
23
|
+
*/
|
|
24
|
+
export function applyCachedSdkConfiguration(initConfiguration) {
|
|
25
|
+
const remoteConfig = getCachedSdkConfig();
|
|
26
|
+
if (!remoteConfig) {
|
|
27
|
+
return { initConfiguration, rumEnabled: true };
|
|
28
|
+
}
|
|
29
|
+
return applySdkConfiguration(initConfiguration, remoteConfig);
|
|
30
|
+
}
|
|
31
|
+
export function applySdkConfiguration(initConfiguration, remoteConfig) {
|
|
32
|
+
const features = remoteConfig.features;
|
|
33
|
+
if (readBoolean(features, 'rum') === false) {
|
|
34
|
+
return { initConfiguration, rumEnabled: false };
|
|
35
|
+
}
|
|
36
|
+
const applied = { ...initConfiguration };
|
|
37
|
+
applyRumSection(applied, remoteConfig.rum);
|
|
38
|
+
applySessionReplaySection(applied, remoteConfig.sessionReplay);
|
|
39
|
+
applyProfilingSection(applied, remoteConfig.profiling);
|
|
40
|
+
applyFeatureSwitches(applied, features);
|
|
41
|
+
return { initConfiguration: applied, rumEnabled: true };
|
|
42
|
+
}
|
|
43
|
+
function applyRumSection(applied, rum) {
|
|
44
|
+
if (!rum) {
|
|
45
|
+
return;
|
|
46
|
+
}
|
|
47
|
+
assign(applied, 'sessionSampleRate', readSampleRate(rum, 'sessionSampleRate'));
|
|
48
|
+
assign(applied, 'telemetrySampleRate', readSampleRate(rum, 'telemetrySampleRate'));
|
|
49
|
+
assign(applied, 'traceSampleRate', readSampleRate(rum, 'traceSampleRate'));
|
|
50
|
+
assign(applied, 'trackUserInteractions', readBoolean(rum, 'trackUserInteractions'));
|
|
51
|
+
assign(applied, 'trackResources', readBoolean(rum, 'trackResources'));
|
|
52
|
+
assign(applied, 'trackLongTasks', readBoolean(rum, 'trackLongTasks'));
|
|
53
|
+
assign(applied, 'trackViewsManually', readBoolean(rum, 'trackViewsManually'));
|
|
54
|
+
assign(applied, 'trackBfcacheViews', readBoolean(rum, 'trackBfcacheViews'));
|
|
55
|
+
assign(applied, 'trackAnonymousUser', readBoolean(rum, 'trackAnonymousUser'));
|
|
56
|
+
assign(applied, 'trackSessionAcrossSubdomains', readBoolean(rum, 'trackSessionAcrossSubdomains'));
|
|
57
|
+
assign(applied, 'enablePrivacyForActionName', readBoolean(rum, 'enablePrivacyForActionName'));
|
|
58
|
+
assign(applied, 'propagateTraceBaggage', readBoolean(rum, 'propagateTraceBaggage'));
|
|
59
|
+
assign(applied, 'defaultPrivacyLevel', readEnum(rum, 'defaultPrivacyLevel', PRIVACY_LEVELS));
|
|
60
|
+
assign(applied, 'traceContextInjection', readEnum(rum, 'traceContextInjection', TRACE_CONTEXT_INJECTIONS));
|
|
61
|
+
assign(applied, 'actionNameAttribute', readString(rum, 'actionNameAttribute'));
|
|
62
|
+
assign(applied, 'service', readString(rum, 'service'));
|
|
63
|
+
assign(applied, 'env', readString(rum, 'env'));
|
|
64
|
+
assign(applied, 'version', readString(rum, 'version'));
|
|
65
|
+
}
|
|
66
|
+
function applySessionReplaySection(applied, sessionReplay) {
|
|
67
|
+
if (!sessionReplay) {
|
|
68
|
+
return;
|
|
69
|
+
}
|
|
70
|
+
assign(applied, 'sessionReplaySampleRate', readSampleRate(sessionReplay, 'sampleRate'));
|
|
71
|
+
assign(applied, 'startSessionReplayRecordingManually', readBoolean(sessionReplay, 'startRecordingManually'));
|
|
72
|
+
assign(applied, 'defaultPrivacyLevel', readEnum(sessionReplay, 'defaultPrivacyLevel', PRIVACY_LEVELS));
|
|
73
|
+
assign(applied, 'sessionReplayRoutes', readRoutes(sessionReplay.routes));
|
|
74
|
+
}
|
|
75
|
+
/**
|
|
76
|
+
* Route rules arriving as JSON can only be plain strings (prefix matches). Regexes and functions
|
|
77
|
+
* are deliberately not accepted from the dashboard: they cannot be expressed safely in JSON and a
|
|
78
|
+
* pathological pattern would run on every view change.
|
|
79
|
+
*/
|
|
80
|
+
function readRoutes(routes) {
|
|
81
|
+
if (!routes || typeof routes !== 'object' || Array.isArray(routes)) {
|
|
82
|
+
return undefined;
|
|
83
|
+
}
|
|
84
|
+
const include = readStringList(routes.include);
|
|
85
|
+
const exclude = readStringList(routes.exclude);
|
|
86
|
+
if (!include && !exclude) {
|
|
87
|
+
return undefined;
|
|
88
|
+
}
|
|
89
|
+
return { include, exclude };
|
|
90
|
+
}
|
|
91
|
+
function readStringList(value) {
|
|
92
|
+
if (!Array.isArray(value)) {
|
|
93
|
+
return undefined;
|
|
94
|
+
}
|
|
95
|
+
const strings = value.filter((item) => typeof item === 'string' && item.length > 0);
|
|
96
|
+
return strings.length > 0 ? strings : undefined;
|
|
97
|
+
}
|
|
98
|
+
function applyProfilingSection(applied, profiling) {
|
|
99
|
+
if (!profiling) {
|
|
100
|
+
return;
|
|
101
|
+
}
|
|
102
|
+
assign(applied, 'profilingSampleRate', readSampleRate(profiling, 'sampleRate'));
|
|
103
|
+
}
|
|
104
|
+
/**
|
|
105
|
+
* Feature switches are applied last so they always win over the per-section sample rates above.
|
|
106
|
+
* Turning a feature off is expressed through the setting that stops all of its collection.
|
|
107
|
+
*/
|
|
108
|
+
function applyFeatureSwitches(applied, features) {
|
|
109
|
+
const source = features;
|
|
110
|
+
if (readBoolean(source, 'sessionReplay') === false) {
|
|
111
|
+
applied.sessionReplaySampleRate = 0;
|
|
112
|
+
applied.startSessionReplayRecordingManually = true;
|
|
113
|
+
// Drop any route rules too: with replay off they are dead weight, and leaving them behind
|
|
114
|
+
// would suggest recording still happens somewhere.
|
|
115
|
+
applied.sessionReplayRoutes = undefined;
|
|
116
|
+
}
|
|
117
|
+
if (readBoolean(source, 'profiling') === false) {
|
|
118
|
+
applied.profilingSampleRate = 0;
|
|
119
|
+
}
|
|
120
|
+
}
|
|
121
|
+
/**
|
|
122
|
+
* Assigning only defined values keeps the "absent means keep the local value" guarantee in one
|
|
123
|
+
* place instead of at every call site.
|
|
124
|
+
*/
|
|
125
|
+
function assign(target, key, value) {
|
|
126
|
+
if (value !== undefined) {
|
|
127
|
+
target[key] = value;
|
|
128
|
+
}
|
|
129
|
+
}
|
|
130
|
+
/**
|
|
131
|
+
* Refresh the cache for the next page load. Must be called *after* the SDK has started so it
|
|
132
|
+
* never delays initialization.
|
|
133
|
+
*/
|
|
134
|
+
export function scheduleSdkConfigurationRefresh(initConfiguration) {
|
|
135
|
+
return refreshSdkConfig(initConfiguration, initConfiguration.applicationId);
|
|
136
|
+
}
|
|
137
|
+
//# sourceMappingURL=remoteSdkConfiguration.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"remoteSdkConfiguration.js","sourceRoot":"","sources":["../../../src/domain/configuration/remoteSdkConfiguration.ts"],"names":[],"mappings":"AACA,OAAO,EACL,mBAAmB,EACnB,qBAAqB,EACrB,kBAAkB,EAClB,WAAW,EACX,QAAQ,EACR,cAAc,EACd,UAAU,EACV,gBAAgB,GACjB,MAAM,mCAAmC,CAAA;AAI1C;;;;;;;;;;;GAWG;AAEH,MAAM,cAAc,GAAG;IACrB,mBAAmB,CAAC,KAAK;IACzB,mBAAmB,CAAC,IAAI;IACxB,mBAAmB,CAAC,eAAe;CAC3B,CAAA;AAEV,MAAM,wBAAwB,GAAG,CAAC,qBAAqB,CAAC,GAAG,EAAE,qBAAqB,CAAC,OAAO,CAAU,CAAA;AAQpG;;;GAGG;AACH,MAAM,UAAU,2BAA2B,CAAC,iBAAuC;IACjF,MAAM,YAAY,GAAG,kBAAkB,EAAE,CAAA;IACzC,IAAI,CAAC,YAAY,EAAE,CAAC;QAClB,OAAO,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,CAAA;IAChD,CAAC;IACD,OAAO,qBAAqB,CAAC,iBAAiB,EAAE,YAAY,CAAC,CAAA;AAC/D,CAAC;AAED,MAAM,UAAU,qBAAqB,CACnC,iBAAuC,EACvC,YAA6B;IAE7B,MAAM,QAAQ,GAAG,YAAY,CAAC,QAAQ,CAAA;IACtC,IAAI,WAAW,CAAC,QAAkD,EAAE,KAAK,CAAC,KAAK,KAAK,EAAE,CAAC;QACrF,OAAO,EAAE,iBAAiB,EAAE,UAAU,EAAE,KAAK,EAAE,CAAA;IACjD,CAAC;IAED,MAAM,OAAO,GAAyB,EAAE,GAAG,iBAAiB,EAAE,CAAA;IAE9D,eAAe,CAAC,OAAO,EAAE,YAAY,CAAC,GAAG,CAAC,CAAA;IAC1C,yBAAyB,CAAC,OAAO,EAAE,YAAY,CAAC,aAAa,CAAC,CAAA;IAC9D,qBAAqB,CAAC,OAAO,EAAE,YAAY,CAAC,SAAS,CAAC,CAAA;IACtD,oBAAoB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAA;IAEvC,OAAO,EAAE,iBAAiB,EAAE,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,CAAA;AACzD,CAAC;AAED,SAAS,eAAe,CAAC,OAA6B,EAAE,GAA2C;IACjG,IAAI,CAAC,GAAG,EAAE,CAAC;QACT,OAAM;IACR,CAAC;IAED,MAAM,CAAC,OAAO,EAAE,mBAAmB,EAAE,cAAc,CAAC,GAAG,EAAE,mBAAmB,CAAC,CAAC,CAAA;IAC9E,MAAM,CAAC,OAAO,EAAE,qBAAqB,EAAE,cAAc,CAAC,GAAG,EAAE,qBAAqB,CAAC,CAAC,CAAA;IAClF,MAAM,CAAC,OAAO,EAAE,iBAAiB,EAAE,cAAc,CAAC,GAAG,EAAE,iBAAiB,CAAC,CAAC,CAAA;IAE1E,MAAM,CAAC,OAAO,EAAE,uBAAuB,EAAE,WAAW,CAAC,GAAG,EAAE,uBAAuB,CAAC,CAAC,CAAA;IACnF,MAAM,CAAC,OAAO,EAAE,gBAAgB,EAAE,WAAW,CAAC,GAAG,EAAE,gBAAgB,CAAC,CAAC,CAAA;IACrE,MAAM,CAAC,OAAO,EAAE,gBAAgB,EAAE,WAAW,CAAC,GAAG,EAAE,gBAAgB,CAAC,CAAC,CAAA;IACrE,MAAM,CAAC,OAAO,EAAE,oBAAoB,EAAE,WAAW,CAAC,GAAG,EAAE,oBAAoB,CAAC,CAAC,CAAA;IAC7E,MAAM,CAAC,OAAO,EAAE,mBAAmB,EAAE,WAAW,CAAC,GAAG,EAAE,mBAAmB,CAAC,CAAC,CAAA;IAC3E,MAAM,CAAC,OAAO,EAAE,oBAAoB,EAAE,WAAW,CAAC,GAAG,EAAE,oBAAoB,CAAC,CAAC,CAAA;IAC7E,MAAM,CAAC,OAAO,EAAE,8BAA8B,EAAE,WAAW,CAAC,GAAG,EAAE,8BAA8B,CAAC,CAAC,CAAA;IACjG,MAAM,CAAC,OAAO,EAAE,4BAA4B,EAAE,WAAW,CAAC,GAAG,EAAE,4BAA4B,CAAC,CAAC,CAAA;IAC7F,MAAM,CAAC,OAAO,EAAE,uBAAuB,EAAE,WAAW,CAAC,GAAG,EAAE,uBAAuB,CAAC,CAAC,CAAA;IAEnF,MAAM,CAAC,OAAO,EAAE,qBAAqB,EAAE,QAAQ,CAAC,GAAG,EAAE,qBAAqB,EAAE,cAAc,CAAC,CAAC,CAAA;IAC5F,MAAM,CAAC,OAAO,EAAE,uBAAuB,EAAE,QAAQ,CAAC,GAAG,EAAE,uBAAuB,EAAE,wBAAwB,CAAC,CAAC,CAAA;IAC1G,MAAM,CAAC,OAAO,EAAE,qBAAqB,EAAE,UAAU,CAAC,GAAG,EAAE,qBAAqB,CAAC,CAAC,CAAA;IAE9E,MAAM,CAAC,OAAO,EAAE,SAAS,EAAE,UAAU,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC,CAAA;IACtD,MAAM,CAAC,OAAO,EAAE,KAAK,EAAE,UAAU,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAA;IAC9C,MAAM,CAAC,OAAO,EAAE,SAAS,EAAE,UAAU,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC,CAAA;AACxD,CAAC;AAED,SAAS,yBAAyB,CAChC,OAA6B,EAC7B,aAAqD;IAErD,IAAI,CAAC,aAAa,EAAE,CAAC;QACnB,OAAM;IACR,CAAC;IAED,MAAM,CAAC,OAAO,EAAE,yBAAyB,EAAE,cAAc,CAAC,aAAa,EAAE,YAAY,CAAC,CAAC,CAAA;IACvF,MAAM,CAAC,OAAO,EAAE,qCAAqC,EAAE,WAAW,CAAC,aAAa,EAAE,wBAAwB,CAAC,CAAC,CAAA;IAC5G,MAAM,CAAC,OAAO,EAAE,qBAAqB,EAAE,QAAQ,CAAC,aAAa,EAAE,qBAAqB,EAAE,cAAc,CAAC,CAAC,CAAA;IACtG,MAAM,CAAC,OAAO,EAAE,qBAAqB,EAAE,UAAU,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAA;AAC1E,CAAC;AAED;;;;GAIG;AACH,SAAS,UAAU,CAAC,MAAe;IACjC,IAAI,CAAC,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QACnE,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,MAAM,OAAO,GAAG,cAAc,CAAE,MAAgC,CAAC,OAAO,CAAC,CAAA;IACzE,MAAM,OAAO,GAAG,cAAc,CAAE,MAAgC,CAAC,OAAO,CAAC,CAAA;IAEzE,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC;QACzB,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,CAAA;AAC7B,CAAC;AAED,SAAS,cAAc,CAAC,KAAc;IACpC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAC1B,OAAO,SAAS,CAAA;IAClB,CAAC;IACD,MAAM,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAkB,EAAE,CAAC,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;IACnG,OAAO,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAA;AACjD,CAAC;AAED,SAAS,qBAAqB,CAAC,OAA6B,EAAE,SAAiD;IAC7G,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,OAAM;IACR,CAAC;IACD,MAAM,CAAC,OAAO,EAAE,qBAAqB,EAAE,cAAc,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC,CAAA;AACjF,CAAC;AAED;;;GAGG;AACH,SAAS,oBAAoB,CAAC,OAA6B,EAAE,QAAqC;IAChG,MAAM,MAAM,GAAG,QAAkD,CAAA;IAEjE,IAAI,WAAW,CAAC,MAAM,EAAE,eAAe,CAAC,KAAK,KAAK,EAAE,CAAC;QACnD,OAAO,CAAC,uBAAuB,GAAG,CAAC,CAAA;QACnC,OAAO,CAAC,mCAAmC,GAAG,IAAI,CAAA;QAClD,0FAA0F;QAC1F,mDAAmD;QACnD,OAAO,CAAC,mBAAmB,GAAG,SAAS,CAAA;IACzC,CAAC;IAED,IAAI,WAAW,CAAC,MAAM,EAAE,WAAW,CAAC,KAAK,KAAK,EAAE,CAAC;QAC/C,OAAO,CAAC,mBAAmB,GAAG,CAAC,CAAA;IACjC,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,SAAS,MAAM,CACb,MAA4B,EAC5B,GAAM,EACN,KAA0C;IAE1C,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACxB,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;IACrB,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,+BAA+B,CAAC,iBAAuC;IACrF,OAAO,gBAAgB,CAAC,iBAAiB,EAAE,iBAAiB,CAAC,aAAa,CAAC,CAAA;AAC7E,CAAC"}
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import type { MatchOption } from '@kubesense/kubesense-browser-core';
|
|
2
|
+
/**
|
|
3
|
+
* Route-scoped Session Replay.
|
|
4
|
+
*
|
|
5
|
+
* Recording is normally decided once per session by `sessionReplaySampleRate`. These rules add a
|
|
6
|
+
* second, per-view gate so a session that *is* eligible only gets recorded while the user is on
|
|
7
|
+
* a matching route.
|
|
8
|
+
*
|
|
9
|
+
* Rules can only ever narrow recording, never widen it: a session that lost the replay sampling
|
|
10
|
+
* draw is never recorded, whatever the routes say.
|
|
11
|
+
*/
|
|
12
|
+
export interface SessionReplayRoutes {
|
|
13
|
+
/** Record only on these routes. When omitted, every route is eligible. */
|
|
14
|
+
include?: MatchOption[] | undefined;
|
|
15
|
+
/** Never record on these routes. Takes precedence over `include`. */
|
|
16
|
+
exclude?: MatchOption[] | undefined;
|
|
17
|
+
}
|
|
18
|
+
/**
|
|
19
|
+
* Rules are matched against the **path** — `pathname` + `search` + `hash` — not the full URL, so
|
|
20
|
+
* a dashboard entry reads the way a route is written (`/checkout`). String options match by
|
|
21
|
+
* prefix, so `/checkout` also covers `/checkout/payment`.
|
|
22
|
+
*/
|
|
23
|
+
export declare function getRoutePath(location?: Location | URL): string;
|
|
24
|
+
/**
|
|
25
|
+
* Returns whether recording is allowed on the given path.
|
|
26
|
+
*
|
|
27
|
+
* No rules at all means "record everywhere", which keeps the behaviour of an SDK that has never
|
|
28
|
+
* been configured with routes.
|
|
29
|
+
*/
|
|
30
|
+
export declare function isRouteRecordable(routes: SessionReplayRoutes | undefined, path: string): boolean;
|
|
31
|
+
/**
|
|
32
|
+
* Validates the user-provided option. An invalid entry is dropped rather than silently treated
|
|
33
|
+
* as "match nothing", which would turn a typo into a total loss of replay.
|
|
34
|
+
*/
|
|
35
|
+
export declare function validateSessionReplayRoutes(routes: unknown): SessionReplayRoutes | undefined;
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
import { display, isMatchOption, matchList } from '@kubesense/kubesense-browser-core';
|
|
2
|
+
/**
|
|
3
|
+
* Rules are matched against the **path** — `pathname` + `search` + `hash` — not the full URL, so
|
|
4
|
+
* a dashboard entry reads the way a route is written (`/checkout`). String options match by
|
|
5
|
+
* prefix, so `/checkout` also covers `/checkout/payment`.
|
|
6
|
+
*/
|
|
7
|
+
export function getRoutePath(location = window.location) {
|
|
8
|
+
return `${location.pathname}${location.search}${location.hash}`;
|
|
9
|
+
}
|
|
10
|
+
/**
|
|
11
|
+
* Returns whether recording is allowed on the given path.
|
|
12
|
+
*
|
|
13
|
+
* No rules at all means "record everywhere", which keeps the behaviour of an SDK that has never
|
|
14
|
+
* been configured with routes.
|
|
15
|
+
*/
|
|
16
|
+
export function isRouteRecordable(routes, path) {
|
|
17
|
+
if (!routes) {
|
|
18
|
+
return true;
|
|
19
|
+
}
|
|
20
|
+
// Exclusions win, so a route can always be carved out of a broad `include`.
|
|
21
|
+
if (routes.exclude && routes.exclude.length > 0 && matchList(routes.exclude, path, true)) {
|
|
22
|
+
return false;
|
|
23
|
+
}
|
|
24
|
+
if (routes.include && routes.include.length > 0) {
|
|
25
|
+
return matchList(routes.include, path, true);
|
|
26
|
+
}
|
|
27
|
+
return true;
|
|
28
|
+
}
|
|
29
|
+
/**
|
|
30
|
+
* Validates the user-provided option. An invalid entry is dropped rather than silently treated
|
|
31
|
+
* as "match nothing", which would turn a typo into a total loss of replay.
|
|
32
|
+
*/
|
|
33
|
+
export function validateSessionReplayRoutes(routes) {
|
|
34
|
+
if (routes === undefined || routes === null) {
|
|
35
|
+
return undefined;
|
|
36
|
+
}
|
|
37
|
+
if (typeof routes !== 'object' || Array.isArray(routes)) {
|
|
38
|
+
display.error('Session Replay routes should be an object with optional include and exclude arrays');
|
|
39
|
+
return undefined;
|
|
40
|
+
}
|
|
41
|
+
const include = validateMatchOptionList(routes.include, 'include');
|
|
42
|
+
const exclude = validateMatchOptionList(routes.exclude, 'exclude');
|
|
43
|
+
if (!include && !exclude) {
|
|
44
|
+
return undefined;
|
|
45
|
+
}
|
|
46
|
+
return { include, exclude };
|
|
47
|
+
}
|
|
48
|
+
function validateMatchOptionList(list, name) {
|
|
49
|
+
if (list === undefined) {
|
|
50
|
+
return undefined;
|
|
51
|
+
}
|
|
52
|
+
if (!Array.isArray(list)) {
|
|
53
|
+
display.error(`Session Replay routes "${name}" should be an array`);
|
|
54
|
+
return undefined;
|
|
55
|
+
}
|
|
56
|
+
const validOptions = list.filter((item) => {
|
|
57
|
+
if (isMatchOption(item)) {
|
|
58
|
+
return true;
|
|
59
|
+
}
|
|
60
|
+
display.error(`Session Replay routes "${name}" entries should be a string, RegExp or function`);
|
|
61
|
+
return false;
|
|
62
|
+
});
|
|
63
|
+
return validOptions.length > 0 ? validOptions : undefined;
|
|
64
|
+
}
|
|
65
|
+
//# sourceMappingURL=sessionReplayRoutes.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"sessionReplayRoutes.js","sourceRoot":"","sources":["../../../src/domain/configuration/sessionReplayRoutes.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,mCAAmC,CAAA;AAmBrF;;;;GAIG;AACH,MAAM,UAAU,YAAY,CAAC,WAA2B,MAAM,CAAC,QAAQ;IACrE,OAAO,GAAG,QAAQ,CAAC,QAAQ,GAAG,QAAQ,CAAC,MAAM,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAA;AACjE,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,iBAAiB,CAAC,MAAuC,EAAE,IAAY;IACrF,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,IAAI,CAAA;IACb,CAAC;IAED,4EAA4E;IAC5E,IAAI,MAAM,CAAC,OAAO,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,SAAS,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC;QACzF,OAAO,KAAK,CAAA;IACd,CAAC;IAED,IAAI,MAAM,CAAC,OAAO,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAChD,OAAO,SAAS,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,CAAA;IAC9C,CAAC;IAED,OAAO,IAAI,CAAA;AACb,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,2BAA2B,CAAC,MAAe;IACzD,IAAI,MAAM,KAAK,SAAS,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;QAC5C,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QACxD,OAAO,CAAC,KAAK,CAAC,oFAAoF,CAAC,CAAA;QACnG,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,MAAM,OAAO,GAAG,uBAAuB,CAAE,MAA8B,CAAC,OAAO,EAAE,SAAS,CAAC,CAAA;IAC3F,MAAM,OAAO,GAAG,uBAAuB,CAAE,MAA8B,CAAC,OAAO,EAAE,SAAS,CAAC,CAAA;IAE3F,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC;QACzB,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,CAAA;AAC7B,CAAC;AAED,SAAS,uBAAuB,CAAC,IAAa,EAAE,IAAY;IAC1D,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACvB,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QACzB,OAAO,CAAC,KAAK,CAAC,0BAA0B,IAAI,sBAAsB,CAAC,CAAA;QACnE,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,MAAM,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE;QACxC,IAAI,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC;YACxB,OAAO,IAAI,CAAA;QACb,CAAC;QACD,OAAO,CAAC,KAAK,CAAC,0BAA0B,IAAI,kDAAkD,CAAC,CAAA;QAC/F,OAAO,KAAK,CAAA;IACd,CAAC,CAAkB,CAAA;IAEnB,OAAO,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAA;AAC3D,CAAC"}
|
|
@@ -14,7 +14,7 @@ export function startDefaultContext(hooks, configuration, sdkName) {
|
|
|
14
14
|
trace_sample_rate: round(configuration.traceSampleRate, 3),
|
|
15
15
|
beta_encode_cookie_options: configuration.betaEncodeCookieOptions,
|
|
16
16
|
},
|
|
17
|
-
browser_sdk_version: canUseEventBridge() ? "1.
|
|
17
|
+
browser_sdk_version: canUseEventBridge() ? "1.5.0" : undefined,
|
|
18
18
|
sdk_name: sdkName,
|
|
19
19
|
},
|
|
20
20
|
application: {
|
package/esm/index.d.ts
CHANGED
|
@@ -18,7 +18,8 @@ export type { RumMutationRecord, RumAttributesMutationRecord, RumChildListMutati
|
|
|
18
18
|
export type { ViewportDimension } from './browser/viewportObservable';
|
|
19
19
|
export { initViewportObservable, getViewportDimension } from './browser/viewportObservable';
|
|
20
20
|
export { getScrollX, getScrollY } from './browser/scroll';
|
|
21
|
-
export type { RumInitConfiguration, RumConfiguration, FeatureFlagsForEvents, RemoteConfiguration, } from './domain/configuration';
|
|
21
|
+
export type { RumInitConfiguration, RumConfiguration, FeatureFlagsForEvents, RemoteConfiguration, SessionReplayRoutes, } from './domain/configuration';
|
|
22
|
+
export { isRouteRecordable, getRoutePath } from './domain/configuration';
|
|
22
23
|
export { DEFAULT_PROGRAMMATIC_ACTION_NAME_ATTRIBUTE } from './domain/action/actionNameConstants';
|
|
23
24
|
export { STABLE_ATTRIBUTES } from './domain/getSelectorFromElement';
|
|
24
25
|
export * from './browser/htmlDomUtils';
|
package/esm/index.js
CHANGED
|
@@ -6,6 +6,7 @@ export { startViewHistory } from './domain/contexts/viewHistory';
|
|
|
6
6
|
export { getMutationObserverConstructor } from './browser/domMutationObservable';
|
|
7
7
|
export { initViewportObservable, getViewportDimension } from './browser/viewportObservable';
|
|
8
8
|
export { getScrollX, getScrollY } from './browser/scroll';
|
|
9
|
+
export { isRouteRecordable, getRoutePath } from './domain/configuration';
|
|
9
10
|
export { DEFAULT_PROGRAMMATIC_ACTION_NAME_ATTRIBUTE } from './domain/action/actionNameConstants';
|
|
10
11
|
export { STABLE_ATTRIBUTES } from './domain/getSelectorFromElement';
|
|
11
12
|
export * from './browser/htmlDomUtils';
|
package/esm/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAA;AAyBtD,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAA;AAC/E,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAA;AAE1C,OAAO,EAAE,SAAS,EAAsB,MAAM,oBAAoB,CAAA;AAIlE,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAA;AAEhE,OAAO,EAAE,8BAA8B,EAAE,MAAM,iCAAiC,CAAA;AAQhF,OAAO,EAAE,sBAAsB,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAA;AAC3F,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAA;AAyBtD,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAA;AAC/E,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAA;AAE1C,OAAO,EAAE,SAAS,EAAsB,MAAM,oBAAoB,CAAA;AAIlE,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAA;AAEhE,OAAO,EAAE,8BAA8B,EAAE,MAAM,iCAAiC,CAAA;AAQhF,OAAO,EAAE,sBAAsB,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAA;AAC3F,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAQzD,OAAO,EAAE,iBAAiB,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAA;AACxE,OAAO,EAAE,0CAA0C,EAAE,MAAM,qCAAqC,CAAA;AAChG,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAA;AACnE,cAAc,wBAAwB,CAAA;AACtC,OAAO,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAA;AAClE,OAAO,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAA;AACvE,cAAc,kBAAkB,CAAA;AAChC,cAAc,2BAA2B,CAAA;AAIzC,OAAO,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAA;AAC/E,OAAO,EAAE,uBAAuB,EAAE,MAAM,iCAAiC,CAAA;AASzE,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AAC5C,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAA;AAGpD,OAAO,EAAE,uBAAuB,EAAE,MAAM,+BAA+B,CAAA"}
|
package/esm/rumEvent.types.d.ts
CHANGED
|
@@ -1423,6 +1423,10 @@ export interface CommonProperties {
|
|
|
1423
1423
|
* Email of the user
|
|
1424
1424
|
*/
|
|
1425
1425
|
readonly email?: string;
|
|
1426
|
+
/**
|
|
1427
|
+
* Mobile phone number of the user
|
|
1428
|
+
*/
|
|
1429
|
+
readonly mobile?: string;
|
|
1426
1430
|
/**
|
|
1427
1431
|
* Identifier of the user across sessions
|
|
1428
1432
|
*/
|
package/package.json
CHANGED
|
@@ -1,7 +1,17 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@kubesense/kubesense-browser-rum-core",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.5.0",
|
|
4
|
+
"description": "Shared RUM event-collection logic for the Kubesense Browser SDK (consumed by the rum and rum-slim packages).",
|
|
4
5
|
"license": "Apache-2.0",
|
|
6
|
+
"keywords": [
|
|
7
|
+
"kubesense",
|
|
8
|
+
"browser",
|
|
9
|
+
"rum",
|
|
10
|
+
"real-user-monitoring",
|
|
11
|
+
"monitoring",
|
|
12
|
+
"observability",
|
|
13
|
+
"core"
|
|
14
|
+
],
|
|
5
15
|
"main": "cjs/index.js",
|
|
6
16
|
"module": "esm/index.js",
|
|
7
17
|
"types": "cjs/index.d.ts",
|
|
@@ -9,7 +19,7 @@
|
|
|
9
19
|
"build": "node ../../scripts/build/build-package.ts --modules"
|
|
10
20
|
},
|
|
11
21
|
"dependencies": {
|
|
12
|
-
"@kubesense/kubesense-browser-core": "1.
|
|
22
|
+
"@kubesense/kubesense-browser-core": "1.5.0"
|
|
13
23
|
},
|
|
14
24
|
"devDependencies": {
|
|
15
25
|
"ajv": "8.17.1"
|
|
@@ -25,5 +35,5 @@
|
|
|
25
35
|
"publishConfig": {
|
|
26
36
|
"access": "public"
|
|
27
37
|
},
|
|
28
|
-
"gitHead": "
|
|
38
|
+
"gitHead": "01223bc403c9f02d866e98a88e891388014ea471"
|
|
29
39
|
}
|
package/src/boot/preStartRum.ts
CHANGED
|
@@ -24,6 +24,8 @@ import {
|
|
|
24
24
|
validateAndBuildRumConfiguration,
|
|
25
25
|
fetchAndApplyRemoteConfiguration,
|
|
26
26
|
serializeRumConfiguration,
|
|
27
|
+
applyCachedSdkConfiguration,
|
|
28
|
+
scheduleSdkConfigurationRefresh,
|
|
27
29
|
} from '../domain/configuration'
|
|
28
30
|
import type { ViewOptions } from '../domain/view/trackViews'
|
|
29
31
|
import type {
|
|
@@ -105,6 +107,22 @@ export function createPreStartStrategy(
|
|
|
105
107
|
initConfiguration = overrideInitConfigurationForBridge(initConfiguration)
|
|
106
108
|
}
|
|
107
109
|
|
|
110
|
+
const remoteSdkConfigurationEnabled = !!initConfiguration.enableRemoteSdkConfiguration
|
|
111
|
+
if (remoteSdkConfigurationEnabled) {
|
|
112
|
+
// Reading the cached document is synchronous and network-free, so it does not delay
|
|
113
|
+
// initialization. The document fetched below only applies from the next page load.
|
|
114
|
+
const cachedSdkConfiguration = applyCachedSdkConfiguration(initConfiguration)
|
|
115
|
+
initConfiguration = cachedSdkConfiguration.initConfiguration
|
|
116
|
+
|
|
117
|
+
if (!cachedSdkConfiguration.rumEnabled) {
|
|
118
|
+
// RUM is switched off from the dashboard. Still refresh the document, otherwise the
|
|
119
|
+
// switch would be one-way: the SDK could never learn that it has been turned back on.
|
|
120
|
+
cachedInitConfiguration = initConfiguration
|
|
121
|
+
scheduleSdkConfigurationRefresh(initConfiguration).catch(monitorError)
|
|
122
|
+
return
|
|
123
|
+
}
|
|
124
|
+
}
|
|
125
|
+
|
|
108
126
|
// Update the exposed initConfiguration to reflect the bridge and remote configuration overrides
|
|
109
127
|
cachedInitConfiguration = initConfiguration
|
|
110
128
|
addTelemetryConfiguration(serializeRumConfiguration(initConfiguration))
|
|
@@ -148,6 +166,11 @@ export function createPreStartStrategy(
|
|
|
148
166
|
|
|
149
167
|
trackingConsentState.tryToInit(configuration.trackingConsent)
|
|
150
168
|
tryStartRum()
|
|
169
|
+
|
|
170
|
+
if (remoteSdkConfigurationEnabled) {
|
|
171
|
+
// Fire-and-forget, after the SDK is running: refreshes the cache for the next page load.
|
|
172
|
+
scheduleSdkConfigurationRefresh(initConfiguration).catch(monitorError)
|
|
173
|
+
}
|
|
151
174
|
}
|
|
152
175
|
|
|
153
176
|
const addDurationVital = (vital: DurationVital) => {
|
|
@@ -17,6 +17,8 @@ import type { RumEvent } from '../../rumEvent.types'
|
|
|
17
17
|
import type { RumPlugin } from '../plugins'
|
|
18
18
|
import { isTracingOption } from '../tracing/tracer'
|
|
19
19
|
import type { PropagatorType, TracingOption } from '../tracing/tracer.types'
|
|
20
|
+
import type { SessionReplayRoutes } from './sessionReplayRoutes'
|
|
21
|
+
import { validateSessionReplayRoutes } from './sessionReplayRoutes'
|
|
20
22
|
|
|
21
23
|
export const DEFAULT_PROPAGATOR_TYPES: PropagatorType[] = ['tracecontext', 'kubesense']
|
|
22
24
|
|
|
@@ -112,6 +114,18 @@ export interface RumInitConfiguration extends InitConfiguration {
|
|
|
112
114
|
*/
|
|
113
115
|
remoteConfigurationProxy?: string | undefined
|
|
114
116
|
|
|
117
|
+
/**
|
|
118
|
+
* Enable dashboard-managed SDK settings served by the Kubesense collector.
|
|
119
|
+
*
|
|
120
|
+
* The configuration document is fetched asynchronously after the SDK starts and cached in
|
|
121
|
+
* local storage, so it never delays initialization. Cached settings are applied on the next
|
|
122
|
+
* page load. Local `init()` values are used until a document has been fetched, and any
|
|
123
|
+
* setting absent from the document keeps its local value.
|
|
124
|
+
*
|
|
125
|
+
* @defaultValue false
|
|
126
|
+
*/
|
|
127
|
+
enableRemoteSdkConfiguration?: boolean | undefined
|
|
128
|
+
|
|
115
129
|
// tracing options
|
|
116
130
|
/**
|
|
117
131
|
* A list of request URLs used to inject tracing headers.
|
|
@@ -175,6 +189,25 @@ export interface RumInitConfiguration extends InitConfiguration {
|
|
|
175
189
|
*/
|
|
176
190
|
startSessionReplayRecordingManually?: boolean | undefined
|
|
177
191
|
|
|
192
|
+
/**
|
|
193
|
+
* Restrict Session Replay recording to specific routes.
|
|
194
|
+
*
|
|
195
|
+
* Recording starts and stops as the user navigates: it runs only while the current route
|
|
196
|
+
* matches `include` (when provided) and does not match `exclude`. Rules are matched against
|
|
197
|
+
* the path (`pathname` + `search` + `hash`), and string entries match by prefix, so
|
|
198
|
+
* `/checkout` also covers `/checkout/payment`.
|
|
199
|
+
*
|
|
200
|
+
* These rules only narrow recording — a session that was not sampled in by
|
|
201
|
+
* `sessionReplaySampleRate` is never recorded, whatever the routes say.
|
|
202
|
+
*
|
|
203
|
+
* @category Session Replay
|
|
204
|
+
* @example
|
|
205
|
+
* ```ts
|
|
206
|
+
* sessionReplayRoutes: { include: ['/checkout', '/signup'], exclude: ['/checkout/card'] }
|
|
207
|
+
* ```
|
|
208
|
+
*/
|
|
209
|
+
sessionReplayRoutes?: SessionReplayRoutes | undefined
|
|
210
|
+
|
|
178
211
|
/**
|
|
179
212
|
* Enables privacy control for action names.
|
|
180
213
|
*
|
|
@@ -305,6 +338,7 @@ export interface RumConfiguration extends Configuration {
|
|
|
305
338
|
enablePrivacyForActionName: boolean
|
|
306
339
|
sessionReplaySampleRate: number
|
|
307
340
|
startSessionReplayRecordingManually: boolean
|
|
341
|
+
sessionReplayRoutes: SessionReplayRoutes | undefined
|
|
308
342
|
trackUserInteractions: boolean
|
|
309
343
|
trackViewsManually: boolean
|
|
310
344
|
trackResources: boolean
|
|
@@ -372,6 +406,7 @@ export function validateAndBuildRumConfiguration(
|
|
|
372
406
|
initConfiguration.startSessionReplayRecordingManually !== undefined
|
|
373
407
|
? !!initConfiguration.startSessionReplayRecordingManually
|
|
374
408
|
: sessionReplaySampleRate === 0,
|
|
409
|
+
sessionReplayRoutes: validateSessionReplayRoutes(initConfiguration.sessionReplayRoutes),
|
|
375
410
|
traceSampleRate: initConfiguration.traceSampleRate ?? 100,
|
|
376
411
|
rulePsr: isNumber(initConfiguration.traceSampleRate) ? initConfiguration.traceSampleRate / 100 : undefined,
|
|
377
412
|
allowedTracingUrls,
|