Interface DefaultOtelServiceOptions

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

Hierarchy (view full)

Properties

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

Properties

Optional env

env?: string

What environment is being deployed (production, staging)

Optional meterProvider

meterProvider?: MeterProvider

Override the default meter provider.

Optional metrics

metrics?: MetricsConfig

Metrics to register on startup.

Optional onRecord

onRecord?: OnRecordCallback

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

otelEndpoint

otelEndpoint: string

Optional prefixMetric

prefixMetric?: boolean

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

serviceName

serviceName: string

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

Optional throttleLimit

throttleLimit?: number

How much the export should be throttled in milliseconds.

Optional useXhr

useXhr?: boolean

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

Settings

Member Visibility

Theme

On This Page

envmeterProvidermetricsonRecordotelEndpointprefixMetricserviceNamethrottleLimituseXhr