Interface MetricsPolicyOptions

Option specification for MetricsPolicy class values.

interface MetricsPolicyOptions {
    interval?: number;
    latencyColumns?: number;
    latencyShift?: number;
    metricsListeners?: MetricsListeners;
    reportDir?: string;
    reportSizeLimit?: number;
}

Properties

interval?: number

Number of cluster tend iterations between metrics notification events. One tend iteration is defined as "tend_interval" in the client config plus the time to tend all nodes.

latencyColumns?: number

Number of elapsed time range buckets in latency histograms.

latencyShift?: number

Power of 2 multiple between each range bucket in latency histograms starting at column 3. The bucket units are in milliseconds. The first 2 buckets are “<=1ms” and “>1ms”.

metricsListeners?: MetricsListeners

Listeners that handles metrics notification events. If set to None, the default listener implementation will be used, which writes the metrics snapshot to a file which can later be read and forwarded to OpenTelemetry by a separate offline application. Otherwise, use all listeners set in the class instance. The listener could be overridden to send the metrics snapshot directly to OpenTelemetry.

reportDir?: string

Directory path to write metrics log files for listeners that write logs.

reportSizeLimit?: number

Metrics file size soft limit in bytes for listeners that write logs. When report_size_limit is reached or exceeded, the current metrics file is closed and a new metrics file is created with a new timestamp. If report_size_limit is zero, the metrics file size is unbounded and the file will only be closed when disable_metrics() or close() is called.

MMNEPVFCICPMFPCPTTAAATR