@launchdarkly/o11y 1.5.0 → 1.6.0

package/dist/index.d.ts

@@ -1925,6 +1925,55 @@ export 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 interface OnHighlightReadyOptions {

package/dist/index.js

@@ -40,11 +40,11 @@ var _ = (s, e, t) => new Promise((i, n) => {
   }, l = (d) => d.done ? i(d.value) : Promise.resolve(d.value).then(o, r);
   l((t = t.apply(s, e)).next());
 });
-import { W as Xe, M as L, r as J, I as Re, a as De, S as Ze, C as et, F as tt, b as st, P as it, c as Ie, g as nt, p as rt, E as ot, d as at, e as ct, f as lt, h as dt, s as ht, i as gt } from "./record-Bgkzgi9x.js";
-import { R as us } from "./record-Bgkzgi9x.js";
-import { s as K, G as T, g as F, S as E, r as Ce, a as Q, b as ut, c as ft, d as Y, e as X, f as W, F as Le, V as mt, P as pt, h as wt, H as Z, M as St, i as yt, L as Be, j as Me, k as bt, p as kt, l as Ee, m as Ne, n as vt, o as _t, q as Rt, t as Dt, u as It, v as Ct, w as Lt, x as Et, y as Nt } from "./common-1QcQF8EE.js";
-import { X as Tt, F as Ot, A as Pt, C as Ht, E as Ut, s as Fe, D as Wt, a as zt, m as Te, d as $e, b as Oe, c as Pe, r as Ve, e as Bt, p as Mt, f as Ft, g as $t, M as D, h as N, W as Vt, N as xt, P as At, J as Kt, i as x, j as A, k as qt, l as Gt, n as jt, o as He } from "./observe-TWCqC5wb.js";
-import { O as ms } from "./observe-TWCqC5wb.js";
+import { W as Xe, M as L, r as J, I as Re, a as De, S as Ze, C as et, F as tt, b as st, P as it, c as Ie, g as nt, p as rt, E as ot, d as at, e as ct, f as lt, h as dt, s as ht, i as gt } from "./record-BpTfYU5r.js";
+import { R as us } from "./record-BpTfYU5r.js";
+import { s as K, G as T, g as F, S as E, r as Ce, a as Q, b as ut, c as ft, d as Y, e as X, f as W, F as Le, V as mt, P as pt, h as wt, H as Z, M as St, i as yt, L as Be, j as Me, k as bt, p as kt, l as Ee, m as Ne, n as vt, o as _t, q as Rt, t as Dt, u as It, v as Ct, w as Lt, x as Et, y as Nt } from "./common-C6gSg2Rq.js";
+import { X as Tt, F as Ot, A as Pt, C as Ht, E as Ut, s as Fe, D as Wt, a as zt, m as Te, d as $e, b as Oe, c as Pe, r as Ve, e as Bt, p as Mt, f as Ft, g as $t, M as D, h as N, W as Vt, N as xt, P as At, J as Kt, i as x, j as A, k as qt, l as Gt, n as jt, o as He } from "./observe-CL-A2YiL.js";
+import { O as ms } from "./observe-CL-A2YiL.js";
 import { L as Jt, s as Qt, a as O } from "./buffer-CwCRPuMA.js";
 import { g as Ue } from "./LDObserve-o8Ro1UV8.js";
 import { L as ws } from "./LDObserve-o8Ro1UV8.js";