@launchdarkly/o11y 0.0.0-stage → 1.2.0

package/dist/observe.d.ts

@@ -0,0 +1,1195 @@
+import { EvaluationSeriesContext } from '@launchdarkly/js-client-sdk';
+import { EvaluationSeriesData } from '@launchdarkly/js-client-sdk';
+import { Hook as Hook_2 } from '@launchdarkly/js-client-sdk';
+import { LDContext } from '@launchdarkly/js-client-sdk';
+import { LDEvaluationReason } from '@launchdarkly/js-client-sdk';
+import { LDFlagValue } from '@launchdarkly/js-client-sdk';
+import { LDPluginEnvironmentMetadata } from '@launchdarkly/js-client-sdk';
+import { LDPluginMetadata } from '@launchdarkly/js-client-sdk';
+
+declare const ALL_CONSOLE_METHODS: readonly ["assert", "count", "countReset", "debug", "dir", "dirxml", "error", "group", "groupCollapsed", "groupEnd", "info", "log", "table", "time", "timeEnd", "timeLog", "trace", "warn"];
+
+declare interface AmplitudeIntegrationOptions extends DefaultIntegrationOptions {
+    apiKey?: string;
+}
+
+/**
+ * Attributes is a map from string to attribute values.
+ *
+ * Note: only the own enumerable keys are counted as valid attribute keys.
+ */
+declare interface Attributes {
+    [attributeKey: string]: AttributeValue | undefined;
+}
+
+/**
+ * Attribute values may be any non-nullish primitive value except an object.
+ *
+ * null or undefined attribute values are invalid and will result in undefined behavior.
+ */
+declare type AttributeValue = string | number | boolean | Array<null | undefined | string> | Array<null | undefined | number> | Array<null | undefined | boolean>;
+
+declare type CommonOptions = {
+    /**
+     * Do not use this.
+     * @private
+     */
+    debug?: boolean | DebugOptions;
+    /**
+     * Specifies the name of the app.
+     */
+    serviceName?: string;
+    /**
+     * Specifies the version of your application.
+     * This is commonly a Git hash or a semantic version.
+     */
+    version?: string;
+    /**
+     * Specifies where to send Highlight session data.
+     * You should not have to set this unless you are running an on-premise instance.
+     */
+    backendUrl?: string;
+    /**
+     * Set to `sessionStorage` to bypass all `window.localStorage` usage.
+     * This can help with compliance for cookie-consent regulation.
+     * Using `sessionStorage` will cause app close+reopens to start a new highlight session,
+     * as the session ID will not persist.
+     */
+    storageMode?: 'sessionStorage' | 'localStorage';
+    /**
+     * By default, session data is stored in the `sessionStorage` 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;
+    /**
+     * 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.
+     * @default false
+     */
+    manualStart?: boolean;
+    /**
+     * Key to use to determine the sessionSecureID in order to override session generation logic.
+     * If a sessionKey is provided, the session will be combined with the previous session with the same key.
+     * Otherwise, the current session logic will be used to generate a sessionSecureID.
+     */
+    sessionKey?: string;
+    /**
+     * A function that returns a friendly name for a given context.
+     * This name will be used to identify the session in the observability UI.
+     * ```ts
+     * contextFriendlyName: (context: LDContext) => {
+     *   if(context.kind === 'multi' && context.user?.email) {
+     *     return context.user.email;
+     *   } else if(context.kind === 'user') {
+     *     return context.key;
+     *   }
+     *   // Use the default identifier for contexts which don't contain a user.
+     *   return undefined;
+     * }
+     * ```
+     * @param context The context to get a friendly name for.
+     * @returns The friendly name for the context, or undefined to use the
+     * default identifier.
+     */
+    contextFriendlyName?: (context: LDContext) => string | undefined;
+};
+
+declare type ConsoleMethods = ConsoleMethodsTuple[number];
+
+declare type ConsoleMethodsTuple = typeof ALL_CONSOLE_METHODS;
+
+declare interface Context {
+    /**
+     * Get a value from the context.
+     *
+     * @param key key which identifies a context value
+     */
+    getValue(key: symbol): unknown;
+    /**
+     * Create a new context which inherits from this context and has
+     * the given key set to the given value.
+     *
+     * @param key context key for which to set the value
+     * @param value value to set for the given key
+     */
+    setValue(key: symbol, value: unknown): Context;
+    /**
+     * Return a new context which inherits from this context but does
+     * not contain a value for the given key.
+     *
+     * @param key context key for which to clear a value
+     */
+    deleteValue(key: symbol): Context;
+}
+
+declare type DebugOptions = {
+    clientInteractions?: boolean;
+    domRecording?: boolean;
+};
+
+declare type DefaultIntegrationOptions = {
+    disabled?: boolean;
+};
+
+declare type ErrorMessageType = 'console.error' | 'window.onerror' | 'window.onunhandledrejection' | 'custom' | 'React.ErrorBoundary';
+
+/**
+ * Defines Exception.
+ *
+ * string or an object with one of (message or name or code) and optional stack
+ */
+declare type Exception = ExceptionWithCode | ExceptionWithMessage | ExceptionWithName | string;
+
+declare interface ExceptionWithCode {
+    code: string | number;
+    name?: string;
+    message?: string;
+    stack?: string;
+}
+
+declare interface ExceptionWithMessage {
+    code?: string | number;
+    message: string;
+    name?: string;
+    stack?: string;
+}
+
+declare interface ExceptionWithName {
+    code?: string | number;
+    message?: string;
+    name: string;
+    stack?: string;
+}
+
+declare interface Headers_2 {
+    [key: string]: any;
+}
+
+/**
+ * Interface for extending SDK functionality via hooks.
+ */
+declare type Hook = Omit<Hook_2, 'afterEvaluation'> & {
+    /**
+     * This method is called during the execution of the variation method
+     * after the flag value has been determined. The method is executed synchronously.
+     *
+     * @param hookContext Contains read-only information about the evaluation
+     * being performed.
+     * @param data A record associated with each stage of hook invocations. Each
+     *  stage is called with the data of the previous stage for a series.
+     * @param detail The result of the evaluation. This value should not be
+     * modified.
+     * @returns Data to use when executing the next state of the hook in the evaluation series. It is
+     * recommended to expand the previous input into the return. This helps ensure your stage remains
+     * compatible moving forward as more stages are added.
+     * ```js
+     * return {...data, "my-new-field": /*my data/*}
+     * ```
+     */
+    afterEvaluation?(hookContext: EvaluationSeriesContext, data: EvaluationSeriesData, detail: {
+        /**
+         * The result of the flag evaluation. This will be either one of the flag's variations or
+         * the default value that was passed to `LDClient.variationDetail`.
+         */
+        value: LDFlagValue;
+        /**
+         * The index of the returned value within the flag's list of variations, e.g. 0 for the
+         * first variation-- or `null` if the default value was returned.
+         */
+        variationIndex?: number | null;
+        /**
+         * An object describing the main factor that influenced the flag evaluation value.
+         */
+        reason?: LDEvaluationReason | null;
+    }): EvaluationSeriesData;
+};
+
+/**
+ * Defines High-Resolution Time.
+ *
+ * The first number, HrTime[0], is UNIX Epoch time in seconds since 00:00:00 UTC on 1 January 1970.
+ * The second number, HrTime[1], represents the partial second elapsed since Unix Epoch time represented by first number in nanoseconds.
+ * For example, 2021-01-01T12:30:10.150Z in UNIX Epoch time in milliseconds is represented as 1609504210150.
+ * The first number is calculated by converting and truncating the Epoch time in milliseconds to seconds:
+ * HrTime[0] = Math.trunc(1609504210150 / 1000) = 1609504210.
+ * The second number is calculated by converting the digits after the decimal point of the subtraction, (1609504210150 / 1000) - HrTime[0], to nanoseconds:
+ * HrTime[1] = Number((1609504210.150 - HrTime[0]).toFixed(9)) * 1e9 = 150000000.
+ * This is represented in HrTime format as [1609504210, 150000000].
+ */
+declare type HrTime = [number, number];
+
+declare type IntegrationOptions = {
+    amplitude?: AmplitudeIntegrationOptions;
+    intercom?: IntercomIntegrationOptions;
+    mixpanel?: MixpanelIntegrationOptions;
+};
+
+declare interface IntercomIntegrationOptions extends DefaultIntegrationOptions {
+}
+
+declare interface LDClientMin {
+    track(key: string, data?: any, metricValue?: number): void;
+    identify(ctx: any): void;
+    addHook(hook: Hook): void;
+}
+
+declare interface LDPlugin {
+    getMetadata(): LDPluginMetadata;
+    register(client: LDClientMin, environmentMetadata: LDPluginEnvironmentMetadata): void;
+    getHooks?(metadata: LDPluginEnvironmentMetadata): Hook[];
+}
+
+/**
+ * A pointer from the current {@link Span} to another span in the same trace or
+ * in a different trace.
+ * Few examples of Link usage.
+ * 1. Batch Processing: A batch of elements may contain elements associated
+ *    with one or more traces/spans. Since there can only be one parent
+ *    SpanContext, Link is used to keep reference to SpanContext of all
+ *    elements in the batch.
+ * 2. Public Endpoint: A SpanContext in incoming client request on a public
+ *    endpoint is untrusted from service provider perspective. In such case it
+ *    is advisable to start a new trace with appropriate sampling decision.
+ *    However, it is desirable to associate incoming SpanContext to new trace
+ *    initiated on service provider side so two traces (from Client and from
+ *    Service Provider) can be correlated.
+ */
+declare interface Link {
+    /** The {@link SpanContext} of a linked span. */
+    context: SpanContext;
+    /** A set of {@link SpanAttributes} on the link. */
+    attributes?: SpanAttributes;
+    /** Count of attributes of the link that were dropped due to collection limits */
+    droppedAttributesCount?: number;
+}
+
+declare type MaskInputOptions = Partial<{
+    color: boolean;
+    date: boolean;
+    'datetime-local': boolean;
+    email: boolean;
+    month: boolean;
+    number: boolean;
+    range: boolean;
+    search: boolean;
+    tel: boolean;
+    text: boolean;
+    time: boolean;
+    url: boolean;
+    week: boolean;
+    textarea: boolean;
+    select: boolean;
+    password: boolean;
+}>;
+
+declare interface MixpanelIntegrationOptions extends DefaultIntegrationOptions {
+    projectToken?: string;
+}
+
+declare type NetworkRecordingOptions = {
+    /**
+     * Enables recording of network requests.
+     * The data includes the URLs, the size of the request, and how long the request took.
+     * @default true
+     */
+    enabled?: boolean;
+    /**
+     * This enables recording XMLHttpRequest and Fetch headers and bodies.
+     * @default false
+     */
+    recordHeadersAndBody?: boolean;
+    /**
+     * This disables recording WebSocket events.
+     * WebSocket events are recorded by default if recordHeadersAndBody is set.
+     * @default false
+     */
+    disableWebSocketEventRecordings?: boolean;
+    /**
+     * Request and response headers where the value is not recorded.
+     * The header value is replaced with '[REDACTED]'.
+     * These headers are case-insensitive.
+     * `recordHeadersAndBody` needs to be enabled.
+     * This option will be ignored if `headerKeysToRecord` is set.
+     * @example
+     * networkHeadersToRedact: ['Secret-Header', 'Plain-Text-Password']
+     */
+    networkHeadersToRedact?: string[];
+    /**
+     * Specifies the keys for request/response JSON body that should not be recorded.
+     * The body value is replaced with '[REDACTED]'.
+     * These keys are case-insensitive.
+     * `enabled` and `recordHeadersAndBody` need to be `true`. Otherwise this option will be ignored.
+     * @example bodyKeysToRedact: ['secret-token', 'plain-text-password']
+     * // Only `body.id` and `body.pageNumber` will be recorded.
+     * body = {
+     * 'id': '123',
+     * 'pageNumber': '1',
+     * 'secret-token': 'super-sensitive-value',
+     * 'plain-text-password': 'password123',
+     * }
+     */
+    networkBodyKeysToRedact?: string[];
+    /**
+     * URLs to not record headers and bodies for, and to not propagate trace
+     * headers (e.g. `traceparent`) to. Each entry is matched as a
+     * case-insensitive substring of the full request URL; a match suppresses
+     * both recording and trace-header propagation for that request.
+     * To disable recording headers and bodies for all URLs, set `recordHeadersAndBody` to `false`.
+     * @default ['https://www.googleapis.com/identitytoolkit', 'https://securetoken.googleapis.com']
+     */
+    urlBlocklist?: string[];
+    /**
+     * Specifies the keys for request/response headers to record.
+     * This option will override `networkHeadersToRedact` if specified.
+     * `enabled` and `recordHeadersAndBody` need to be `true`. Otherwise this option will be ignored.
+     * @example headerKeysToRecord: ['id', 'pageNumber']
+     * // Only `headers.id` and `headers.pageNumber` will be recorded.
+     * headers = {
+     * 'id': '123',
+     * 'pageNumber': '1',
+     * 'secret-token': 'super-sensitive-value',
+     * 'plain-text-password': 'password123',
+     * }
+     */
+    headerKeysToRecord?: string[];
+    /**
+     * Specifies the keys for request/response JSON body to record.
+     * This option will override `networkBodyKeysToRedact` if specified.
+     * `enabled` and `recordHeadersAndBody` need to be `true`. Otherwise this option will be ignored.
+     * @example bodyKeysToRecord: ['id', 'pageNumber']
+     * // Only `body.id` and `body.pageNumber` will be recorded.
+     * body = {
+     * 'id': '123',
+     * 'pageNumber': '1',
+     * 'secret-token': 'super-sensitive-value',
+     * 'plain-text-password': 'password123',
+     * }
+     */
+    bodyKeysToRecord?: string[];
+    /**
+     * Record frontend network request metrics that are sent to
+     * the following list of domains. A domain substring match is used to
+     * determine if a network request matches one of the following values.
+     * @example destinationDomains: ['backend.example.com']
+     * // if your frontend makes requests to `backend.example.com` that you would like to record
+     */
+    destinationDomains?: string[];
+    /**
+     * Function to edit/remove data in request/response pairs or ignore the pair entirely.
+     * @example
+     * ```
+     * requestResponseSanitizer: pair => {
+     *   if (pair.request.url.toLowerCase().indexOf('ignore') !== -1) {
+     *      // ignore the entire request/response pair (no network logs)
+     *      return null
+     *    }
+     *
+     *    if (pair.response.body.indexOf('secret') !== -1) {
+     *        // remove the body in the response
+     * 				delete pair.response.body;
+     *    }
+     *
+     *    return pair
+     * }
+     * ```
+     *
+     */
+    requestResponseSanitizer?: (pair: RequestResponsePair) => RequestResponsePair | null;
+};
+
+export declare class Observe extends Plugin_2<ObserveOptions> implements LDPlugin {
+    observe: Observe_2 | undefined;
+    options: ObserveOptions | undefined;
+    private readonly exposureDeduper;
+    constructor(options?: ObserveOptions);
+    private initialize;
+    getMetadata(): {
+        name: string;
+    };
+    register(client: LDClientMin, environmentMetadata: LDPluginEnvironmentMetadata): void;
+    getHooks?(metadata: LDPluginEnvironmentMetadata): Hook[];
+}
+
+declare interface Observe_2 {
+    /**
+     * Start the observability data capture when running in `manualStart` mode.
+     */
+    start: () => Promise<void>;
+    /**
+     * Stop the observability data capture.
+     */
+    stop: () => Promise<void>;
+    /**
+     * Record arbitrary metric values via as a Gauge.
+     * A Gauge records any point-in-time measurement, such as the current CPU utilization %.
+     * Values with the same metric name and attributes are aggregated via the OTel SDK.
+     * See https://opentelemetry.io/docs/specs/otel/metrics/data-model/ for more details.
+     */
+    recordGauge: (metric: OTelMetric) => void;
+    /**
+     * Record arbitrary metric values via as a Counter.
+     * A Counter efficiently records an increment in a metric, such as number of cache hits.
+     * Values with the same metric name and attributes are aggregated via the OTel SDK.
+     * See https://opentelemetry.io/docs/specs/otel/metrics/data-model/ for more details.
+     */
+    recordCount: (metric: OTelMetric) => void;
+    /**
+     * Record arbitrary metric values via as a Counter.
+     * A Counter efficiently records an increment in a metric, such as number of cache hits.
+     * Values with the same metric name and attributes are aggregated via the OTel SDK.
+     * See https://opentelemetry.io/docs/specs/otel/metrics/data-model/ for more details.
+     */
+    recordIncr: (metric: Omit<OTelMetric, 'value'>) => void;
+    /**
+     * Record arbitrary metric values via as a Histogram.
+     * A Histogram efficiently records near-by point-in-time measurement into a bucketed aggregate.
+     * Values with the same metric name and attributes are aggregated via the OTel SDK.
+     * See https://opentelemetry.io/docs/specs/otel/metrics/data-model/ for more details.
+     */
+    recordHistogram: (metric: OTelMetric) => void;
+    /**
+     * Record arbitrary metric values via as a UpDownCounter.
+     * A UpDownCounter efficiently records an increment or decrement in a metric, such as number of paying customers.
+     * Values with the same metric name and attributes are aggregated via the OTel SDK.
+     * See https://opentelemetry.io/docs/specs/otel/metrics/data-model/ for more details.
+     */
+    recordUpDownCounter: (metric: OTelMetric) => void;
+    /**
+     * Starts a new span for tracing in Highlight. The span will be ended when the
+     * callback function returns.
+     *
+     * @example
+     * ```typescript
+     * H.startSpan('span-name', callbackFn)
+     * ```
+     * @example
+     * ```typescript
+     * H.startSpan('span-name', options, callbackFn)
+     * ```
+     * @example
+     * ```typescript
+     * H.startSpan('span-name', options, context, callbackFn)
+     * ```
+     * @example
+     * ```typescript
+     * H.startSpan('span-name', async (span) => {
+     *   span.setAttribute('key', 'value')
+     *   await someAsyncFunction()
+     * })
+     * ```
+     *
+     * @param name The name of the span.
+     * @param options Options for the span.
+     * @param context The context for the span.
+     * @param callbackFn The function to run in the span.
+     */
+    startSpan: {
+        <F extends (span?: Span) => ReturnType<F>>(name: string, fn: F): ReturnType<F>;
+        <F extends (span?: Span) => ReturnType<F>>(name: string, options: SpanOptions, fn: F): ReturnType<F>;
+        <F extends (span?: Span) => ReturnType<F>>(name: string, options: SpanOptions, context: Context, fn: F): ReturnType<F>;
+    };
+    /**
+     * Starts a new span for tracing in Highlight. The span will be ended when the
+     * `end()` is called on the span. It returns whatever is returned from the
+     * callback function.
+     *
+     * @example
+     * ```typescript
+     * H.startManualSpan('span-name', options, (span) => {
+     *   span.addEvent('event-name', { key: 'value' })
+     *   span.setAttribute('key', 'value')
+     *   await someAsyncFunction()
+     *   span.end()
+     * })
+     * ```
+     *
+     * @example
+     * ```typescript
+     * const span = H.startManualSpan('span-name', (s) => s)
+     * span.addEvent('event-name', { key: 'value' })
+     * await someAsyncFunction()
+     * span.end()
+     * ```
+     *
+     * @param name The name of the span.
+     * @param options Options for the span.
+     * @param context The context for the span.
+     * @param fn The function to run in the span.
+     */
+    startManualSpan: {
+        <F extends (span: Span) => ReturnType<F>>(name: string, fn: F): ReturnType<F>;
+        <F extends (span: Span) => ReturnType<F>>(name: string, options: SpanOptions, fn: F): ReturnType<F>;
+        <F extends (span: Span) => ReturnType<F>>(name: string, options: SpanOptions, context: Context, fn: F): ReturnType<F>;
+    };
+    /**
+     * Calling this method will report an error in Highlight and map it to the current session being recorded.
+     * A common use case for `H.error` is calling it right outside of an error boundary.
+     * @see {@link https://docs.highlight.run/grouping-errors} for more information.
+     */
+    recordError: (error: any, message?: string, payload?: {
+        [key: string]: string;
+    }, source?: string, type?: ErrorMessageType) => void;
+    /**
+     * Record arbitrary logs from your own integrations or manual.
+     * Useful when you don't want to emit a console log to the browser dev tools but still want to report a custom log.
+     */
+    recordLog: (message: any, level: ConsoleMethods, metadata?: Attributes) => void;
+    register(client: LDClientMin, environmentMetadata: LDPluginEnvironmentMetadata): void;
+    getHooks?(metadata: LDPluginEnvironmentMetadata): Hook[];
+    setLDContextKeyAttributes(contextKeys: Attributes): void;
+    getLDContextKeyAttributes(): Attributes | undefined;
+}
+
+declare type ObserveOptions = CommonOptions & {
+    /**
+     * Specifies where the backend of the app lives. If specified, the SDK will attach the
+     * traceparent header to outgoing requests whose destination URLs match a substring
+     * or regexp from this list, so that backend errors can be linked back to the session.
+     * If 'true' is specified, all requests to the current domain will be matched.
+     * @example tracingOrigins: ['localhost', /^\//, 'backend.myapp.com']
+     */
+    tracingOrigins?: boolean | (string | RegExp)[];
+    /**
+     * Specifies how and what the SDK records from network requests and responses.
+     */
+    networkRecording?: boolean | NetworkRecordingOptions;
+    /**
+     * Specifies whether the SDK will record console messages.
+     * @default false
+     */
+    disableConsoleRecording?: boolean;
+    /**
+     * Specifies whether the SDK will report `console.error` invocations as Errors.
+     * @default false
+     */
+    reportConsoleErrors?: boolean;
+    /**
+     * Specifies which console methods to record.
+     * The value here will be ignored if `disabledConsoleRecording` is `true`.
+     * @default All console methods.
+     * @example consoleMethodsToRecord: ['log', 'info', 'error']
+     */
+    consoleMethodsToRecord?: ConsoleMethods[];
+    /**
+     * Specifies whether to record performance metrics (e.g. FPS, device memory).
+     * @default true
+     */
+    enablePerformanceRecording?: boolean;
+    /**
+     * Specifies whether to record main-thread `longtask` entries (>50ms) as
+     * `long_task.duration` histogram samples.
+     * @default true
+     */
+    enableLongtaskRecording?: boolean;
+    /**
+     * Specifies whether to subscribe to the browser Reporting API and emit
+     * CSP/intervention reports as errors and deprecation reports as warn logs.
+     * @default true
+     */
+    enableReportingObserver?: boolean;
+    /**
+     * Specifies the environment your application is running in.
+     * This is useful to distinguish whether your session was recorded on localhost or in production.
+     * @default 'production'
+     */
+    environment?: 'development' | 'staging' | 'production' | string;
+    /**
+     * Specifies whether window.Promise should be patched
+     * to record the stack trace of promise rejections.
+     * @default true
+     */
+    enablePromisePatch?: boolean;
+    /**
+     * OTLP options for OpenTelemetry tracing. Instrumentations are enabled by default.
+     */
+    otel?: OtelOptions & {
+        /**
+         * OTLP HTTP endpoint for OpenTelemetry tracing.
+         */
+        otlpEndpoint?: string;
+    };
+    /**
+     * Specifies whether to record product analytics events.
+     * @default true
+     */
+    productAnalytics?: boolean | ProductAnalyticsEvents;
+    /**
+     * The time window, in milliseconds, during which repeated feature flag
+     * evaluations that resolve to the same result are deduplicated, so that only
+     * a single `feature_flag` exposure span is emitted per unique
+     * (flag key, value, variation, reason, context) within the window.
+     *
+     * This is useful for reducing exposure volume caused by frequent
+     * re-evaluations (for example, React re-renders).
+     *
+     * Set to `0` (the default) to disable deduplication and emit an exposure
+     * for every evaluation. Set a positive value to enable it.
+     *
+     * @default 0 (disabled)
+     */
+    flagExposureDedupeWindowMillis?: number;
+    /**
+     * The maximum number of unique feature flag exposure keys tracked for
+     * deduplication at once. When exceeded, the least recently recorded keys are
+     * evicted to bound memory usage.
+     *
+     * @default 2000
+     */
+    flagExposureDedupeMaxSize?: number;
+};
+
+declare type OtelInstrumentatonOptions = {
+    '@opentelemetry/instrumentation-document-load'?: false;
+    '@opentelemetry/instrumentation-fetch'?: false;
+    '@opentelemetry/instrumentation-xml-http-request'?: false;
+    '@opentelemetry/instrumentation-user-interaction'?: false;
+};
+
+declare interface OTelMetric {
+    name: string;
+    value: number;
+    /** UCUM / OTel unit for the instrument (e.g. `ms`, `By`). */
+    unit?: string;
+    attributes?: Attributes;
+}
+
+declare type OtelOptions = {
+    instrumentations?: OtelInstrumentatonOptions;
+};
+
+declare class Plugin_2<T extends RecordOptions | ObserveOptions> {
+    protected sessionSecureID: string;
+    constructor(options?: T);
+    configureSession(ldCredential: string, options?: T): void;
+}
+
+declare type PrivacySettingOption = 'strict' | 'default' | 'none';
+
+declare type ProductAnalyticsEvents = {
+    /**
+     * Specifies whether to record product analytics for clicks.
+     * Requires the use of the @opentelemetry/instrumentation-user-interaction instrumentation.
+     * @default true
+     */
+    clicks?: boolean;
+    /**
+     * Specifies whether to record product analytics for page views.
+     * Requires the use of the @opentelemetry/instrumentation-document-load instrumentation.
+     * @default true
+     */
+    pageViews?: boolean;
+    /**
+     * Specifies whether to record product analytics for custom events.
+     * @default true
+     */
+    trackEvents?: boolean;
+};
+
+declare type RecordOptions = CommonOptions & {
+    /**
+     * Specifies where the backend of the app lives. If specified, the SDK will attach the
+     * traceparent header to outgoing requests whose destination URLs match a substring
+     * or regexp from this list, so that backend errors can be linked back to the session.
+     * If 'true' is specified, all requests to the current domain will be matched.
+     * @example tracingOrigins: ['localhost', /^\//, 'backend.myapp.com']
+     */
+    tracingOrigins?: boolean | (string | RegExp)[];
+    /**
+     * If set, the SDK will not record when your app is not visible (in the background).
+     * By default, the SDK will record in the background.
+     * @default false
+     */
+    disableBackgroundRecording?: boolean;
+    enableSegmentIntegration?: boolean;
+    /**
+     * Specifies the environment your application is running in.
+     * This is useful to distinguish whether your session was recorded on localhost or in production.
+     * @default 'production'
+     */
+    environment?: 'development' | 'staging' | 'production' | string;
+    /**
+     * Specifies how much data the SDK should redact during recording.
+     * strict - the SDK will redact all text data, input fields, images and videos on the page.
+     * default - the SDK will redact text data on the page that resembles PII (based on regex patterns).
+     * none - the SDK will not redact any text data on the page.
+     * // Redacted text will be randomized. Instead of seeing "Hello World" in a recording, you will see "1fds1 j59a0".
+     * @see {@link https://launchdarkly.com/docs/sdk/features/session-replay-config#privacy} for more information.
+     */
+    privacySetting?: PrivacySettingOption;
+    /**
+     * Enable masking all <input/> elements. Only applies if privacySetting is `none`.
+     */
+    maskAllInputs?: boolean;
+    /**
+     * Customize the input element types that are masked. Only applies if privacySetting is `none`.
+     */
+    maskInputOptions?: MaskInputOptions;
+    /**
+     * Customize which elements' text should be masked by specifying a CSS class name or RegExp.
+     * Default class is 'highlight-mask'.
+     */
+    maskTextClass?: string | RegExp;
+    /**
+     * Customize which elements' text should be masked via a CSS selector that will match the element
+     * and its descendants.
+     */
+    maskTextSelector?: string;
+    /**
+     * Customize which elements should be blocked (not recorded) by specifying a class name or RegExp.
+     * Default is 'highlight-block'.
+     */
+    blockClass?: string | RegExp;
+    /**
+     * Customize which elements should be blocked via a CSS selector.
+     */
+    blockSelector?: string;
+    /**
+     * Customize which elements and their descendants should be ignored from DOM events by class.
+     * Default is 'highlight-ignore'.
+     */
+    ignoreClass?: string;
+    /**
+     * Customize which elements should be ignored from DOM events via a CSS selector.
+     */
+    ignoreSelector?: string;
+    /**
+     * Specifies whether to record canvas elements or not.
+     * @default false
+     */
+    enableCanvasRecording?: boolean;
+    /**
+     * Configure the recording sampling options, eg. how frequently we record canvas updates.
+     */
+    samplingStrategy?: SamplingStrategy;
+    /**
+     * Specifies whether to inline images into the recording.
+     * This means that images that are local to the client (eg. client-generated blob: urls)
+     * will be serialized into the recording and will be valid on replay.
+     * This will also use canvas snapshotting to inline <video> elements
+     * that use `src="blob:..."` data or webcam feeds (blank src) as <canvas> elements
+     * Only enable this if you are running into issues with client-local images.
+     * Will negatively affect performance.
+     * @default false
+     */
+    inlineImages?: boolean;
+    /**
+     * Specifies whether to inline <video> elements into the recording.
+     * This means that video that are not accessible at a later time
+     * (eg., a signed URL that is short lived)
+     * will be serialized into the recording and will be valid on replay.
+     * Only enable this if you are running into issues with the normal serialization.
+     * Will negatively affect performance.
+     * @default false
+     */
+    inlineVideos?: boolean;
+    /**
+     * Specifies whether to inline stylesheets into the recording.
+     * This means that stylesheets that are local to the client (eg. client-generated blob: urls)
+     * will be serialized into the recording and will be valid on replay.
+     * Only enable this if you are running into issues with client-local stylesheets.
+     * May negatively affect performance.
+     * @default true
+     */
+    inlineStylesheet?: boolean;
+    /**
+     * How often, in milliseconds, session replay checks that its CSSOM patches
+     * are still installed and re-sends CSS-in-JS rules another script on the
+     * page may have caused it to miss. Set to 0 to disable. Lower values recover
+     * styles faster; each check walks every stylesheet on the page.
+     * @default 2000
+     */
+    styleSheetResyncInterval?: number;
+    /**
+     * Enables recording of cross-origin iframes. Should be set in both the parent window and
+     * in the cross-origin iframe.
+     * @default false
+     */
+    recordCrossOriginIframe?: boolean;
+    integrations?: IntegrationOptions;
+    /**
+     * Specifies the keyboard shortcut to open the current session replay.
+     * @see {@link https://launchdarkly.com/docs/sdk/features/session-replay-config#retrieve-session-urls-on-the-client} for more information.
+     */
+    sessionShortcut?: SessionShortcutOptions;
+    /**
+     * By default, data is serialized and send by the Web Worker. Set to `local` to force
+     * sending from the main js thread. Only use `local` for custom environments where Web Workers
+     * are not available (ie. Figma plugins).
+     */
+    sendMode?: 'webworker' | 'local';
+};
+
+declare interface Request_2 {
+    sessionSecureID: string;
+    id: string;
+    url: string;
+    verb: string;
+    headers?: Headers_2;
+    body: any;
+}
+
+declare interface RequestResponsePair {
+    request: Request_2;
+    response: Response_2;
+    /** Whether this URL matched a `urlToBlock` so the contents should not be recorded. */
+    urlBlocked: boolean;
+}
+
+declare interface Response_2 {
+    status: number;
+    headers?: {
+        [k: string]: string;
+    };
+    body: any;
+    /** Number of Bytes transferred over the network. */
+    size?: number;
+}
+
+declare type SamplingStrategy = {
+    /**
+     * 'all' will record every single canvas call.
+     * a number will record an image snapshots in a web-worker a (maximum) number of times per second.
+     * Number is only supported where [`OffscreenCanvas`](http://mdn.io/offscreencanvas) is supported.
+     */
+    canvas?: 'all' | number;
+    /**
+     * For manual usage of `H.snapshot(element) from your canvas rendering function.
+     * See https://www.highlight.io/docs/getting-started/client-sdk/replay-configuration/canvas for setup.`
+     * a number will record an image snapshots in a web-worker a (maximum) number of times per second.
+     */
+    canvasManualSnapshot?: number;
+    /**
+     * A quality at which to take canvas snapshots. See https://developer.mozilla.org/en-US/docs/Web/API/createImageBitmap
+     * @deprecated This value is no longer used.
+     */
+    canvasQuality?: 'pixelated' | 'low' | 'medium' | 'high';
+    /**
+     * A multiplier resolution at which to take canvas snapshots.
+     */
+    canvasFactor?: number;
+    /**
+     * The maximum dimension to take canvas snapshots at.
+     * This setting takes precedence over resizeFactor if the resulting image size
+     * from the resizeFactor calculation is larger than this value.
+     * Eg: set to 600 to ensure that the canvas is saved with images no larger than 600px
+     * in either dimension (while preserving the original canvas aspect ratio).
+     */
+    canvasMaxSnapshotDimension?: number;
+    /**
+     * Default behavior for WebGL canvas elements with `preserveDrawingBuffer: false` is to clear the buffer to
+     * load the canvas into memory to avoid getting a transparent bitmap.
+     * Set to false to disable the clearing (in case there are visual glitches in the canvas).
+     */
+    canvasClearWebGLBuffer?: boolean;
+    /**
+     * Time (in milliseconds) to wait before the initial snapshot of canvas/video elements.
+     */
+    canvasInitialSnapshotDelay?: number;
+    /**
+     * Settings for canvas data serialization. Defaults to {"image/webp", 0.9} for browsers
+     * that support WebP and {"image/jpeg", 0.6} for others. Can be overridden to any type
+     * or quality value supported by [`toDataURL`](http://mdn.io/toDataURL).
+     */
+    dataUrlOptions?: Partial<{
+        type: string;
+        quality: number;
+    }>;
+};
+
+declare type SessionShortcutOptions = false | string;
+
+/**
+ * An interface that represents a span. A span represents a single operation
+ * within a trace. Examples of span might include remote procedure calls or a
+ * in-process function calls to sub-components. A Trace has a single, top-level
+ * "root" Span that in turn may have zero or more child Spans, which in turn
+ * may have children.
+ *
+ * Spans are created by the {@link Tracer.startSpan} method.
+ */
+declare interface Span {
+    /**
+     * Returns the {@link SpanContext} object associated with this Span.
+     *
+     * Get an immutable, serializable identifier for this span that can be used
+     * to create new child spans. Returned SpanContext is usable even after the
+     * span ends.
+     *
+     * @returns the SpanContext object associated with this Span.
+     */
+    spanContext(): SpanContext;
+    /**
+     * Sets an attribute to the span.
+     *
+     * Sets a single Attribute with the key and value passed as arguments.
+     *
+     * @param key the key for this attribute.
+     * @param value the value for this attribute. Setting a value null or
+     *              undefined is invalid and will result in undefined behavior.
+     */
+    setAttribute(key: string, value: SpanAttributeValue): this;
+    /**
+     * Sets attributes to the span.
+     *
+     * @param attributes the attributes that will be added.
+     *                   null or undefined attribute values
+     *                   are invalid and will result in undefined behavior.
+     */
+    setAttributes(attributes: SpanAttributes): this;
+    /**
+     * Adds an event to the Span.
+     *
+     * @param name the name of the event.
+     * @param [attributesOrStartTime] the attributes that will be added; these are
+     *     associated with this event. Can be also a start time
+     *     if type is {@type TimeInput} and 3rd param is undefined
+     * @param [startTime] start time of the event.
+     */
+    addEvent(name: string, attributesOrStartTime?: SpanAttributes | TimeInput, startTime?: TimeInput): this;
+    /**
+     * Adds a single link to the span.
+     *
+     * Links added after the creation will not affect the sampling decision.
+     * It is preferred span links be added at span creation.
+     *
+     * @param link the link to add.
+     */
+    addLink(link: Link): this;
+    /**
+     * Adds multiple links to the span.
+     *
+     * Links added after the creation will not affect the sampling decision.
+     * It is preferred span links be added at span creation.
+     *
+     * @param links the links to add.
+     */
+    addLinks(links: Link[]): this;
+    /**
+     * Sets a status to the span. If used, this will override the default Span
+     * status. Default is {@link SpanStatusCode.UNSET}. SetStatus overrides the value
+     * of previous calls to SetStatus on the Span.
+     *
+     * @param status the SpanStatus to set.
+     */
+    setStatus(status: SpanStatus): this;
+    /**
+     * Updates the Span name.
+     *
+     * This will override the name provided via {@link Tracer.startSpan}.
+     *
+     * Upon this update, any sampling behavior based on Span name will depend on
+     * the implementation.
+     *
+     * @param name the Span name.
+     */
+    updateName(name: string): this;
+    /**
+     * Marks the end of Span execution.
+     *
+     * Call to End of a Span MUST not have any effects on child spans. Those may
+     * still be running and can be ended later.
+     *
+     * Do not return `this`. The Span generally should not be used after it
+     * is ended so chaining is not desired in this context.
+     *
+     * @param [endTime] the time to set as Span's end time. If not provided,
+     *     use the current time as the span's end time.
+     */
+    end(endTime?: TimeInput): void;
+    /**
+     * Returns the flag whether this span will be recorded.
+     *
+     * @returns true if this Span is active and recording information like events
+     *     with the `AddEvent` operation and attributes using `setAttributes`.
+     */
+    isRecording(): boolean;
+    /**
+     * Sets exception as a span event
+     * @param exception the exception the only accepted values are string or Error
+     * @param [time] the time to set as Span's event time. If not provided,
+     *     use the current time.
+     */
+    recordException(exception: Exception, time?: TimeInput): void;
+}
+
+/**
+ * @deprecated please use {@link Attributes}
+ */
+declare type SpanAttributes = Attributes;
+
+/**
+ * @deprecated please use {@link AttributeValue}
+ */
+declare type SpanAttributeValue = AttributeValue;
+
+/**
+ * A SpanContext represents the portion of a {@link Span} which must be
+ * serialized and propagated along side of a {@link Baggage}.
+ */
+declare interface SpanContext {
+    /**
+     * The ID of the trace that this span belongs to. It is worldwide unique
+     * with practically sufficient probability by being made as 16 randomly
+     * generated bytes, encoded as a 32 lowercase hex characters corresponding to
+     * 128 bits.
+     */
+    traceId: string;
+    /**
+     * The ID of the Span. It is globally unique with practically sufficient
+     * probability by being made as 8 randomly generated bytes, encoded as a 16
+     * lowercase hex characters corresponding to 64 bits.
+     */
+    spanId: string;
+    /**
+     * Only true if the SpanContext was propagated from a remote parent.
+     */
+    isRemote?: boolean;
+    /**
+     * Trace flags to propagate.
+     *
+     * It is represented as 1 byte (bitmap). Bit to represent whether trace is
+     * sampled or not. When set, the least significant bit documents that the
+     * caller may have recorded trace data. A caller who does not record trace
+     * data out-of-band leaves this flag unset.
+     *
+     * see {@link TraceFlags} for valid flag values.
+     */
+    traceFlags: number;
+    /**
+     * Tracing-system-specific info to propagate.
+     *
+     * The tracestate field value is a `list` as defined below. The `list` is a
+     * series of `list-members` separated by commas `,`, and a list-member is a
+     * key/value pair separated by an equals sign `=`. Spaces and horizontal tabs
+     * surrounding `list-members` are ignored. There can be a maximum of 32
+     * `list-members` in a `list`.
+     * More Info: https://www.w3.org/TR/trace-context/#tracestate-field
+     *
+     * Examples:
+     *     Single tracing system (generic format):
+     *         tracestate: rojo=00f067aa0ba902b7
+     *     Multiple tracing systems (with different formatting):
+     *         tracestate: rojo=00f067aa0ba902b7,congo=t61rcWkgMzE
+     */
+    traceState?: TraceState;
+}
+
+declare enum SpanKind {
+    /** Default value. Indicates that the span is used internally. */
+    INTERNAL = 0,
+    /**
+     * Indicates that the span covers server-side handling of an RPC or other
+     * remote request.
+     */
+    SERVER = 1,
+    /**
+     * Indicates that the span covers the client-side wrapper around an RPC or
+     * other remote request.
+     */
+    CLIENT = 2,
+    /**
+     * Indicates that the span describes producer sending a message to a
+     * broker. Unlike client and server, there is no direct critical path latency
+     * relationship between producer and consumer spans.
+     */
+    PRODUCER = 3,
+    /**
+     * Indicates that the span describes consumer receiving a message from a
+     * broker. Unlike client and server, there is no direct critical path latency
+     * relationship between producer and consumer spans.
+     */
+    CONSUMER = 4
+}
+
+/**
+ * Options needed for span creation
+ */
+declare interface SpanOptions {
+    /**
+     * The SpanKind of a span
+     * @default {@link SpanKind.INTERNAL}
+     */
+    kind?: SpanKind;
+    /** A span's attributes */
+    attributes?: SpanAttributes;
+    /** {@link Link}s span to other spans */
+    links?: Link[];
+    /** A manually specified start time for the created `Span` object. */
+    startTime?: TimeInput;
+    /** The new span should be a root span. (Ignore parent from context). */
+    root?: boolean;
+}
+
+declare interface SpanStatus {
+    /** The status code of this message. */
+    code: SpanStatusCode;
+    /** A developer-facing error message. */
+    message?: string;
+}
+
+/**
+ * An enumeration of status codes.
+ */
+declare enum SpanStatusCode {
+    /**
+     * The default status.
+     */
+    UNSET = 0,
+    /**
+     * The operation has been validated by an Application developer or
+     * Operator to have completed successfully.
+     */
+    OK = 1,
+    /**
+     * The operation contains an error.
+     */
+    ERROR = 2
+}
+
+/**
+ * Defines TimeInput.
+ *
+ * hrtime, epoch milliseconds, performance.now() or Date
+ */
+declare type TimeInput = HrTime | number | Date;
+
+declare interface TraceState {
+    /**
+     * Create a new TraceState which inherits from this TraceState and has the
+     * given key set.
+     * The new entry will always be added in the front of the list of states.
+     *
+     * @param key key of the TraceState entry.
+     * @param value value of the TraceState entry.
+     */
+    set(key: string, value: string): TraceState;
+    /**
+     * Return a new TraceState which inherits from this TraceState but does not
+     * contain the given key.
+     *
+     * @param key the key for the TraceState entry to be removed.
+     */
+    unset(key: string): TraceState;
+    /**
+     * Returns the value to which the specified key is mapped, or `undefined` if
+     * this map contains no mapping for the key.
+     *
+     * @param key with which the specified value is to be associated.
+     * @returns the value to which the specified key is mapped, or `undefined` if
+     *     this map contains no mapping for the key.
+     */
+    get(key: string): string | undefined;
+    /**
+     * Serializes the TraceState to a `list` as defined below. The `list` is a
+     * series of `list-members` separated by commas `,`, and a list-member is a
+     * key/value pair separated by an equals sign `=`. Spaces and horizontal tabs
+     * surrounding `list-members` are ignored. There can be a maximum of 32
+     * `list-members` in a `list`.
+     *
+     * @returns the serialized string.
+     */
+    serialize(): string;
+}
+
+export { }