@crimson-education/browser-logger 4.0.1 → 4.0.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.
@@ -15,11 +15,30 @@ export interface DatadogReporterConfig extends ReporterConfigBase {
15
15
  proxyUrl?: string;
16
16
  /**
17
17
  * Controls the percentage of overall sessions being tracked. It defaults to 100, so every session is tracked by default.
18
+ *
19
+ * More specific sample rate options take priority over this option. For instance, if `logSampleRate` is 50 and `sampleRate`
20
+ * is 75, then the sample rate used for log messages will be `50`.
21
+ *
22
+ * @deprecated Prefer using the dedicated `logSampleRate`, `rumSampleRate`, and `replaySampleRate` options.
18
23
  */
19
24
  sampleRate?: number;
20
25
  /**
21
- * Applied after the overall sample rate, and controls the percentage of sessions tracked as Browser RUM & Session Replay.
26
+ * Sampling rate for browser log collection. Defaults to 100, meaning every log message is sent to Datadog.
27
+ */
28
+ logSampleRate?: number;
29
+ /**
30
+ * Sampling rate for RUM session collection. Defaults to 100, meaning every browser session is tracked.
31
+ *
32
+ * RUM can be used to track things like core web vitals.
33
+ *
34
+ * @see https://www.datadoghq.com/product/real-user-monitoring/
35
+ */
36
+ rumSampleRate?: number;
37
+ /**
38
+ * Applied after the RUM sample rate, and controls the percentage of sessions tracked as Browser RUM & Session Replay.
22
39
  * It defaults to 100, so every session is tracked as Browser RUM & Session Replay by default.
40
+ *
41
+ * These sessions end up with a session replay available in Datadog.
23
42
  */
24
43
  replaySampleRate?: number;
25
44
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"datadogReporter.d.ts","sourceRoot":"","sources":["../../src/reporters/datadogReporter.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EAMT,WAAW,EACX,kBAAkB,EACnB,MAAM,UAAU,CAAC;AAClB,OAAO,EAA4B,qBAAqB,EAAE,MAAM,uBAAuB,CAAC;AACxF,OAAO,EAAc,mBAAmB,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AAE7F,OAAO,EAAE,yBAAyB,EAAoB,MAAM,4BAA4B,CAAC;AAEzF,MAAM,WAAW,qBAAsB,SAAQ,kBAAkB;IAC/D,8BAA8B;IAC9B,aAAa,EAAE,MAAM,CAAC;IACtB,yDAAyD;IACzD,WAAW,EAAE,MAAM,CAAC;IACpB,uDAAuD;IACvD,IAAI,EAAE,MAAM,CAAC;IACb,uEAAuE;IACvE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,yBAAyB;IACzB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC;;;OAGG;IACH,yBAAyB,CAAC,EAAE,OAAO,CAAC;IACpC;;OAEG;IACH,4BAA4B,CAAC,EAAE,OAAO,CAAC;IAEvC;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;OAGG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B;;OAEG;IACH,UAAU,CAAC,EAAE,oBAAoB,CAAC,YAAY,CAAC,CAAC;IAEhD;;;OAGG;IACH,YAAY,CAAC,EAAE,OAAO,GAAG,yBAAyB,CAAC;IACnD;;OAEG;IACH,cAAc,CAAC,EAAE,qBAAqB,CAAC,YAAY,CAAC,CAAC;IAErD;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,mBAAmB,CAAC;IAC1C;;OAEG;IACH,qBAAqB,CAAC,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;IAC5C;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;CACjC;AAED,wBAAgB,eAAe,CAAC,IAAI,EAAE,WAAW,EAAE,MAAM,EAAE,qBAAqB,GAAG,SAAS,CA6H3F"}
1
+ {"version":3,"file":"datadogReporter.d.ts","sourceRoot":"","sources":["../../src/reporters/datadogReporter.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EAMT,WAAW,EACX,kBAAkB,EACnB,MAAM,UAAU,CAAC;AAClB,OAAO,EAA4B,qBAAqB,EAAE,MAAM,uBAAuB,CAAC;AACxF,OAAO,EAAc,mBAAmB,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AAE7F,OAAO,EAAE,yBAAyB,EAAoB,MAAM,4BAA4B,CAAC;AAEzF,MAAM,WAAW,qBAAsB,SAAQ,kBAAkB;IAC/D,8BAA8B;IAC9B,aAAa,EAAE,MAAM,CAAC;IACtB,yDAAyD;IACzD,WAAW,EAAE,MAAM,CAAC;IACpB,uDAAuD;IACvD,IAAI,EAAE,MAAM,CAAC;IACb,uEAAuE;IACvE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,yBAAyB;IACzB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;;;;OAOG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;;;;OAMG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC;;;OAGG;IACH,yBAAyB,CAAC,EAAE,OAAO,CAAC;IACpC;;OAEG;IACH,4BAA4B,CAAC,EAAE,OAAO,CAAC;IAEvC;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;OAGG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B;;OAEG;IACH,UAAU,CAAC,EAAE,oBAAoB,CAAC,YAAY,CAAC,CAAC;IAEhD;;;OAGG;IACH,YAAY,CAAC,EAAE,OAAO,GAAG,yBAAyB,CAAC;IACnD;;OAEG;IACH,cAAc,CAAC,EAAE,qBAAqB,CAAC,YAAY,CAAC,CAAC;IAErD;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,mBAAmB,CAAC;IAC1C;;OAEG;IACH,qBAAqB,CAAC,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;IAC5C;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;CACjC;AAED,wBAAgB,eAAe,CAAC,IAAI,EAAE,WAAW,EAAE,MAAM,EAAE,qBAAqB,GAAG,SAAS,CA6H3F"}
@@ -6,7 +6,7 @@ const browser_rum_1 = require("@datadog/browser-rum");
6
6
  const logger_1 = require("../logger");
7
7
  const datadogTransport_1 = require("../logger/datadogTransport");
8
8
  function datadogReporter(info, config) {
9
- var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r;
9
+ var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t;
10
10
  const isLocalhost = window.location.hostname === 'localhost';
11
11
  // Don't forward error logs by default, do enable the log transport by default
12
12
  // forwardErrorsToLogs incorrectly is called forwardConsoleLogs, this is for backwards compatibility
@@ -21,10 +21,10 @@ function datadogReporter(info, config) {
21
21
  service: info.service,
22
22
  env: info.environment,
23
23
  version: (_b = config.version) !== null && _b !== void 0 ? _b : info.version,
24
- sampleRate: (_c = config.sampleRate) !== null && _c !== void 0 ? _c : 100,
24
+ sampleRate: (_d = (_c = config.logSampleRate) !== null && _c !== void 0 ? _c : config.sampleRate) !== null && _d !== void 0 ? _d : 100,
25
25
  beforeSend: config.beforeLogsSend,
26
- useSecureSessionCookie: (_d = config.useSecureSessionCookie) !== null && _d !== void 0 ? _d : !isLocalhost,
27
- useCrossSiteSessionCookie: (_e = config.useCrossSiteSessionCookie) !== null && _e !== void 0 ? _e : false,
26
+ useSecureSessionCookie: (_e = config.useSecureSessionCookie) !== null && _e !== void 0 ? _e : !isLocalhost,
27
+ useCrossSiteSessionCookie: (_f = config.useCrossSiteSessionCookie) !== null && _f !== void 0 ? _f : false,
28
28
  trackSessionAcrossSubdomains: config.trackSessionAcrossSubdomains,
29
29
  forwardErrorsToLogs,
30
30
  });
@@ -41,20 +41,20 @@ function datadogReporter(info, config) {
41
41
  applicationId: config.applicationId,
42
42
  service: info.service,
43
43
  env: info.environment,
44
- version: (_f = config.version) !== null && _f !== void 0 ? _f : info.version,
45
- sampleRate: (_g = config.sampleRate) !== null && _g !== void 0 ? _g : 100,
46
- replaySampleRate: (_h = config.replaySampleRate) !== null && _h !== void 0 ? _h : 100,
47
- useSecureSessionCookie: (_j = config.useSecureSessionCookie) !== null && _j !== void 0 ? _j : !isLocalhost,
48
- useCrossSiteSessionCookie: (_k = config.useCrossSiteSessionCookie) !== null && _k !== void 0 ? _k : false,
44
+ version: (_g = config.version) !== null && _g !== void 0 ? _g : info.version,
45
+ sampleRate: (_j = (_h = config.rumSampleRate) !== null && _h !== void 0 ? _h : config.sampleRate) !== null && _j !== void 0 ? _j : 100,
46
+ replaySampleRate: (_k = config.replaySampleRate) !== null && _k !== void 0 ? _k : 100,
47
+ useSecureSessionCookie: (_l = config.useSecureSessionCookie) !== null && _l !== void 0 ? _l : !isLocalhost,
48
+ useCrossSiteSessionCookie: (_m = config.useCrossSiteSessionCookie) !== null && _m !== void 0 ? _m : false,
49
49
  trackSessionAcrossSubdomains: config.trackSessionAcrossSubdomains,
50
- trackInteractions: (_l = config.trackInteractions) !== null && _l !== void 0 ? _l : false,
51
- trackFrustrations: (_m = config.trackFrustrations) !== null && _m !== void 0 ? _m : false,
52
- trackViewsManually: (_o = config.trackViewsManually) !== null && _o !== void 0 ? _o : false,
53
- actionNameAttribute: (_p = config.actionNameAttribute) !== null && _p !== void 0 ? _p : 'data-analytics-name',
50
+ trackInteractions: (_o = config.trackInteractions) !== null && _o !== void 0 ? _o : false,
51
+ trackFrustrations: (_p = config.trackFrustrations) !== null && _p !== void 0 ? _p : false,
52
+ trackViewsManually: (_q = config.trackViewsManually) !== null && _q !== void 0 ? _q : false,
53
+ actionNameAttribute: (_r = config.actionNameAttribute) !== null && _r !== void 0 ? _r : 'data-analytics-name',
54
54
  beforeSend: config.beforeSend,
55
- defaultPrivacyLevel: (_q = config.defaultPrivacyLevel) !== null && _q !== void 0 ? _q : 'mask-user-input',
55
+ defaultPrivacyLevel: (_s = config.defaultPrivacyLevel) !== null && _s !== void 0 ? _s : 'mask-user-input',
56
56
  allowedTracingOrigins: config.allowedTracingOrigins,
57
- trackUserInteractions: (_r = config.trackUserInteractions) !== null && _r !== void 0 ? _r : false,
57
+ trackUserInteractions: (_t = config.trackUserInteractions) !== null && _t !== void 0 ? _t : false,
58
58
  });
59
59
  const reporter = {
60
60
  trackEvent: function (event) {
@@ -1 +1 @@
1
- {"version":3,"file":"datadogReporter.js","sourceRoot":"","sources":["../../src/reporters/datadogReporter.ts"],"names":[],"mappings":";;;AAUA,wDAAwF;AACxF,sDAA6F;AAC7F,sCAA0C;AAC1C,iEAAyF;AA4FzF,SAAgB,eAAe,CAAC,IAAiB,EAAE,MAA6B;;IAC9E,MAAM,WAAW,GAAG,MAAM,CAAC,QAAQ,CAAC,QAAQ,KAAK,WAAW,CAAC;IAE7D,8EAA8E;IAC9E,oGAAoG;IACpG,MAAM,mBAAmB,GAAG,MAAA,MAAM,CAAC,kBAAkB,mCAAI,KAAK,CAAC;IAC/D,MAAM,kBAAkB,GAAG,MAAM,CAAC,YAAY,KAAK,KAAK,CAAC;IAEzD,mDAAmD;IACnD,IAAI,mBAAmB,KAAK,IAAI,IAAI,kBAAkB,KAAK,IAAI,EAAE;QAC/D,0BAAW,CAAC,IAAI,CAAC;YACf,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,WAAW,EAAE,MAAM,CAAC,WAAW;YAC/B,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,GAAG,EAAE,IAAI,CAAC,WAAW;YACrB,OAAO,EAAE,MAAA,MAAM,CAAC,OAAO,mCAAI,IAAI,CAAC,OAAO;YAEvC,UAAU,EAAE,MAAA,MAAM,CAAC,UAAU,mCAAI,GAAG;YACpC,UAAU,EAAE,MAAM,CAAC,cAAc;YAEjC,sBAAsB,EAAE,MAAA,MAAM,CAAC,sBAAsB,mCAAI,CAAC,WAAW;YACrE,yBAAyB,EAAE,MAAA,MAAM,CAAC,yBAAyB,mCAAI,KAAK;YACpE,4BAA4B,EAAE,MAAM,CAAC,4BAA4B;YAEjE,mBAAmB;SACpB,CAAC,CAAC;QACH,0BAAW,CAAC,MAAM,CAAC,UAAU,CAAC,0BAAW,CAAC,IAAI,CAAC,CAAC;KACjD;IAED,gCAAgC;IAChC,IAAI,kBAAkB,EAAE;QACtB,sBAAa,CAAC,IAAI,CAAC,IAAA,mCAAgB,EAAC,OAAO,MAAM,CAAC,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC;KAC3G;IAED,wBAAU,CAAC,IAAI,CAAC;QACd,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,WAAW,EAAE,MAAM,CAAC,WAAW;QAC/B,aAAa,EAAE,MAAM,CAAC,aAAa;QACnC,OAAO,EAAE,IAAI,CAAC,OAAO;QACrB,GAAG,EAAE,IAAI,CAAC,WAAW;QACrB,OAAO,EAAE,MAAA,MAAM,CAAC,OAAO,mCAAI,IAAI,CAAC,OAAO;QAEvC,UAAU,EAAE,MAAA,MAAM,CAAC,UAAU,mCAAI,GAAG;QACpC,gBAAgB,EAAE,MAAA,MAAM,CAAC,gBAAgB,mCAAI,GAAG;QAEhD,sBAAsB,EAAE,MAAA,MAAM,CAAC,sBAAsB,mCAAI,CAAC,WAAW;QACrE,yBAAyB,EAAE,MAAA,MAAM,CAAC,yBAAyB,mCAAI,KAAK;QACpE,4BAA4B,EAAE,MAAM,CAAC,4BAA4B;QAEjE,iBAAiB,EAAE,MAAA,MAAM,CAAC,iBAAiB,mCAAI,KAAK;QACpD,iBAAiB,EAAE,MAAA,MAAM,CAAC,iBAAiB,mCAAI,KAAK;QACpD,kBAAkB,EAAE,MAAA,MAAM,CAAC,kBAAkB,mCAAI,KAAK;QACtD,mBAAmB,EAAE,MAAA,MAAM,CAAC,mBAAmB,mCAAI,qBAAqB;QACxE,UAAU,EAAE,MAAM,CAAC,UAAU;QAE7B,mBAAmB,EAAE,MAAA,MAAM,CAAC,mBAAmB,mCAAI,iBAAiB;QACpE,qBAAqB,EAAE,MAAM,CAAC,qBAAqB;QACnD,qBAAqB,EAAE,MAAA,MAAM,CAAC,qBAAqB,mCAAI,KAAK;KAC7D,CAAC,CAAC;IAEH,MAAM,QAAQ,GAAc;QAC1B,UAAU,EAAE,UAAU,KAAoB;YACxC,wBAAU,CAAC,SAAS,CAAC,KAAK,CAAC,OAAO,EAAE;gBAClC,KAAK,EAAE,KAAK,CAAC,KAAK;gBAClB,GAAG,KAAK,CAAC,QAAQ;gBACjB,GAAG,KAAK,CAAC,IAAI;gBACb,GAAG,KAAK,CAAC,OAAO;aACjB,CAAC,CAAC;QACL,CAAC;QACD,aAAa,EAAE,UAAU,UAA8B;YACrD,wBAAU,CAAC,SAAS,CAAC,UAAU,CAAC,OAAO,EAAE;gBACvC,GAAG,UAAU,CAAC,QAAQ;gBACtB,QAAQ,EAAE,UAAU,CAAC,QAAQ;aAC9B,CAAC,CAAC;QACL,CAAC;QACD,WAAW,EAAE,UAAU,QAAkB;YACvC,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;gBACnD,IAAI,KAAK,KAAK,IAAI,EAAE;oBAClB,wBAAU,CAAC,mBAAmB,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;oBAE3C,sDAAsD;oBACtD,wEAAwE;oBACxE,0BAAW,CAAC,sBAAsB,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;iBAChD;qBAAM;oBACL,wBAAU,CAAC,sBAAsB,CAAC,GAAG,CAAC,CAAC;oBAEvC,wEAAwE;oBACxE,0BAAW,CAAC,yBAAyB,CAAC,GAAG,CAAC,CAAC;iBAC5C;aACF;QACH,CAAC;QACD,OAAO,EAAE,UAAU,IAAuB;;YACxC,IAAI,IAAI,EAAE;gBACR,wBAAU,CAAC,OAAO,CAAC;oBACjB,EAAE,EAAE,IAAI,CAAC,EAAE;oBACX,KAAK,EAAE,IAAI,CAAC,KAAK;oBACjB,IAAI,EAAE,MAAA,IAAI,CAAC,IAAI,mCAAI,IAAI,CAAC,KAAK;iBAC9B,CAAC,CAAC;aACJ;iBAAM;gBACL,wBAAU,CAAC,UAAU,EAAE,CAAC;aACzB;QACH,CAAC;QACD,YAAY,EAAE,UAAU,SAAiB;YACvC,QAAQ,CAAC,WAAW,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC;QACtC,CAAC;QACD,WAAW,EAAE,UAAU,QAAgB;YACrC,IAAI,MAAM,CAAC,kBAAkB,EAAE;gBAC7B,wBAAU,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;aAChC;iBAAM;gBACL,QAAQ,CAAC,WAAW,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;aACpC;QACH,CAAC;QACD,WAAW,EAAE,UAAU,KAAkB,EAAE,QAAmB;YAC5D,wBAAU,CAAC,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;QACvC,CAAC;QACD,aAAa,EAAE;YACb,wBAAU,CAAC,2BAA2B,EAAE,CAAC;QAC3C,CAAC;QACD,iBAAiB,EAAE;YACjB,wBAAU,CAAC,0BAA0B,EAAE,CAAC;QAC1C,CAAC;KACF,CAAC;IACF,OAAO,QAAQ,CAAC;AAClB,CAAC;AA7HD,0CA6HC"}
1
+ {"version":3,"file":"datadogReporter.js","sourceRoot":"","sources":["../../src/reporters/datadogReporter.ts"],"names":[],"mappings":";;;AAUA,wDAAwF;AACxF,sDAA6F;AAC7F,sCAA0C;AAC1C,iEAAyF;AA+GzF,SAAgB,eAAe,CAAC,IAAiB,EAAE,MAA6B;;IAC9E,MAAM,WAAW,GAAG,MAAM,CAAC,QAAQ,CAAC,QAAQ,KAAK,WAAW,CAAC;IAE7D,8EAA8E;IAC9E,oGAAoG;IACpG,MAAM,mBAAmB,GAAG,MAAA,MAAM,CAAC,kBAAkB,mCAAI,KAAK,CAAC;IAC/D,MAAM,kBAAkB,GAAG,MAAM,CAAC,YAAY,KAAK,KAAK,CAAC;IAEzD,mDAAmD;IACnD,IAAI,mBAAmB,KAAK,IAAI,IAAI,kBAAkB,KAAK,IAAI,EAAE;QAC/D,0BAAW,CAAC,IAAI,CAAC;YACf,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,WAAW,EAAE,MAAM,CAAC,WAAW;YAC/B,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,GAAG,EAAE,IAAI,CAAC,WAAW;YACrB,OAAO,EAAE,MAAA,MAAM,CAAC,OAAO,mCAAI,IAAI,CAAC,OAAO;YAEvC,UAAU,EAAE,MAAA,MAAA,MAAM,CAAC,aAAa,mCAAI,MAAM,CAAC,UAAU,mCAAI,GAAG;YAC5D,UAAU,EAAE,MAAM,CAAC,cAAc;YAEjC,sBAAsB,EAAE,MAAA,MAAM,CAAC,sBAAsB,mCAAI,CAAC,WAAW;YACrE,yBAAyB,EAAE,MAAA,MAAM,CAAC,yBAAyB,mCAAI,KAAK;YACpE,4BAA4B,EAAE,MAAM,CAAC,4BAA4B;YAEjE,mBAAmB;SACpB,CAAC,CAAC;QACH,0BAAW,CAAC,MAAM,CAAC,UAAU,CAAC,0BAAW,CAAC,IAAI,CAAC,CAAC;KACjD;IAED,gCAAgC;IAChC,IAAI,kBAAkB,EAAE;QACtB,sBAAa,CAAC,IAAI,CAAC,IAAA,mCAAgB,EAAC,OAAO,MAAM,CAAC,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC;KAC3G;IAED,wBAAU,CAAC,IAAI,CAAC;QACd,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,WAAW,EAAE,MAAM,CAAC,WAAW;QAC/B,aAAa,EAAE,MAAM,CAAC,aAAa;QACnC,OAAO,EAAE,IAAI,CAAC,OAAO;QACrB,GAAG,EAAE,IAAI,CAAC,WAAW;QACrB,OAAO,EAAE,MAAA,MAAM,CAAC,OAAO,mCAAI,IAAI,CAAC,OAAO;QAEvC,UAAU,EAAE,MAAA,MAAA,MAAM,CAAC,aAAa,mCAAI,MAAM,CAAC,UAAU,mCAAI,GAAG;QAC5D,gBAAgB,EAAE,MAAA,MAAM,CAAC,gBAAgB,mCAAI,GAAG;QAEhD,sBAAsB,EAAE,MAAA,MAAM,CAAC,sBAAsB,mCAAI,CAAC,WAAW;QACrE,yBAAyB,EAAE,MAAA,MAAM,CAAC,yBAAyB,mCAAI,KAAK;QACpE,4BAA4B,EAAE,MAAM,CAAC,4BAA4B;QAEjE,iBAAiB,EAAE,MAAA,MAAM,CAAC,iBAAiB,mCAAI,KAAK;QACpD,iBAAiB,EAAE,MAAA,MAAM,CAAC,iBAAiB,mCAAI,KAAK;QACpD,kBAAkB,EAAE,MAAA,MAAM,CAAC,kBAAkB,mCAAI,KAAK;QACtD,mBAAmB,EAAE,MAAA,MAAM,CAAC,mBAAmB,mCAAI,qBAAqB;QACxE,UAAU,EAAE,MAAM,CAAC,UAAU;QAE7B,mBAAmB,EAAE,MAAA,MAAM,CAAC,mBAAmB,mCAAI,iBAAiB;QACpE,qBAAqB,EAAE,MAAM,CAAC,qBAAqB;QACnD,qBAAqB,EAAE,MAAA,MAAM,CAAC,qBAAqB,mCAAI,KAAK;KAC7D,CAAC,CAAC;IAEH,MAAM,QAAQ,GAAc;QAC1B,UAAU,EAAE,UAAU,KAAoB;YACxC,wBAAU,CAAC,SAAS,CAAC,KAAK,CAAC,OAAO,EAAE;gBAClC,KAAK,EAAE,KAAK,CAAC,KAAK;gBAClB,GAAG,KAAK,CAAC,QAAQ;gBACjB,GAAG,KAAK,CAAC,IAAI;gBACb,GAAG,KAAK,CAAC,OAAO;aACjB,CAAC,CAAC;QACL,CAAC;QACD,aAAa,EAAE,UAAU,UAA8B;YACrD,wBAAU,CAAC,SAAS,CAAC,UAAU,CAAC,OAAO,EAAE;gBACvC,GAAG,UAAU,CAAC,QAAQ;gBACtB,QAAQ,EAAE,UAAU,CAAC,QAAQ;aAC9B,CAAC,CAAC;QACL,CAAC;QACD,WAAW,EAAE,UAAU,QAAkB;YACvC,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;gBACnD,IAAI,KAAK,KAAK,IAAI,EAAE;oBAClB,wBAAU,CAAC,mBAAmB,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;oBAE3C,sDAAsD;oBACtD,wEAAwE;oBACxE,0BAAW,CAAC,sBAAsB,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;iBAChD;qBAAM;oBACL,wBAAU,CAAC,sBAAsB,CAAC,GAAG,CAAC,CAAC;oBAEvC,wEAAwE;oBACxE,0BAAW,CAAC,yBAAyB,CAAC,GAAG,CAAC,CAAC;iBAC5C;aACF;QACH,CAAC;QACD,OAAO,EAAE,UAAU,IAAuB;;YACxC,IAAI,IAAI,EAAE;gBACR,wBAAU,CAAC,OAAO,CAAC;oBACjB,EAAE,EAAE,IAAI,CAAC,EAAE;oBACX,KAAK,EAAE,IAAI,CAAC,KAAK;oBACjB,IAAI,EAAE,MAAA,IAAI,CAAC,IAAI,mCAAI,IAAI,CAAC,KAAK;iBAC9B,CAAC,CAAC;aACJ;iBAAM;gBACL,wBAAU,CAAC,UAAU,EAAE,CAAC;aACzB;QACH,CAAC;QACD,YAAY,EAAE,UAAU,SAAiB;YACvC,QAAQ,CAAC,WAAW,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC;QACtC,CAAC;QACD,WAAW,EAAE,UAAU,QAAgB;YACrC,IAAI,MAAM,CAAC,kBAAkB,EAAE;gBAC7B,wBAAU,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;aAChC;iBAAM;gBACL,QAAQ,CAAC,WAAW,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;aACpC;QACH,CAAC;QACD,WAAW,EAAE,UAAU,KAAkB,EAAE,QAAmB;YAC5D,wBAAU,CAAC,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;QACvC,CAAC;QACD,aAAa,EAAE;YACb,wBAAU,CAAC,2BAA2B,EAAE,CAAC;QAC3C,CAAC;QACD,iBAAiB,EAAE;YACjB,wBAAU,CAAC,0BAA0B,EAAE,CAAC;QAC1C,CAAC;KACF,CAAC;IACF,OAAO,QAAQ,CAAC;AAClB,CAAC;AA7HD,0CA6HC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@crimson-education/browser-logger",
3
- "version": "4.0.1",
3
+ "version": "4.0.2",
4
4
  "description": "An abstract logger and reporting utility for browser environments",
5
5
  "scripts": {
6
6
  "prepack": "npm run build",
@@ -27,11 +27,30 @@ export interface DatadogReporterConfig extends ReporterConfigBase {
27
27
 
28
28
  /**
29
29
  * Controls the percentage of overall sessions being tracked. It defaults to 100, so every session is tracked by default.
30
+ *
31
+ * More specific sample rate options take priority over this option. For instance, if `logSampleRate` is 50 and `sampleRate`
32
+ * is 75, then the sample rate used for log messages will be `50`.
33
+ *
34
+ * @deprecated Prefer using the dedicated `logSampleRate`, `rumSampleRate`, and `replaySampleRate` options.
30
35
  */
31
36
  sampleRate?: number;
32
37
  /**
33
- * Applied after the overall sample rate, and controls the percentage of sessions tracked as Browser RUM & Session Replay.
38
+ * Sampling rate for browser log collection. Defaults to 100, meaning every log message is sent to Datadog.
39
+ */
40
+ logSampleRate?: number;
41
+ /**
42
+ * Sampling rate for RUM session collection. Defaults to 100, meaning every browser session is tracked.
43
+ *
44
+ * RUM can be used to track things like core web vitals.
45
+ *
46
+ * @see https://www.datadoghq.com/product/real-user-monitoring/
47
+ */
48
+ rumSampleRate?: number;
49
+ /**
50
+ * Applied after the RUM sample rate, and controls the percentage of sessions tracked as Browser RUM & Session Replay.
34
51
  * It defaults to 100, so every session is tracked as Browser RUM & Session Replay by default.
52
+ *
53
+ * These sessions end up with a session replay available in Datadog.
35
54
  */
36
55
  replaySampleRate?: number;
37
56
 
@@ -121,7 +140,7 @@ export function datadogReporter(info: ServiceInfo, config: DatadogReporterConfig
121
140
  env: info.environment,
122
141
  version: config.version ?? info.version,
123
142
 
124
- sampleRate: config.sampleRate ?? 100,
143
+ sampleRate: config.logSampleRate ?? config.sampleRate ?? 100,
125
144
  beforeSend: config.beforeLogsSend,
126
145
 
127
146
  useSecureSessionCookie: config.useSecureSessionCookie ?? !isLocalhost,
@@ -147,7 +166,7 @@ export function datadogReporter(info: ServiceInfo, config: DatadogReporterConfig
147
166
  env: info.environment,
148
167
  version: config.version ?? info.version,
149
168
 
150
- sampleRate: config.sampleRate ?? 100,
169
+ sampleRate: config.rumSampleRate ?? config.sampleRate ?? 100,
151
170
  replaySampleRate: config.replaySampleRate ?? 100,
152
171
 
153
172
  useSecureSessionCookie: config.useSecureSessionCookie ?? !isLocalhost,