Type Alias Options

Configuration options for the metrics library.

type Options = {
    appName: `${string}-${string}` | undefined;
    resolution: number;
    sampleIntervalInMs: number;
    webServerMetricsPort: number;
}

Properties

appName: `${string}-${string}` | undefined

The name of the application, formatted as ${string}-${string} (e.g., "service-order").

resolution: number

The resolution or granularity of the collected metrics.

sampleIntervalInMs: number

The interval, in milliseconds, at which samples are collected.

webServerMetricsPort: number

The port number on which the web server for metrics will listen.