> ## Documentation Index
> Fetch the complete documentation index at: https://launchdarkly.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Vue SDK observability reference

export const pubhost_2 = "pub.observability.app.eu.launchdarkly.com"

export const otelhost_2 = "otel.observability.app.eu.launchdarkly.com"

export const pubhost_1 = "pub.observability.app.launchdarkly.com"

export const otelhost_1 = "otel.observability.app.launchdarkly.com"

export const pubhost_0 = "pub.observability.app.launchdarkly.com"

export const otelhost_0 = "otel.observability.app.launchdarkly.com"

<View title="Developer">
  This topic documents how to get started with the LaunchDarkly observability plugins for the Vue SDK.

  The Vue SDK supports the following observability plugins:

  * An **Observability plugin** for error monitoring, logging, and tracing.
  * A **Session replay plugin** that provides a way to record and replay end-user sessions from your application.

  <Note>
    **SDK quick links**

    LaunchDarkly SDKs are open source. In addition to this reference guide, we provide source, API reference documentation, and a sample application:

    <table>
      <thead>
        <tr>
          <th>Resource</th>
          <th>Location</th>
        </tr>
      </thead>

      <tbody>
        <tr>
          <td>SDK API documentation</td>
          <td>[Observability plugin API docs](https://launchdarkly.github.io/observability-sdk/packages/@launchdarkly/observability/interfaces/api_observe.Observe.html) <br /> [Session replay API docs](https://launchdarkly.github.io/observability-sdk/packages/@launchdarkly/observability/interfaces/api_record.Record.html)</td>
        </tr>

        <tr>
          <td>GitHub repository</td>
          <td>[@launchdarkly/observability](https://github.com/launchdarkly/observability-sdk/tree/main/sdk/%40launchdarkly/observability)</td>
        </tr>

        <tr>
          <td>Published module</td>
          <td>[npm](https://www.npmjs.com/package/@launchdarkly/observability)</td>
        </tr>
      </tbody>
    </table>
  </Note>

  <Warning>
    **For use in client applications only**

    These observability and session replay plugins are for the LaunchDarkly client-side JavaScript-based SDKs.

    To learn more about the different LaunchDarkly SDK types, read [Choosing an SDK type](/docs/sdk/concepts/client-side-server-side).
  </Warning>

  ## Prerequisites and dependencies

  This reference guide assumes that you are somewhat familiar with the LaunchDarkly [Vue SDK](/docs/sdk/client-side/vue).

  The observability plugin is compatible with the [Vue SDK](/docs/sdk/client-side/vue), version 2.4.0 and later, including version 3.0.

  Version 3.0 of the Vue SDK renames the package to `@launchdarkly/vue-client-sdk` and the plugin to `LDVuePlugin`, and moves the observability plugins into the `ldOptions` property. To learn more, read the [Vue SDK 2.x to 3.0 migration guide](/docs/sdk/client-side/vue/migration-2-to-3).

  <Tip>
    **Do you need information about Angular, Remix, Svelte, or other frameworks?**

    LaunchDarkly does not offer SDKs for all languages or frameworks. If you're using another framework, such as Angular, Remix, or Svelte, you may be able to use the [JavaScript SDK](/docs/sdk/observability/javascript) instead. Install the observability plugins and initialize them when you initialize the client for the JavaScript SDK.

    To request support for a specific language or framework, [start a Support ticket](https://support.launchdarkly.com/hc/en-us/requests/new).
  </Tip>

  ## Get started

  Follow these steps to get started:

  * [Install the plugins](#install-the-plugins)
  * [Initialize the Vue SDK client](#initialize-the-client)
  * [Configure the plugin options](#configure-the-plugin-options)
  * [Explore supported features](#explore-supported-features)
  * [Review observability data in LaunchDarkly](#review-observability-data-in-launchdarkly)

  ## Install the plugins

  LaunchDarkly uses plugins to the Vue SDK to provide observability. Most customers use both the observability and session replay plugins. However, there is no dependency between them, and you can use only one or the other if you like.

  The first step is to make both the SDK and the observability plugins available as dependencies.

  Here's how:

  <CodeGroup>
    ```bash title="npm, Vue SDK v3.0" lines wrap theme={null}
    npm install @launchdarkly/vue-client-sdk
    npm install @launchdarkly/observability
    npm install @launchdarkly/session-replay
    ```

    ```bash title="yarn, Vue SDK v3.0" lines wrap theme={null}
    yarn add @launchdarkly/vue-client-sdk
    yarn add @launchdarkly/observability
    yarn add @launchdarkly/session-replay
    ```

    ```bash title="npm, Vue SDK v2.4+" lines wrap theme={null}
      npm install launchdarkly-vue-client-sdk
      npm install @launchdarkly/observability
      npm install @launchdarkly/session-replay
    ```

    ```bash title="yarn, Vue SDK v2.4+" lines wrap theme={null}
      yarn add launchdarkly-vue-client-sdk
      yarn add @launchdarkly/observability
      yarn add @launchdarkly/session-replay
    ```
  </CodeGroup>

  Then, import the plugin into your code:

  <CodeGroup>
    ```js title="Import, Vue SDK v3.0" lines wrap theme={null}
    import { createApp } from 'vue'
    import App from './App.vue'
    import { LDVuePlugin } from '@launchdarkly/vue-client-sdk'
    import Observability, { LDObserve } from '@launchdarkly/observability'
    import SessionReplay, { LDRecord } from '@launchdarkly/session-replay'
    ```

    ```js title="Import, Vue SDK v2.4+" lines wrap theme={null}
    import { createApp } from 'vue'
    import App from './App.vue'
    import { LDPlugin } from 'launchdarkly-vue-client-sdk'
    import Observability, { LDObserve } from '@launchdarkly/observability'
    import SessionReplay, { LDRecord } from '@launchdarkly/session-replay'
    ```
  </CodeGroup>

  ## Initialize the client

  Next, initialize the SDK and the plugins.

  To initialize, you need your LaunchDarkly environment's client-side ID. This authorizes your application to connect to a particular environment within LaunchDarkly. To learn more, read [Initialize the client and context](/docs/sdk/client-side/vue#initialize-the-client-and-context) in the Vue SDK reference guide.

  <Warning>
    **Vue observability SDK credentials**

    The Vue observability SDK requires a client-side ID. Client-side IDs are specific to each project and environment. They are not secret, and you can include them in client-side code. Do not embed a server-side SDK key in a client-side application.

    You can find client-side IDs and project keys on the **SDK keys** page under **Settings**. To learn more about key types, read [Keys](/docs/sdk/concepts/client-side-server-side#keys-and-credentials).
  </Warning>

  You can initialize the observability plugins either at the same time you initialize the SDK, or afterwards.

  ### Initialize SDK client and plugins together

  Here's how to initialize the SDK and plugins:

  <CodeGroup>
    ```js title="Initialize, Vue SDK v3.0" lines wrap theme={null}
    // main.js

    const app = createApp(App)
    app.use(LDVuePlugin, {
      clientSideID: 'example-client-side-id',
      context: { kind: 'user', key: 'example-context-key' },
      ldOptions: {
        plugins: [ new Observability(), new SessionReplay() ]
      }
    })
    app.mount('#app')
    ```

    ```js title="Initialize, Vue SDK v2.4+" lines wrap theme={null}
    // main.js

    const app = createApp(App)
    app.use(LDPlugin, {
      clientSideID: 'example-client-side-id',
      options: {
        plugins: [ new Observability(), new SessionReplay() ]
      }
    })
    app.mount('#app')
    ```
  </CodeGroup>

  Version 3.0 of the Vue SDK requires a context. It also provides `createLDProvider` as an alternative to the plugin, which accepts the same `ldOptions` property. To learn more, read [Configure the SDK](/docs/sdk/client-side/vue#configure-the-sdk) in the Vue SDK reference guide.

  ### Initialize the plugins after the SDK client

  You can initialize the observability and session replay plugins manually, after the SDK client is initialized.

  This approach supports feature-flagged rollouts or dynamic initialization after end user consent. Both plugins use a `manualStart` option combined with `.start()` calls.

  First, configure the plugins with `manualStart: true`:

  <CodeGroup>
    ```js title="Manual start configuration, Vue SDK v3.0" lines wrap theme={null}
    // main.js

    const app = createApp(App)
    app.use(LDVuePlugin, {
      clientSideID: 'example-client-side-id',
      context: { kind: 'user', key: 'example-context-key' },
      ldOptions: {
        plugins: [
          new Observability({ manualStart: true }),
          new SessionReplay({ manualStart: true })
        ]
      }
    })
    app.mount('#app')
    ```

    ```js title="Manual start configuration, Vue SDK v2.4+" lines wrap theme={null}
    // main.js

    const app = createApp(App)
    app.use(LDPlugin, {
      clientSideID: 'example-client-side-id',
      options: {
        plugins: [
          new Observability({ manualStart: true }),
          new SessionReplay({ manualStart: true })
        ]
      }
    })
    app.mount('#app')
    ```
  </CodeGroup>

  Then, start the plugins when appropriate, such as after receiving end user consent or when a feature flag enables observability.

  Here's an example starting the observability plugin:

  <CodeGroup>
    ```js title="Start observability plugin" lines wrap theme={null}
    // Start observability after user consent or feature flag check
    if (userConsentReceived || featureFlagEnabled) {
      LDObserve.start();
    }
    ```

    ```js title="Start observability with feature flag" lines wrap theme={null}
    // Example: Start observability based on a feature flag
    const observabilityEnabled = client.variation('enable-observability', false);
    if (observabilityEnabled) {
      LDObserve.start();
    }
    ```

    ```js title="Start observability after end user action" lines wrap theme={null}
    // Example: Start observability after user accepts analytics
    const handleAcceptAnalytics = () => {
      // Store user preference
      localStorage.setItem('analyticsAccepted', 'true');

      // Start observability
      LDObserve.start();
    };
    ```
  </CodeGroup>

  Here's an example with the session replay plugin:

  <CodeGroup>
    ```js title="Start recording" lines wrap theme={null}
    LDRecord.start({
      silent: false // if true, console.warn messages created in this method are skipped
    });
    ```

    ```js title="Stop recording" lines wrap theme={null}
    LDRecord.stop();
    ```
  </CodeGroup>

  This approach lets you:

  * Feature-flag the rollout of observability to a subset of end users
  * Wait for end user consent before starting data collection
  * Dynamically enable observability based on runtime conditions
  * Maintain compliance with privacy regulations

  ## Configure the plugin options

  You can configure options for the observability plugins when you initialize the SDK. The plugin constructors take an optional object with the configuration details.

  <Note>
    **Session replays are obscured by default**

    By default, session replays use the `strict` privacy setting, which obscures some data. Use <code>none</code> to turn off session replay obfuscation. This enables more detail on session replays, but may expose more of your customer data than your privacy or data retention policies allow. To learn more, read [Session replay config](/docs/sdk/features/session-replay-config).
  </Note>

  Here is an example:

  <CodeGroup>
    ```js title="Plugin options, Vue SDK v3.0" lines wrap theme={null}
    // main.js

    const app = createApp(App)
    app.use(LDVuePlugin, {
      clientSideID: 'example-client-side-id',
      context: { kind: 'user', key: 'example-context-key' },
      ldOptions: {
        plugins: [
          new Observability({
            tracingOrigins: true, // attribute frontend requests to backend domains
            networkRecording: {
              enabled: true,
              recordHeadersAndBody: true
            }
          }),
          new SessionReplay({
            privacySetting: 'strict',
              // or 'default' to redact text matching common regex for PII
              // or 'none' to turn off obfuscation
          })
        ]
      }
    })
    app.mount('#app')
    ```

    ```js title="Plugin options, Vue SDK v2.4+" expandable lines wrap theme={null}
    // main.js

    const app = createApp(App)
    app.use(LDPlugin, {
      clientSideID: 'example-client-side-id',
      options: {
        plugins: [
          new Observability({
            tracingOrigins: true, // attribute frontend requests to backend domains
            networkRecording: {
              enabled: true,
              recordHeadersAndBody: true
            }
          }),
          new SessionReplay({
            privacySetting: 'strict',
              // or 'default' to redact text matching common regex for PII
              // or 'none' to turn off obfuscation
          })
        ]
      }
    })
    app.mount('#app')
    ```
  </CodeGroup>

  For more information on plugin options, read [Configuration for client-side observability](/docs/sdk/features/observability-config-client-side) and [Configuration for session replay](/docs/sdk/features/session-replay-config).

  ## Set Context-Security-Policy (CSP)

  If your application runs in an environment that enforces content security policies, you must set the `Content-Security-Policy` (CSP) in your application to tell the browser how your page can interact with third-party scripts.

  Here are the policies you need to set to use the observability plugin:

  * <code>connect-src: https\://{pubhost_0} https\://{otelhost_0}</code>: This policy allows connecting with LaunchDarkly servers to send recorded observability data.
  * `worker-src: data: blob:`: This policy allows creating an inline web worker initialized by the `npm` package for this plugin.

  Your CSP definition may look something like this:

  <CodeGroup>
    ```html title="Example CSP definition" lines wrap theme={null}
    <meta
      http-equiv="Content-Security-Policy"
      content="connect-src: https://pub.observability.app.launchdarkly.com https://otel.observability.app.launchdarkly.com; worker-src data: blob:;"
    />

    ```
  </CodeGroup>

  Alternatively, you can set the CSP in the HTML document response header `Content-Security-Policy`. Check your initial app HTML document load for the header to make sure you are setting it to the desired value.

  ## Explore supported features

  The observability plugin supports the following features. After the SDK and plugins are initialized, you can access these from within your application:

  * [Configuration for client-side observability](/docs/sdk/features/observability-config-client-side#vue)
  * [Configuration for session replay](/docs/sdk/features/session-replay-config#vue)
  * [Errors](/docs/sdk/features/observability-errors#vue)
  * [Logs](/docs/sdk/features/observability-logs#vue)
  * [Metrics](/docs/sdk/features/observability-metrics#vue)
  * [Tracing](/docs/sdk/features/observability-traces#vue)

  ## Review observability data in LaunchDarkly

  After you initialize the SDK and observability plugins, your application automatically starts sending observability data back to LaunchDarkly in the form of custom events. You can review this information in the LaunchDarkly user interface. To learn how, read [Observability](/docs/home/observability).

  Specifically, the observability data includes events that LaunchDarkly uses to automatically create the following metrics:

  * Average, P95, and P99 Cumulative Layout Shift (CLS) per context (LaunchDarkly)
  * Average, P95, and P99 Document Load Latency per context (LaunchDarkly)
  * Percentage of users with errors (LaunchDarkly)
  * Average, P95, and P99 First Contentful Paint (FCP) per context (LaunchDarkly)
  * Average, P95, and P99 First Input Delay (FID) per context (LaunchDarkly)
  * Average, P95, and P99 Interaction to Next Paint (INP) per context (LaunchDarkly)
  * Average, P95, and P99 Largest Contentful Paint (LCP) (LaunchDarkly)
  * Average, P95, and P99 Time to First Byte (TTFB) per context (LaunchDarkly)

  To learn more, read [Observability autogenerated metrics](/docs/home/metrics/autogen/observability).
</View>

<View title="Federal docs">
  This topic documents how to get started with the LaunchDarkly observability plugins for the Vue SDK.

  The Vue SDK supports the following observability plugins:

  * An **Observability plugin** for error monitoring, logging, and tracing.
  * A **Session replay plugin** that provides a way to record and replay end-user sessions from your application.

  <Note>
    **SDK quick links**

    LaunchDarkly SDKs are open source. In addition to this reference guide, we provide source, API reference documentation, and a sample application:

    <table>
      <thead>
        <tr>
          <th>Resource</th>
          <th>Location</th>
        </tr>
      </thead>

      <tbody>
        <tr>
          <td>SDK API documentation</td>
          <td>[Observability plugin API docs](https://launchdarkly.github.io/observability-sdk/packages/@launchdarkly/observability/interfaces/api_observe.Observe.html) <br /> [Session replay API docs](https://launchdarkly.github.io/observability-sdk/packages/@launchdarkly/observability/interfaces/api_record.Record.html)</td>
        </tr>

        <tr>
          <td>GitHub repository</td>
          <td>[@launchdarkly/observability](https://github.com/launchdarkly/observability-sdk/tree/main/sdk/%40launchdarkly/observability)</td>
        </tr>

        <tr>
          <td>Published module</td>
          <td>[npm](https://www.npmjs.com/package/@launchdarkly/observability)</td>
        </tr>
      </tbody>
    </table>
  </Note>

  <Warning>
    **For use in client applications only**

    These observability and session replay plugins are for the LaunchDarkly client-side JavaScript-based SDKs.

    To learn more about the different LaunchDarkly SDK types, read [Choosing an SDK type](/docs/sdk/concepts/client-side-server-side).
  </Warning>

  ## Prerequisites and dependencies

  This reference guide assumes that you are somewhat familiar with the LaunchDarkly [Vue SDK](/docs/sdk/client-side/vue).

  The observability plugin is compatible with the [Vue SDK](/docs/sdk/client-side/vue), version 2.4.0 and later, including version 3.0.

  Version 3.0 of the Vue SDK renames the package to `@launchdarkly/vue-client-sdk` and the plugin to `LDVuePlugin`, and moves the observability plugins into the `ldOptions` property. To learn more, read the [Vue SDK 2.x to 3.0 migration guide](/docs/sdk/client-side/vue/migration-2-to-3).

  <Tip>
    **Do you need information about Angular, Remix, Svelte, or other frameworks?**

    LaunchDarkly does not offer SDKs for all languages or frameworks. If you're using another framework, such as Angular, Remix, or Svelte, you may be able to use the [JavaScript SDK](/docs/sdk/observability/javascript) instead. Install the observability plugins and initialize them when you initialize the client for the JavaScript SDK.

    To request support for a specific language or framework, [start a Support ticket](https://support.launchdarkly.com/hc/en-us/requests/new).
  </Tip>

  ## Get started

  Follow these steps to get started:

  * [Install the plugins](#install-the-plugins)
  * [Initialize the Vue SDK client](#initialize-the-client)
  * [Configure the plugin options](#configure-the-plugin-options)
  * [Explore supported features](#explore-supported-features)
  * [Review observability data in LaunchDarkly](#review-observability-data-in-launchdarkly)

  ## Install the plugins

  LaunchDarkly uses plugins to the Vue SDK to provide observability. Most customers use both the observability and session replay plugins. However, there is no dependency between them, and you can use only one or the other if you like.

  The first step is to make both the SDK and the observability plugins available as dependencies.

  Here's how:

  <CodeGroup>
    ```bash title="npm, Vue SDK v3.0" lines wrap theme={null}
    npm install @launchdarkly/vue-client-sdk
    npm install @launchdarkly/observability
    npm install @launchdarkly/session-replay
    ```

    ```bash title="yarn, Vue SDK v3.0" lines wrap theme={null}
    yarn add @launchdarkly/vue-client-sdk
    yarn add @launchdarkly/observability
    yarn add @launchdarkly/session-replay
    ```

    ```bash title="npm, Vue SDK v2.4+" lines wrap theme={null}
      npm install launchdarkly-vue-client-sdk
      npm install @launchdarkly/observability
      npm install @launchdarkly/session-replay
    ```

    ```bash title="yarn, Vue SDK v2.4+" lines wrap theme={null}
      yarn add launchdarkly-vue-client-sdk
      yarn add @launchdarkly/observability
      yarn add @launchdarkly/session-replay
    ```
  </CodeGroup>

  Then, import the plugin into your code:

  <CodeGroup>
    ```js title="Import, Vue SDK v3.0" lines wrap theme={null}
    import { createApp } from 'vue'
    import App from './App.vue'
    import { LDVuePlugin } from '@launchdarkly/vue-client-sdk'
    import Observability, { LDObserve } from '@launchdarkly/observability'
    import SessionReplay, { LDRecord } from '@launchdarkly/session-replay'
    ```

    ```js title="Import, Vue SDK v2.4+" lines wrap theme={null}
    import { createApp } from 'vue'
    import App from './App.vue'
    import { LDPlugin } from 'launchdarkly-vue-client-sdk'
    import Observability, { LDObserve } from '@launchdarkly/observability'
    import SessionReplay, { LDRecord } from '@launchdarkly/session-replay'
    ```
  </CodeGroup>

  ## Initialize the client

  Next, initialize the SDK and the plugins.

  To initialize, you need your LaunchDarkly environment's client-side ID. This authorizes your application to connect to a particular environment within LaunchDarkly. To learn more, read [Initialize the client and context](/docs/sdk/client-side/vue#initialize-the-client-and-context) in the Vue SDK reference guide.

  <Warning>
    **Vue observability SDK credentials**

    The Vue observability SDK requires a client-side ID. Client-side IDs are specific to each project and environment. They are not secret, and you can include them in client-side code. Do not embed a server-side SDK key in a client-side application.

    You can find client-side IDs and project keys on the **SDK keys** page under **Settings**. To learn more about key types, read [Keys](/docs/sdk/concepts/client-side-server-side#keys-and-credentials).
  </Warning>

  You can initialize the observability plugins either at the same time you initialize the SDK, or afterwards.

  ### Initialize SDK client and plugins together

  Here's how to initialize the SDK and plugins:

  <CodeGroup>
    ```js title="Initialize, Vue SDK v3.0" lines wrap theme={null}
    // main.js

    const app = createApp(App)
    app.use(LDVuePlugin, {
      clientSideID: 'example-client-side-id',
      context: { kind: 'user', key: 'example-context-key' },
      ldOptions: {
        plugins: [ new Observability(), new SessionReplay() ]
      }
    })
    app.mount('#app')
    ```

    ```js title="Initialize, Vue SDK v2.4+" lines wrap theme={null}
    // main.js

    const app = createApp(App)
    app.use(LDPlugin, {
      clientSideID: 'example-client-side-id',
      options: {
        plugins: [ new Observability(), new SessionReplay() ]
      }
    })
    app.mount('#app')
    ```
  </CodeGroup>

  Version 3.0 of the Vue SDK requires a context. It also provides `createLDProvider` as an alternative to the plugin, which accepts the same `ldOptions` property. To learn more, read [Configure the SDK](/docs/sdk/client-side/vue#configure-the-sdk) in the Vue SDK reference guide.

  ### Initialize the plugins after the SDK client

  You can initialize the observability and session replay plugins manually, after the SDK client is initialized.

  This approach supports feature-flagged rollouts or dynamic initialization after end user consent. Both plugins use a `manualStart` option combined with `.start()` calls.

  First, configure the plugins with `manualStart: true`:

  <CodeGroup>
    ```js title="Manual start configuration, Vue SDK v3.0" lines wrap theme={null}
    // main.js

    const app = createApp(App)
    app.use(LDVuePlugin, {
      clientSideID: 'example-client-side-id',
      context: { kind: 'user', key: 'example-context-key' },
      ldOptions: {
        plugins: [
          new Observability({ manualStart: true }),
          new SessionReplay({ manualStart: true })
        ]
      }
    })
    app.mount('#app')
    ```

    ```js title="Manual start configuration, Vue SDK v2.4+" lines wrap theme={null}
    // main.js

    const app = createApp(App)
    app.use(LDPlugin, {
      clientSideID: 'example-client-side-id',
      options: {
        plugins: [
          new Observability({ manualStart: true }),
          new SessionReplay({ manualStart: true })
        ]
      }
    })
    app.mount('#app')
    ```
  </CodeGroup>

  Then, start the plugins when appropriate, such as after receiving end user consent or when a feature flag enables observability.

  Here's an example starting the observability plugin:

  <CodeGroup>
    ```js title="Start observability plugin" lines wrap theme={null}
    // Start observability after user consent or feature flag check
    if (userConsentReceived || featureFlagEnabled) {
      LDObserve.start();
    }
    ```

    ```js title="Start observability with feature flag" lines wrap theme={null}
    // Example: Start observability based on a feature flag
    const observabilityEnabled = client.variation('enable-observability', false);
    if (observabilityEnabled) {
      LDObserve.start();
    }
    ```

    ```js title="Start observability after end user action" lines wrap theme={null}
    // Example: Start observability after user accepts analytics
    const handleAcceptAnalytics = () => {
      // Store user preference
      localStorage.setItem('analyticsAccepted', 'true');

      // Start observability
      LDObserve.start();
    };
    ```
  </CodeGroup>

  Here's an example with the session replay plugin:

  <CodeGroup>
    ```js title="Start recording" lines wrap theme={null}
    LDRecord.start({
      silent: false // if true, console.warn messages created in this method are skipped
    });
    ```

    ```js title="Stop recording" lines wrap theme={null}
    LDRecord.stop();
    ```
  </CodeGroup>

  This approach lets you:

  * Feature-flag the rollout of observability to a subset of end users
  * Wait for end user consent before starting data collection
  * Dynamically enable observability based on runtime conditions
  * Maintain compliance with privacy regulations

  ## Configure the plugin options

  You can configure options for the observability plugins when you initialize the SDK. The plugin constructors take an optional object with the configuration details.

  <Note>
    **Session replays are obscured by default**

    By default, session replays use the `strict` privacy setting, which obscures some data. Use <code>none</code> to turn off session replay obfuscation. This enables more detail on session replays, but may expose more of your customer data than your privacy or data retention policies allow. To learn more, read [Session replay config](/docs/sdk/features/session-replay-config).
  </Note>

  Here is an example:

  <CodeGroup>
    ```js title="Plugin options, Vue SDK v3.0" lines wrap theme={null}
    // main.js

    const app = createApp(App)
    app.use(LDVuePlugin, {
      clientSideID: 'example-client-side-id',
      context: { kind: 'user', key: 'example-context-key' },
      ldOptions: {
        plugins: [
          new Observability({
            tracingOrigins: true, // attribute frontend requests to backend domains
            networkRecording: {
              enabled: true,
              recordHeadersAndBody: true
            }
          }),
          new SessionReplay({
            privacySetting: 'strict',
              // or 'default' to redact text matching common regex for PII
              // or 'none' to turn off obfuscation
          })
        ]
      }
    })
    app.mount('#app')
    ```

    ```js title="Plugin options, Vue SDK v2.4+" expandable lines wrap theme={null}
    // main.js

    const app = createApp(App)
    app.use(LDPlugin, {
      clientSideID: 'example-client-side-id',
      options: {
        plugins: [
          new Observability({
            tracingOrigins: true, // attribute frontend requests to backend domains
            networkRecording: {
              enabled: true,
              recordHeadersAndBody: true
            }
          }),
          new SessionReplay({
            privacySetting: 'strict',
              // or 'default' to redact text matching common regex for PII
              // or 'none' to turn off obfuscation
          })
        ]
      }
    })
    app.mount('#app')
    ```
  </CodeGroup>

  For more information on plugin options, read [Configuration for client-side observability](/docs/sdk/features/observability-config-client-side) and [Configuration for session replay](/docs/sdk/features/session-replay-config).

  ## Set Context-Security-Policy (CSP)

  If your application runs in an environment that enforces content security policies, you must set the `Content-Security-Policy` (CSP) in your application to tell the browser how your page can interact with third-party scripts.

  Here are the policies you need to set to use the observability plugin:

  * <code>connect-src: https\://{pubhost_1} https\://{otelhost_1}</code>: This policy allows connecting with LaunchDarkly servers to send recorded observability data.
  * `worker-src: data: blob:`: This policy allows creating an inline web worker initialized by the `npm` package for this plugin.

  Your CSP definition may look something like this:

  <CodeGroup>
    ```html title="Example CSP definition" lines wrap theme={null}
    <meta
      http-equiv="Content-Security-Policy"
      content="connect-src: https://pub.observability.app.launchdarkly.com https://otel.observability.app.launchdarkly.com; worker-src data: blob:;"
    />

    ```
  </CodeGroup>

  Alternatively, you can set the CSP in the HTML document response header `Content-Security-Policy`. Check your initial app HTML document load for the header to make sure you are setting it to the desired value.

  ## Explore supported features

  The observability plugin supports the following features. After the SDK and plugins are initialized, you can access these from within your application:

  * [Configuration for client-side observability](/docs/sdk/features/observability-config-client-side#vue)
  * [Configuration for session replay](/docs/sdk/features/session-replay-config#vue)
  * [Errors](/docs/sdk/features/observability-errors#vue)
  * [Logs](/docs/sdk/features/observability-logs#vue)
  * [Metrics](/docs/sdk/features/observability-metrics#vue)
  * [Tracing](/docs/sdk/features/observability-traces#vue)

  ## Review observability data in LaunchDarkly

  After you initialize the SDK and observability plugins, your application automatically starts sending observability data back to LaunchDarkly in the form of custom events. You can review this information in the LaunchDarkly user interface. To learn how, read [Observability](/docs/home/observability).

  Specifically, the observability data includes events that LaunchDarkly uses to automatically create the following metrics:

  * Average, P95, and P99 Cumulative Layout Shift (CLS) per context (LaunchDarkly)
  * Average, P95, and P99 Document Load Latency per context (LaunchDarkly)
  * Percentage of users with errors (LaunchDarkly)
  * Average, P95, and P99 First Contentful Paint (FCP) per context (LaunchDarkly)
  * Average, P95, and P99 First Input Delay (FID) per context (LaunchDarkly)
  * Average, P95, and P99 Interaction to Next Paint (INP) per context (LaunchDarkly)
  * Average, P95, and P99 Largest Contentful Paint (LCP) (LaunchDarkly)
  * Average, P95, and P99 Time to First Byte (TTFB) per context (LaunchDarkly)

  To learn more, read [Observability autogenerated metrics](/docs/home/metrics/autogen/observability).
</View>

<View title="EU docs">
  This topic documents how to get started with the LaunchDarkly observability plugins for the Vue SDK.

  The Vue SDK supports the following observability plugins:

  * An **Observability plugin** for error monitoring, logging, and tracing.
  * A **Session replay plugin** that provides a way to record and replay end-user sessions from your application.

  <Note>
    **SDK quick links**

    LaunchDarkly SDKs are open source. In addition to this reference guide, we provide source, API reference documentation, and a sample application:

    <table>
      <thead>
        <tr>
          <th>Resource</th>
          <th>Location</th>
        </tr>
      </thead>

      <tbody>
        <tr>
          <td>SDK API documentation</td>
          <td>[Observability plugin API docs](https://launchdarkly.github.io/observability-sdk/packages/@launchdarkly/observability/interfaces/api_observe.Observe.html) <br /> [Session replay API docs](https://launchdarkly.github.io/observability-sdk/packages/@launchdarkly/observability/interfaces/api_record.Record.html)</td>
        </tr>

        <tr>
          <td>GitHub repository</td>
          <td>[@launchdarkly/observability](https://github.com/launchdarkly/observability-sdk/tree/main/sdk/%40launchdarkly/observability)</td>
        </tr>

        <tr>
          <td>Published module</td>
          <td>[npm](https://www.npmjs.com/package/@launchdarkly/observability)</td>
        </tr>
      </tbody>
    </table>
  </Note>

  <Warning>
    **For use in client applications only**

    These observability and session replay plugins are for the LaunchDarkly client-side JavaScript-based SDKs.

    To learn more about the different LaunchDarkly SDK types, read [Choosing an SDK type](/docs/sdk/concepts/client-side-server-side).
  </Warning>

  ## Prerequisites and dependencies

  This reference guide assumes that you are somewhat familiar with the LaunchDarkly [Vue SDK](/docs/sdk/client-side/vue).

  The observability plugin is compatible with the [Vue SDK](/docs/sdk/client-side/vue), version 2.4.0 and later, including version 3.0.

  Version 3.0 of the Vue SDK renames the package to `@launchdarkly/vue-client-sdk` and the plugin to `LDVuePlugin`, and moves the observability plugins into the `ldOptions` property. To learn more, read the [Vue SDK 2.x to 3.0 migration guide](/docs/sdk/client-side/vue/migration-2-to-3).

  <Tip>
    **Do you need information about Angular, Remix, Svelte, or other frameworks?**

    LaunchDarkly does not offer SDKs for all languages or frameworks. If you're using another framework, such as Angular, Remix, or Svelte, you may be able to use the [JavaScript SDK](/docs/sdk/observability/javascript) instead. Install the observability plugins and initialize them when you initialize the client for the JavaScript SDK.

    To request support for a specific language or framework, [start a Support ticket](https://support.launchdarkly.com/hc/en-us/requests/new).
  </Tip>

  ## Get started

  Follow these steps to get started:

  * [Install the plugins](#install-the-plugins)
  * [Initialize the Vue SDK client](#initialize-the-client)
  * [Configure the plugin options](#configure-the-plugin-options)
  * [Explore supported features](#explore-supported-features)
  * [Review observability data in LaunchDarkly](#review-observability-data-in-launchdarkly)

  ## Install the plugins

  LaunchDarkly uses plugins to the Vue SDK to provide observability. Most customers use both the observability and session replay plugins. However, there is no dependency between them, and you can use only one or the other if you like.

  The first step is to make both the SDK and the observability plugins available as dependencies.

  Here's how:

  <CodeGroup>
    ```bash title="npm, Vue SDK v3.0" lines wrap theme={null}
    npm install @launchdarkly/vue-client-sdk
    npm install @launchdarkly/observability
    npm install @launchdarkly/session-replay
    ```

    ```bash title="yarn, Vue SDK v3.0" lines wrap theme={null}
    yarn add @launchdarkly/vue-client-sdk
    yarn add @launchdarkly/observability
    yarn add @launchdarkly/session-replay
    ```

    ```bash title="npm, Vue SDK v2.4+" lines wrap theme={null}
      npm install launchdarkly-vue-client-sdk
      npm install @launchdarkly/observability
      npm install @launchdarkly/session-replay
    ```

    ```bash title="yarn, Vue SDK v2.4+" lines wrap theme={null}
      yarn add launchdarkly-vue-client-sdk
      yarn add @launchdarkly/observability
      yarn add @launchdarkly/session-replay
    ```
  </CodeGroup>

  Then, import the plugin into your code:

  <CodeGroup>
    ```js title="Import, Vue SDK v3.0" lines wrap theme={null}
    import { createApp } from 'vue'
    import App from './App.vue'
    import { LDVuePlugin } from '@launchdarkly/vue-client-sdk'
    import Observability, { LDObserve } from '@launchdarkly/observability'
    import SessionReplay, { LDRecord } from '@launchdarkly/session-replay'
    ```

    ```js title="Import, Vue SDK v2.4+" lines wrap theme={null}
    import { createApp } from 'vue'
    import App from './App.vue'
    import { LDPlugin } from 'launchdarkly-vue-client-sdk'
    import Observability, { LDObserve } from '@launchdarkly/observability'
    import SessionReplay, { LDRecord } from '@launchdarkly/session-replay'
    ```
  </CodeGroup>

  ## Initialize the client

  Next, initialize the SDK and the plugins.

  To initialize, you need your LaunchDarkly environment's client-side ID. This authorizes your application to connect to a particular environment within LaunchDarkly. To learn more, read [Initialize the client and context](/docs/sdk/client-side/vue#initialize-the-client-and-context) in the Vue SDK reference guide.

  <Warning>
    **Vue observability SDK credentials**

    The Vue observability SDK requires a client-side ID. Client-side IDs are specific to each project and environment. They are not secret, and you can include them in client-side code. Do not embed a server-side SDK key in a client-side application.

    You can find client-side IDs and project keys on the **SDK keys** page under **Settings**. To learn more about key types, read [Keys](/docs/sdk/concepts/client-side-server-side#keys-and-credentials).
  </Warning>

  You can initialize the observability plugins either at the same time you initialize the SDK, or afterwards.

  ### Initialize SDK client and plugins together

  Here's how to initialize the SDK and plugins:

  <CodeGroup>
    ```js title="Initialize, Vue SDK v3.0" lines wrap theme={null}
    // main.js

    const app = createApp(App)
    app.use(LDVuePlugin, {
      clientSideID: 'example-client-side-id',
      context: { kind: 'user', key: 'example-context-key' },
      ldOptions: {
        plugins: [ new Observability(), new SessionReplay() ]
      }
    })
    app.mount('#app')
    ```

    ```js title="Initialize, Vue SDK v2.4+" lines wrap theme={null}
    // main.js

    const app = createApp(App)
    app.use(LDPlugin, {
      clientSideID: 'example-client-side-id',
      options: {
        plugins: [ new Observability(), new SessionReplay() ]
      }
    })
    app.mount('#app')
    ```
  </CodeGroup>

  Version 3.0 of the Vue SDK requires a context. It also provides `createLDProvider` as an alternative to the plugin, which accepts the same `ldOptions` property. To learn more, read [Configure the SDK](/docs/sdk/client-side/vue#configure-the-sdk) in the Vue SDK reference guide.

  ### Initialize the plugins after the SDK client

  You can initialize the observability and session replay plugins manually, after the SDK client is initialized.

  This approach supports feature-flagged rollouts or dynamic initialization after end user consent. Both plugins use a `manualStart` option combined with `.start()` calls.

  First, configure the plugins with `manualStart: true`:

  <CodeGroup>
    ```js title="Manual start configuration, Vue SDK v3.0" lines wrap theme={null}
    // main.js

    const app = createApp(App)
    app.use(LDVuePlugin, {
      clientSideID: 'example-client-side-id',
      context: { kind: 'user', key: 'example-context-key' },
      ldOptions: {
        plugins: [
          new Observability({ manualStart: true }),
          new SessionReplay({ manualStart: true })
        ]
      }
    })
    app.mount('#app')
    ```

    ```js title="Manual start configuration, Vue SDK v2.4+" lines wrap theme={null}
    // main.js

    const app = createApp(App)
    app.use(LDPlugin, {
      clientSideID: 'example-client-side-id',
      options: {
        plugins: [
          new Observability({ manualStart: true }),
          new SessionReplay({ manualStart: true })
        ]
      }
    })
    app.mount('#app')
    ```
  </CodeGroup>

  Then, start the plugins when appropriate, such as after receiving end user consent or when a feature flag enables observability.

  Here's an example starting the observability plugin:

  <CodeGroup>
    ```js title="Start observability plugin" lines wrap theme={null}
    // Start observability after user consent or feature flag check
    if (userConsentReceived || featureFlagEnabled) {
      LDObserve.start();
    }
    ```

    ```js title="Start observability with feature flag" lines wrap theme={null}
    // Example: Start observability based on a feature flag
    const observabilityEnabled = client.variation('enable-observability', false);
    if (observabilityEnabled) {
      LDObserve.start();
    }
    ```

    ```js title="Start observability after end user action" lines wrap theme={null}
    // Example: Start observability after user accepts analytics
    const handleAcceptAnalytics = () => {
      // Store user preference
      localStorage.setItem('analyticsAccepted', 'true');

      // Start observability
      LDObserve.start();
    };
    ```
  </CodeGroup>

  Here's an example with the session replay plugin:

  <CodeGroup>
    ```js title="Start recording" lines wrap theme={null}
    LDRecord.start({
      silent: false // if true, console.warn messages created in this method are skipped
    });
    ```

    ```js title="Stop recording" lines wrap theme={null}
    LDRecord.stop();
    ```
  </CodeGroup>

  This approach lets you:

  * Feature-flag the rollout of observability to a subset of end users
  * Wait for end user consent before starting data collection
  * Dynamically enable observability based on runtime conditions
  * Maintain compliance with privacy regulations

  ## Configure the plugin options

  You can configure options for the observability plugins when you initialize the SDK. The plugin constructors take an optional object with the configuration details.

  <Note>
    **Session replays are obscured by default**

    By default, session replays use the `strict` privacy setting, which obscures some data. Use <code>none</code> to turn off session replay obfuscation. This enables more detail on session replays, but may expose more of your customer data than your privacy or data retention policies allow. To learn more, read [Session replay config](/docs/sdk/features/session-replay-config).
  </Note>

  Here is an example:

  <CodeGroup>
    ```js title="Plugin options, Vue SDK v3.0" lines wrap theme={null}
    // main.js

    const app = createApp(App)
    app.use(LDVuePlugin, {
      clientSideID: 'example-client-side-id',
      context: { kind: 'user', key: 'example-context-key' },
      ldOptions: {
        plugins: [
          new Observability({
            tracingOrigins: true, // attribute frontend requests to backend domains
            networkRecording: {
              enabled: true,
              recordHeadersAndBody: true
            }
          }),
          new SessionReplay({
            privacySetting: 'strict',
              // or 'default' to redact text matching common regex for PII
              // or 'none' to turn off obfuscation
          })
        ]
      }
    })
    app.mount('#app')
    ```

    ```js title="Plugin options, Vue SDK v2.4+" expandable lines wrap theme={null}
    // main.js

    const app = createApp(App)
    app.use(LDPlugin, {
      clientSideID: 'example-client-side-id',
      options: {
        plugins: [
          new Observability({
            tracingOrigins: true, // attribute frontend requests to backend domains
            networkRecording: {
              enabled: true,
              recordHeadersAndBody: true
            }
          }),
          new SessionReplay({
            privacySetting: 'strict',
              // or 'default' to redact text matching common regex for PII
              // or 'none' to turn off obfuscation
          })
        ]
      }
    })
    app.mount('#app')
    ```
  </CodeGroup>

  For more information on plugin options, read [Configuration for client-side observability](/docs/sdk/features/observability-config-client-side) and [Configuration for session replay](/docs/sdk/features/session-replay-config).

  ## Set Context-Security-Policy (CSP)

  If your application runs in an environment that enforces content security policies, you must set the `Content-Security-Policy` (CSP) in your application to tell the browser how your page can interact with third-party scripts.

  Here are the policies you need to set to use the observability plugin:

  * <code>connect-src: https\://{pubhost_2} https\://{otelhost_2}</code>: This policy allows connecting with LaunchDarkly servers to send recorded observability data.
  * `worker-src: data: blob:`: This policy allows creating an inline web worker initialized by the `npm` package for this plugin.

  Your CSP definition may look something like this:

  <CodeGroup>
    ```html title="Example CSP definition" lines wrap theme={null}
    <meta
      http-equiv="Content-Security-Policy"
      content="connect-src: https://pub.observability.app.eu.launchdarkly.com https://otel.observability.app.eu.launchdarkly.com; worker-src data: blob:;"
    />

    ```
  </CodeGroup>

  Alternatively, you can set the CSP in the HTML document response header `Content-Security-Policy`. Check your initial app HTML document load for the header to make sure you are setting it to the desired value.

  ## Explore supported features

  The observability plugin supports the following features. After the SDK and plugins are initialized, you can access these from within your application:

  * [Configuration for client-side observability](/docs/sdk/features/observability-config-client-side#vue)
  * [Configuration for session replay](/docs/sdk/features/session-replay-config#vue)
  * [Errors](/docs/sdk/features/observability-errors#vue)
  * [Logs](/docs/sdk/features/observability-logs#vue)
  * [Metrics](/docs/sdk/features/observability-metrics#vue)
  * [Tracing](/docs/sdk/features/observability-traces#vue)

  ## Review observability data in LaunchDarkly

  After you initialize the SDK and observability plugins, your application automatically starts sending observability data back to LaunchDarkly in the form of custom events. You can review this information in the LaunchDarkly user interface. To learn how, read [Observability](/docs/home/observability).

  Specifically, the observability data includes events that LaunchDarkly uses to automatically create the following metrics:

  * Average, P95, and P99 Cumulative Layout Shift (CLS) per context (LaunchDarkly)
  * Average, P95, and P99 Document Load Latency per context (LaunchDarkly)
  * Percentage of users with errors (LaunchDarkly)
  * Average, P95, and P99 First Contentful Paint (FCP) per context (LaunchDarkly)
  * Average, P95, and P99 First Input Delay (FID) per context (LaunchDarkly)
  * Average, P95, and P99 Interaction to Next Paint (INP) per context (LaunchDarkly)
  * Average, P95, and P99 Largest Contentful Paint (LCP) (LaunchDarkly)
  * Average, P95, and P99 Time to First Byte (TTFB) per context (LaunchDarkly)

  To learn more, read [Observability autogenerated metrics](/docs/home/metrics/autogen/observability).
</View>