Interface MetricsOptions

Configuration options for metrics collection. Extends the base metrics configuration with optional parameters.

MetricsOptions

interface MetricsOptions {
    attributes?: Attributes;
    debug?: boolean;
    hostname?: string;
    isEnabled?: boolean;
    sendInterval?: number;
    serviceName?: string;
    serviceVersion?: string;
    url?: string;
}

Hierarchy

  • Partial<MetricsConfig>
    • MetricsOptions

Properties

attributes? debug? hostname? isEnabled? sendInterval? serviceName? serviceVersion? url?

Properties

Optionalattributes

attributes?: Attributes

Optional attributes to be associated with the metrics.

Optionaldebug

debug?: boolean

Specifies whether to enable debug mode for metrics. Debug mode will enable the opentelemetry debug log and log metrics to the console.

Optionalhostname

hostname?: string

The value of the hostname attribute to use, will override the hostname.

OptionalisEnabled

isEnabled?: boolean

Specifies whether metrics is enabled.

OptionalsendInterval

sendInterval?: number

The interval in milliseconds to send the metrics.

OptionalserviceName

serviceName?: string

The name of the service to put as attribute. By default will be read from the package.json file.

OptionalserviceVersion

serviceVersion?: string

The version of the service to put as attribute. By default will be read from the package.json file.

Optionalurl

url?: string

The URL to an HTTP OTLP endpoint to send the metrics to.

Settings

Member Visibility

On This Page

Properties