@launchdarkly/observability-node - v0.3.1
    Preparing search index...

    Interface NodeOptions

    Options for configuring the LaunchDarkly Observability Plugin.

    Additionally the following environment variables can be used to configure the plugin.

    LAUNCHDARKLY_OTEL_NODE_ENABLE_FILESYSTEM_INSTRUMENTATION - Enable filesystem instrumentation. Defaults to false. LAUNCHDARKLY_OTEL_NODE_ENABLE_OUTGOING_HTTP_INSTRUMENTATION - Enable outgoing HTTP instrumentation. Defaults to true. This only affects the outgoing HTTP requests instrumented by @opentelemetry/instrumentation-http. It does not affect fetch for example.

    OTEL_NODE_ENABLED_INSTRUMENTATIONS, and OTEL_NODE_DISABLED_INSTRUMENTATIONS can be used per the OpenTelemetry documentation, but with a few exceptions. https://opentelemetry.io/docs/zero-code/js/configuration/

    The @opentelemetry/instrumentation-fs instrumentation will only be enabled if LAUNCHDARKLY_OTEL_NODE_ENABLE_FILESYSTEM_INSTRUMENTATION is true, and will be unaffected by the OTEL_NODE_ENABLED_INSTRUMENTATIONS and OTEL_NODE_DISABLED_INSTRUMENTATIONS environment variables.

    interface NodeOptions {
        attributes?: Attributes;
        backendUrl?: string;
        consoleMethodsToRecord?: (
            | "assert"
            | "count"
            | "countReset"
            | "debug"
            | "dir"
            | "dirxml"
            | "error"
            | "group"
            | "groupCollapsed"
            | "groupEnd"
            | "info"
            | "log"
            | "table"
            | "time"
            | "timeEnd"
            | "timeLog"
            | "trace"
            | "warn"
        )[];
        disableConsoleRecording?: boolean;
        disablePgInstrumentationAttributes?: boolean;
        environment?: string;
        otlpEndpoint?: string;
        serializeConsoleAttributes?: boolean;
        serviceName?: string;
        serviceVersion?: string;
    }
    Index

    Properties

    attributes? backendUrl? consoleMethodsToRecord? disableConsoleRecording? disablePgInstrumentationAttributes? environment? otlpEndpoint? serializeConsoleAttributes? serviceName? serviceVersion?

    Properties

    attributes?: Attributes

    Attributes to be added to the OpenTelemetry Resource.

    backendUrl?: string

    Specifies the URL used for non-OTLP operations. These include accessing client sampling configuration.

    consoleMethodsToRecord?: (
        | "assert"
        | "count"
        | "countReset"
        | "debug"
        | "dir"
        | "dirxml"
        | "error"
        | "group"
        | "groupCollapsed"
        | "groupEnd"
        | "info"
        | "log"
        | "table"
        | "time"
        | "timeEnd"
        | "timeLog"
        | "trace"
        | "warn"
    )[]

    Specifies which console methods to record. The value here will be ignored if disabledConsoleRecording is true.

    All console methods.

    consoleMethodsToRecord: ['log', 'info', 'error']
    disableConsoleRecording?: boolean

    Specifies whether the LaunchDarkly Observability Plugin will record console messages.

    false
    disablePgInstrumentationAttributes?: boolean

    Turn off enhanced attribute reporting for pg instrumentation. See the following for additional details. https://github.com/open-telemetry/opentelemetry-js-contrib/blob/64fcbf3b70e7293e143266838ff94b94cf2c30da/plugins/node/opentelemetry-instrumentation-pg/src/types.ts#L52

    environment?: string

    Specifies the environment your application is running in. This is useful to distinguish whether your session was recorded on localhost or in production.

    otlpEndpoint?: string

    The endpoint string to send OTLP HTTP data to.

    https://otel.observability.app.launchdarkly.com
    serializeConsoleAttributes?: boolean

    Set to try to serialize console object arguments into the message body.

    serviceName?: string

    This app's service name.

    serviceVersion?: string

    This app's version ideally set to the latest deployed git SHA.

    Settings

    Member Visibility

    On This Page

    Properties