@launchdarkly/o11y 1.5.0 → 1.6.0

package/dist/observe.d.ts

@@ -713,6 +713,55 @@ declare type ObserveOptions = CommonOptions & {
      * @default 2000
      */
     flagExposureDedupeMaxSize?: number;
+    /**
+     * Query parameters to read from the page URL and add as attributes to all
+     * telemetry, as if passed to `LDObserve.setAttributes`.
+     *
+     * When the SDK initializes, each listed parameter present in
+     * `location.search` becomes an attribute named after the parameter (e.g.
+     * `utm_campaign`) on every span (including document load, page view and
+     * fetch/XHR spans), log, error and metric for the rest of the page load,
+     * including after SPA navigation drops it from the URL.
+     *
+     * Last touch: when an SPA navigation lands on a URL with any listed
+     * parameter, the captured values are replaced by that URL's values, and
+     * previously captured keys missing from it are removed, so the set always
+     * reflects one landing. A navigation without listed parameters keeps the
+     * current values. Spans already started keep the values they had.
+     *
+     * Values are kept in memory only; nothing is written to storage or
+     * cookies, so a later full page load captures again from its own URL.
+     *
+     * Only the listed keys are captured, so other query parameters (which may
+     * hold personal data such as emails or tokens) are never recorded this
+     * way. The default list contains UTM parameters only. A name ending in `*`
+     * matches every parameter with that prefix (e.g. `'utm_*'`).
+     *
+     * Keys set with `setAttributes` win: capture never replaces or removes a
+     * key the app set itself. `removeAttributes` removes a captured value
+     * (a later landing with that parameter captures it again). Keys in the
+     * namespaces the SDK sets itself (`highlight.*`, `launchdarkly.*`,
+     * `session.*`, `context.contextKeys.*`) are ignored.
+     *
+     * A custom list replaces the default. Set to `false` or `[]` to turn
+     * capture off.
+     * @default ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content']
+     * @example captureQueryParams: ['utm_source', 'utm_campaign', 'gclid']
+     */
+    captureQueryParams?: string[] | false;
+    /**
+     * Specifies whether to record the page that linked to this one. When the
+     * SDK initializes and `document.referrer` is a different origin, it is
+     * added as the `landing.referrer` attribute to all telemetry for the rest
+     * of the page load, as if passed to `LDObserve.setAttributes`.
+     *
+     * Only the origin and path are kept: the query string, fragment and any
+     * credentials are stripped so tokens or personal data in the referrer URL
+     * are not recorded. An empty or same-origin referrer sets nothing, and
+     * the value is not updated on SPA navigation.
+     * @default true
+     */
+    captureReferrer?: boolean;
 };
 
 declare type OtelInstrumentatonOptions = {

package/dist/observe.js

@@ -1,5 +1,5 @@
-import "./common-1QcQF8EE.js";
-import { O as e } from "./observe-TWCqC5wb.js";
+import "./common-C6gSg2Rq.js";
+import { O as e } from "./observe-CL-A2YiL.js";
 import "./LDObserve-o8Ro1UV8.js";
 import "./buffer-CwCRPuMA.js";
 export {

package/dist/{record-Bgkzgi9x.js → record-BpTfYU5r.js}

@@ -40,7 +40,7 @@ var fe = (e, t, s) => new Promise((l, c) => {
   }, b = (m) => m.done ? l(m.value) : Promise.resolve(m.value).then(u, f);
   b((s = s.apply(e, t)).next());
 });
-import { z as Bn, A as to, a as Le, S as Ye, d as Be, g as ri, r as _s, G as ni, b as io, c as so, o as ro, q as no, m as $s, e as li, f as rt, F as qs, V as lo, P as oo, h as ao, t as co, H as er, M as uo, i as ho, s as po, L as mo, B as fo, C as tr, D as bo, E as yo, p as Zo, l as ir, v as go, I as So, y as Xo, J as sr, K as Ro, N as Go, O as Vo, Q as Wo, R as Io, T as wo, U as Co } from "./common-1QcQF8EE.js";
+import { z as Bn, A as to, a as Le, S as Ye, d as Be, g as ri, r as _s, G as ni, b as io, c as so, o as ro, q as no, m as $s, e as li, f as rt, F as qs, V as lo, P as oo, h as ao, t as co, H as er, M as uo, i as ho, s as po, L as mo, B as fo, C as tr, D as bo, E as yo, p as Zo, l as ir, v as go, I as So, y as Xo, J as sr, K as Ro, N as Go, O as Vo, Q as Wo, R as Io, T as wo, U as Co } from "./common-C6gSg2Rq.js";
 import { L as xo, s as vo, i as Me, a as Jt } from "./buffer-CwCRPuMA.js";
 import { LDRecord as Lo } from "./LDRecord.js";
 const ko = {
@@ -11283,4 +11283,4 @@ export {
   Ne as r,
   zu as s
 };
-//# sourceMappingURL=record-Bgkzgi9x.js.map
+//# sourceMappingURL=record-BpTfYU5r.js.map