@shopify/cli-kit
    Preparing search index...

    Interface DefaultOtelServiceOptions

    interface DefaultOtelServiceOptions {
        env?: string;
        meterProvider?: MeterProvider;
        metrics?: MetricsConfig;
        onRecord?: OnRecordCallback;
        otelEndpoint: string;
        prefixMetric?: boolean;
        serviceName: string;
        throttleLimit?: number;
        useXhr?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    env? meterProvider? metrics? onRecord? otelEndpoint prefixMetric? serviceName throttleLimit? useXhr?

    Properties

    env?: string

    What environment is being deployed (production, staging).

    meterProvider?: MeterProvider

    Override the default meter provider.

    metrics?: MetricsConfig

    Metrics to register on startup.

    onRecord?: OnRecordCallback

    Called when a metric is recorded. addOnRecord can also be used to add listeners anytime.

    otelEndpoint: string
    prefixMetric?: boolean

    If this is set to true then the service name is prefixed to every metric.

    serviceName: string

    Service name is a unique name for an application/service.

    throttleLimit?: number

    How much the export should be throttled in milliseconds.

    useXhr?: boolean

    Determines whether to send metrics via XHR or beacon. Defaults to false.

    Settings

    Member Visibility

    On This Page

    Properties