@launchdarkly/observability-react-native
    Preparing search index...

    Interface ReactNativeOptions

    interface ReactNativeOptions {
        backendUrl?: string;
        contextFriendlyName?: (context: LDContext) => undefined | string;
        customHeaders?: Record<string, string>;
        debug?: boolean;
        disableErrorTracking?: boolean;
        disableLogs?: boolean;
        disableMetrics?: boolean;
        disableTraces?: boolean;
        otlpEndpoint?: string;
        resourceAttributes?: Attributes;
        serviceName?: string;
        serviceVersion?: string;
        sessionTimeout?: number;
        tracingOrigins?: boolean | (string | RegExp)[];
        urlBlocklist?: string[];
    }
    Index

    Properties

    backendUrl? contextFriendlyName? customHeaders? debug? disableErrorTracking? disableLogs? disableMetrics? disableTraces? otlpEndpoint? resourceAttributes? serviceName? serviceVersion? sessionTimeout? tracingOrigins? urlBlocklist?

    Properties

    backendUrl?: string

    The backend URL for the application.

    'https://pub.observability.app.launchdarkly.com'
    contextFriendlyName?: (context: LDContext) => undefined | 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.

    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;
    }

    Type declaration

      • (context: LDContext): undefined | string

      • Parameters

        • context: LDContext

          The context to get a friendly name for.

        Returns undefined | string

        The friendly name for the context, or undefined to use the default identifier.

    customHeaders?: Record<string, string>

    Custom headers to include with OTLP exports.

    debug?: boolean

    Debug mode - enables additional logging.

    false
    disableErrorTracking?: boolean

    Whether errors tracking is disabled.

    disableLogs?: boolean

    Whether logs are disabled.

    disableMetrics?: boolean

    Whether metrics are disabled.

    disableTraces?: boolean

    Whether traces are disabled.

    otlpEndpoint?: string

    The endpoint URL for the OTLP exporter.

    'https://otel.observability.app.launchdarkly.com:4318'
    resourceAttributes?: Attributes

    Additional resource attributes to include in telemetry data.

    serviceName?: string

    The service name for the application.

    'react-native-app'
    serviceVersion?: string

    The service version for the application.

    '1.0.0'
    sessionTimeout?: number

    Session timeout in milliseconds.

    30 * 60 * 1000 (30 minutes)
    tracingOrigins?: boolean | (string | RegExp)[]

    Specifies where the backend of the app lives. If specified, the SDK will attach tracing headers 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.

    tracingOrigins: ['localhost', /^//, 'backend.myapp.com']
    urlBlocklist?: string[]

    A list of URLs to block from tracing.

    urlBlocklist: ['localhost', 'backend.myapp.com']

    Settings

    Member Visibility

    On This Page

    Properties