@launchdarkly/o11y 1.3.0 → 1.4.0

package/dist/record.d.ts

@@ -146,14 +146,29 @@ declare type CommonOptions = {
      */
     storageMode?: 'sessionStorage' | 'localStorage';
     /**
-     * By default, session data is stored in the `sessionStorage` of the browser.
+     * By default, session data is stored in the `localStorage` of the browser.
      * Set to `true` to store session data in a cookie instead.
      * This can help with compliance for cookie-consent regulation.
      */
     sessionCookie?: boolean;
+    /**
+     * Set the `Domain` attribute of the session cookie so the same session can
+     * be continued on different subdomains (e.g. `app.example.com` and
+     * `checkout.example.com` both see a cookie set for `example.com`).
+     * Only applies when `sessionCookie` is set to `true`.
+     * By default, the cookie is scoped to the exact host that created it.
+     */
+    sessionCookieDomain?: string;
     /**
      * Specifies if Highlight should not automatically initialize when the class is created.
      * This should be used with `.start()` and `.stop()` if you want to control when Highlight records.
+     *
+     * While `start()` has not been called, calls that can be deferred (logs,
+     * errors, metrics, `track`) are kept in memory and delivered once
+     * `start()` runs. `start()` and `stop()` can safely be called before the
+     * SDK has initialized: a start made too early resolves once the SDK is
+     * attached. Calls that cannot be deferred (synchronous span callbacks) run
+     * their callback on a no-op span while the SDK is not started.
      * @default false
      */
     manualStart?: boolean;
@@ -353,6 +368,7 @@ declare type HighlightClassOptions = {
     disableSessionRecording?: boolean;
     reportConsoleErrors?: boolean;
     consoleMethodsToRecord?: ConsoleMethods[];
+    recordLaunchDarklySdkLogs?: boolean;
     privacySetting?: PrivacySettingOption;
     maskAllInputs?: boolean;
     maskInputOptions?: MaskInputOptions;
@@ -382,6 +398,7 @@ declare type HighlightClassOptions = {
     sessionSecureID: string;
     storageMode?: 'sessionStorage' | 'localStorage';
     sessionCookie?: boolean;
+    sessionCookieDomain?: string;
     sendMode?: 'webworker' | 'local';
     otlpEndpoint?: HighlightOptions['otlpEndpoint'];
     otel?: HighlightOptions['otel'];
@@ -451,6 +468,14 @@ declare type HighlightOptions = CommonOptions & {
      * @example consoleMethodsToRecord: ['log', 'info', 'error']
      */
     consoleMethodsToRecord?: ConsoleMethods[];
+    /**
+     * Specifies whether console output written by the LaunchDarkly SDK's own
+     * logger (lines prefixed `[LaunchDarkly]`) is recorded. Skipped by default:
+     * the lines describe the SDK, and the streaming URL they contain embeds
+     * the evaluation context.
+     * @default false
+     */
+    recordLaunchDarklySdkLogs?: boolean;
     enableSegmentIntegration?: boolean;
     /**
      * Specifies the environment your application is running in.
@@ -687,10 +712,15 @@ declare type loadedEvent = {
     data: unknown;
 };
 
+/**
+ * Per-component debug logger. Like `sdkLog`, its output is SDK-internal: it
+ * is written only in debug mode and never captured by the console recorder.
+ */
 declare class Logger {
     debug: boolean | undefined;
     name: string | undefined;
     constructor(debug?: boolean, name?: string);
+    private prefix;
     log(...data: any[]): void;
     warn(...data: any[]): void;
 }
@@ -989,6 +1019,15 @@ declare type ObserveOptions = CommonOptions & {
      * @example consoleMethodsToRecord: ['log', 'info', 'error']
      */
     consoleMethodsToRecord?: ConsoleMethods[];
+    /**
+     * Specifies whether console output written by the LaunchDarkly SDK's own
+     * logger (lines prefixed `[LaunchDarkly]`, e.g. stream connection
+     * open/close messages) is recorded as logs. Those lines describe the SDK
+     * rather than your application, and the streaming URL they contain embeds
+     * the evaluation context, so they are skipped by default.
+     * @default false
+     */
+    recordLaunchDarklySdkLogs?: boolean;
     /**
      * Specifies whether to record performance metrics (e.g. FPS, device memory).
      * @default true
@@ -1144,11 +1183,16 @@ declare interface Record_3 {
     /**
      * Start the session when running in `manualStart` mode.
      * Can be used to force start a new session.
+     * Can safely be called before the SDK has initialized (e.g. before the
+     * plugin registers): the call resolves once the SDK is attached and
+     * started, without throwing.
      * @param options the session start options.
      */
     start: (options?: StartOptions) => Promise<void>;
     /**
      * Stop the session recording.
+     * Can safely be called before the SDK has initialized; before `start()`
+     * it cancels a pending start instead of throwing.
      */
     stop: () => void;
     /**
@@ -1404,7 +1448,8 @@ declare class RecordSDK implements Record_3 {
     getCurrentSessionURLWithTimestamp(): string;
     getCurrentSessionURL(): string | null;
     snapshot(element: HTMLCanvasElement): Promise<void>;
-    addSessionFeedback({ timestamp, verbatim, user_email, user_name, }: {
+    /** @deprecated Session feedback is no longer supported. This is a no-op. */
+    addSessionFeedback(_feedback: {
         verbatim: string;
         timestamp: string;
         user_name?: string;

package/dist/record.js

@@ -1,7 +1,7 @@
-import "./common-BkAGcE30.js";
-import { R as i } from "./record-DTawahUk.js";
+import "./common-7gIdCuSo.js";
+import { R as i } from "./record-CwkFdJT0.js";
 import "./LDRecord.js";
-import "./buffer-DIFxvF2Q.js";
+import "./buffer-CwCRPuMA.js";
 export {
   i as Record
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@launchdarkly/o11y",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "description": "Shared browser foundation for @launchdarkly/observability and @launchdarkly/session-replay. Capture frontend metrics, errors, logs, traces, and session replays.",
   "keywords": [
     "launchdarkly",

package/dist/LDObserve-CHIjcqIn.js

@@ -1,92 +0,0 @@
-import { B as f } from "./buffer-DIFxvF2Q.js";
-const i = () => {
-  const t = {
-    end: () => {
-    },
-    spanContext: () => ({
-      traceId: "",
-      spanId: "",
-      traceFlags: 0
-    }),
-    setAttribute: (r, e) => t,
-    setAttributes: (r) => t,
-    addEvent: (r, e, s) => t,
-    addLinks: (r) => t,
-    setStatus: (r) => t,
-    recordException: () => {
-    },
-    addLink: () => t,
-    updateName: () => t,
-    isRecording: () => !1
-  };
-  return t;
-};
-function o(t, r, e) {
-  if (typeof e == "function")
-    return e;
-  if (typeof r == "function")
-    return r;
-  if (typeof t == "function")
-    return t;
-}
-class l extends f {
-  start() {
-    return this._sdk.start();
-  }
-  stop() {
-    return this._sdk.stop();
-  }
-  recordGauge(r) {
-    return this._bufferCall("recordGauge", [r]);
-  }
-  recordCount(r) {
-    return this._bufferCall("recordCount", [r]);
-  }
-  recordIncr(r) {
-    return this._bufferCall("recordIncr", [r]);
-  }
-  recordHistogram(r) {
-    return this._bufferCall("recordHistogram", [r]);
-  }
-  recordUpDownCounter(r) {
-    return this._bufferCall("recordUpDownCounter", [r]);
-  }
-  // The callback holds the caller's own work, so it must never be buffered:
-  // deferring it would replay that work at an arbitrary later time, or drop it.
-  startSpan(r, e, s, a) {
-    var n;
-    return this._isLoaded ? this._bufferCall("startSpan", [r, e, s, a]) : (n = o(e, s, a)) == null ? void 0 : n(i());
-  }
-  startManualSpan(r, e, s, a) {
-    var n;
-    return this._isLoaded ? this._bufferCall("startManualSpan", [r, e, s, a]) : (n = o(e, s, a)) == null ? void 0 : n(i());
-  }
-  register(r, e) {
-    return this._bufferCall("register", [r, e]);
-  }
-  recordLog(r, e, s) {
-    return this._bufferCall("recordLog", [r, e, s]);
-  }
-  recordError(r, e, s, a, n) {
-    return this._bufferCall("recordError", [
-      r,
-      e,
-      s,
-      a,
-      n
-    ]);
-  }
-  setLDContextKeyAttributes(r) {
-    return this._bufferCall("setLDContextKeyAttributes", [r]);
-  }
-  getLDContextKeyAttributes() {
-    return this._bufferCall("getLDContextKeyAttributes", []);
-  }
-}
-let u;
-typeof globalThis != "undefined" ? globalThis.LDObserve ? u = globalThis.LDObserve : (u = new l(), globalThis.LDObserve = u) : u = new l();
-export {
-  u as L,
-  i as g
-};
-//# sourceMappingURL=LDObserve-CHIjcqIn.js.map

package/dist/LDObserve-CHIjcqIn.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"LDObserve-CHIjcqIn.js","sources":["../src/client/otel/utils.ts","../src/sdk/LDObserve.ts"],"sourcesContent":["import {\n\tAttributes,\n\tAttributeValue,\n\tLink,\n\tSpan,\n\tSpanStatus,\n\tTimeInput,\n} from '@opentelemetry/api'\n\nexport const getNoopSpan = () => {\n\tconst noopSpan: Span = {\n\t\tend: () => {},\n\t\tspanContext: () => ({\n\t\t\ttraceId: '',\n\t\t\tspanId: '',\n\t\t\ttraceFlags: 0,\n\t\t}),\n\t\tsetAttribute: (_key: string, _value: AttributeValue) => noopSpan,\n\t\tsetAttributes: (_attributes: Attributes) => noopSpan,\n\t\taddEvent: (\n\t\t\t_name: string,\n\t\t\t_attributesOrStartTime?: Attributes | TimeInput,\n\t\t\t_startTime?: TimeInput,\n\t\t) => noopSpan,\n\t\taddLinks: (_links: Link[]) => noopSpan,\n\t\tsetStatus: (_status: SpanStatus) => noopSpan,\n\t\trecordException: () => {},\n\t\taddLink: () => noopSpan,\n\t\tupdateName: () => noopSpan,\n\t\tisRecording: () => false,\n\t}\n\n\treturn noopSpan\n}\n","import type { Observe } from '../api/observe'\nimport type { LDClient } from '../integrations/launchdarkly'\nimport type { ErrorMessageType } from '../client/types/shared-types'\nimport type { OTelMetric as Metric } from '../client/types/types'\nimport type { Attributes, Context, Span, SpanOptions } from '@opentelemetry/api'\nimport type { LDPluginEnvironmentMetadata } from '../plugins/plugin'\nimport { BufferedClass } from './buffer'\nimport { getNoopSpan } from '../client/otel/utils'\nimport { ConsoleMethods } from '../client/types/client'\n\n/**\n * Resolves the span callback from whichever argument position it was passed in,\n * matching the overloads `startSpan` and `startManualSpan` accept.\n */\nfunction resolveSpanCallback(\n\toptions: unknown,\n\tcontext: unknown,\n\tfn: unknown,\n): ((span: Span) => any) | undefined {\n\tif (typeof fn === 'function') {\n\t\treturn fn as (span: Span) => any\n\t}\n\tif (typeof context === 'function') {\n\t\treturn context as (span: Span) => any\n\t}\n\tif (typeof options === 'function') {\n\t\treturn options as (span: Span) => any\n\t}\n\treturn undefined\n}\n\nclass _LDObserve extends BufferedClass<Observe> implements Observe {\n\tstart() {\n\t\t// avoid buffering the start call\n\t\treturn this._sdk.start()\n\t}\n\n\tstop() {\n\t\t// avoid buffering the stop call\n\t\treturn this._sdk.stop()\n\t}\n\n\trecordGauge(metric: Metric) {\n\t\treturn this._bufferCall('recordGauge', [metric])\n\t}\n\n\trecordCount(metric: Metric) {\n\t\treturn this._bufferCall('recordCount', [metric])\n\t}\n\n\trecordIncr(metric: Omit<Metric, 'value'>) {\n\t\treturn this._bufferCall('recordIncr', [metric])\n\t}\n\n\trecordHistogram(metric: Metric) {\n\t\treturn this._bufferCall('recordHistogram', [metric])\n\t}\n\n\trecordUpDownCounter(metric: Metric) {\n\t\treturn this._bufferCall('recordUpDownCounter', [metric])\n\t}\n\n\t// The callback holds the caller's own work, so it must never be buffered:\n\t// deferring it would replay that work at an arbitrary later time, or drop it.\n\tstartSpan(\n\t\tname: string,\n\t\toptions: SpanOptions | ((span?: Span) => any),\n\t\tcontext?: Context | ((span?: Span) => any),\n\t\tfn?: (span?: Span) => any,\n\t) {\n\t\tif (!this._isLoaded) {\n\t\t\treturn resolveSpanCallback(options, context, fn)?.(getNoopSpan())\n\t\t}\n\t\treturn this._bufferCall('startSpan', [name, options, context, fn])\n\t}\n\n\tstartManualSpan(\n\t\tname: string,\n\t\toptions: SpanOptions | ((span: Span) => any),\n\t\tcontext?: Context | ((span: Span) => any),\n\t\tfn?: (span: Span) => any,\n\t) {\n\t\tif (!this._isLoaded) {\n\t\t\treturn resolveSpanCallback(options, context, fn)?.(getNoopSpan())\n\t\t}\n\t\treturn this._bufferCall('startManualSpan', [name, options, context, fn])\n\t}\n\n\tregister(\n\t\tclient: LDClient,\n\t\tenvironmentMetadata: LDPluginEnvironmentMetadata,\n\t) {\n\t\treturn this._bufferCall('register', [client, environmentMetadata])\n\t}\n\n\trecordLog(message: any, level: ConsoleMethods, metadata?: Attributes) {\n\t\treturn this._bufferCall('recordLog', [message, level, metadata])\n\t}\n\n\trecordError(\n\t\terror: Error,\n\t\tmessage?: string,\n\t\tpayload?: { [key: string]: string },\n\t\tsource?: string,\n\t\ttype?: ErrorMessageType,\n\t) {\n\t\treturn this._bufferCall('recordError', [\n\t\t\terror,\n\t\t\tmessage,\n\t\t\tpayload,\n\t\t\tsource,\n\t\t\ttype,\n\t\t])\n\t}\n\n\tsetLDContextKeyAttributes(contextKeys: Attributes) {\n\t\treturn this._bufferCall('setLDContextKeyAttributes', [contextKeys])\n\t}\n\n\tgetLDContextKeyAttributes(): Attributes | undefined {\n\t\treturn this._bufferCall('getLDContextKeyAttributes', [])\n\t}\n}\n\ninterface GlobalThis {\n\tLDObserve?: _LDObserve\n}\ndeclare var globalThis: GlobalThis\n\nexport let LDObserve!: _LDObserve\nif (typeof globalThis !== 'undefined') {\n\tif (globalThis.LDObserve) {\n\t\tLDObserve = globalThis.LDObserve\n\t} else {\n\t\tLDObserve = new _LDObserve()\n\t\tglobalThis.LDObserve = LDObserve\n\t}\n} else {\n\tLDObserve = new _LDObserve()\n}\n"],"names":["getNoopSpan","noopSpan","_key","_value","_attributes","_name","_attributesOrStartTime","_startTime","_links","_status","resolveSpanCallback","options","context","fn","_LDObserve","BufferedClass","metric","name","_a","client","environmentMetadata","message","level","metadata","error","payload","source","type","contextKeys","LDObserve"],"mappings":";AASO,MAAMA,IAAc,MAAM;AAChC,QAAMC,IAAiB;AAAA,IACtB,KAAK,MAAM;AAAA,IAAC;AAAA,IACZ,aAAa,OAAO;AAAA,MACnB,SAAS;AAAA,MACT,QAAQ;AAAA,MACR,YAAY;AAAA,IAAA;AAAA,IAEb,cAAc,CAACC,GAAcC,MAA2BF;AAAA,IACxD,eAAe,CAACG,MAA4BH;AAAA,IAC5C,UAAU,CACTI,GACAC,GACAC,MACIN;AAAA,IACL,UAAU,CAACO,MAAmBP;AAAA,IAC9B,WAAW,CAACQ,MAAwBR;AAAA,IACpC,iBAAiB,MAAM;AAAA,IAAC;AAAA,IACxB,SAAS,MAAMA;AAAA,IACf,YAAY,MAAMA;AAAA,IAClB,aAAa,MAAM;AAAA,EAAA;AAGpB,SAAOA;AACR;ACnBA,SAASS,EACRC,GACAC,GACAC,GACoC;AACpC,MAAI,OAAOA,KAAO;AACjB,WAAOA;AAER,MAAI,OAAOD,KAAY;AACtB,WAAOA;AAER,MAAI,OAAOD,KAAY;AACtB,WAAOA;AAGT;AAEA,MAAMG,UAAmBC,EAA0C;AAAA,EAClE,QAAQ;AAEP,WAAO,KAAK,KAAK,MAAA;AAAA,EAClB;AAAA,EAEA,OAAO;AAEN,WAAO,KAAK,KAAK,KAAA;AAAA,EAClB;AAAA,EAEA,YAAYC,GAAgB;AAC3B,WAAO,KAAK,YAAY,eAAe,CAACA,CAAM,CAAC;AAAA,EAChD;AAAA,EAEA,YAAYA,GAAgB;AAC3B,WAAO,KAAK,YAAY,eAAe,CAACA,CAAM,CAAC;AAAA,EAChD;AAAA,EAEA,WAAWA,GAA+B;AACzC,WAAO,KAAK,YAAY,cAAc,CAACA,CAAM,CAAC;AAAA,EAC/C;AAAA,EAEA,gBAAgBA,GAAgB;AAC/B,WAAO,KAAK,YAAY,mBAAmB,CAACA,CAAM,CAAC;AAAA,EACpD;AAAA,EAEA,oBAAoBA,GAAgB;AACnC,WAAO,KAAK,YAAY,uBAAuB,CAACA,CAAM,CAAC;AAAA,EACxD;AAAA;AAAA;AAAA,EAIA,UACCC,GACAN,GACAC,GACAC,GACC;;AACD,WAAK,KAAK,YAGH,KAAK,YAAY,aAAa,CAACI,GAAMN,GAASC,GAASC,CAAE,CAAC,KAFzDK,IAAAR,EAAoBC,GAASC,GAASC,CAAE,MAAxC,gBAAAK,EAA4ClB;EAGrD;AAAA,EAEA,gBACCiB,GACAN,GACAC,GACAC,GACC;;AACD,WAAK,KAAK,YAGH,KAAK,YAAY,mBAAmB,CAACI,GAAMN,GAASC,GAASC,CAAE,CAAC,KAF/DK,IAAAR,EAAoBC,GAASC,GAASC,CAAE,MAAxC,gBAAAK,EAA4ClB;EAGrD;AAAA,EAEA,SACCmB,GACAC,GACC;AACD,WAAO,KAAK,YAAY,YAAY,CAACD,GAAQC,CAAmB,CAAC;AAAA,EAClE;AAAA,EAEA,UAAUC,GAAcC,GAAuBC,GAAuB;AACrE,WAAO,KAAK,YAAY,aAAa,CAACF,GAASC,GAAOC,CAAQ,CAAC;AAAA,EAChE;AAAA,EAEA,YACCC,GACAH,GACAI,GACAC,GACAC,GACC;AACD,WAAO,KAAK,YAAY,eAAe;AAAA,MACtCH;AAAA,MACAH;AAAA,MACAI;AAAA,MACAC;AAAA,MACAC;AAAA,IAAA,CACA;AAAA,EACF;AAAA,EAEA,0BAA0BC,GAAyB;AAClD,WAAO,KAAK,YAAY,6BAA6B,CAACA,CAAW,CAAC;AAAA,EACnE;AAAA,EAEA,4BAAoD;AACnD,WAAO,KAAK,YAAY,6BAA6B,EAAE;AAAA,EACxD;AACD;AAOO,IAAIC;AACP,OAAO,cAAe,cACrB,WAAW,YACdA,IAAY,WAAW,aAEvBA,IAAY,IAAIf,EAAA,GAChB,WAAW,YAAYe,KAGxBA,IAAY,IAAIf,EAAA;"}