Interface SummaryOptions

Create tracked metrics with these options. Loosely based on the interfaces exposed by the prom-client module

interface SummaryOptions {
    ageBuckets?: number;
    compressCount?: number;
    help?: string;
    label?: string;
    maxAgeSeconds?: number;
    percentiles?: number[];
    pruneAgedBuckets?: boolean;
}

Hierarchy (view full)

Properties

ageBuckets? compressCount? help? label? maxAgeSeconds? percentiles? pruneAgedBuckets?

Properties

Optional ageBuckets

ageBuckets?: number

Configure how many buckets in the sliding window

Optional compressCount

compressCount?: number

Control compression of data in t-digest

Optional help

help?: string

Optional help for the metric

Optional label

label?: string

Optional label for the metric

Optional maxAgeSeconds

maxAgeSeconds?: number

Configure how old a bucket can be before it is reset for sliding window

Optional percentiles

percentiles?: number[]

Percentiles for the summary

Optional pruneAgedBuckets

pruneAgedBuckets?: boolean

Remove entries without any new values in the last maxAgeSeconds

Settings

Member Visibility

Theme

On This Page

ageBucketscompressCounthelplabelmaxAgeSecondspercentilespruneAgedBuckets