Interface CalculatedSummaryOptions<T>

Create tracked metrics that are expensive to calculate by passing a function that is only invoked when metrics are being scraped

interface CalculatedSummaryOptions<T> {
    ageBuckets?: number;
    calculate: CalculateMetric<T>;
    compressCount?: number;
    help?: string;
    label?: string;
    maxAgeSeconds?: number;
    percentiles?: number[];
    pruneAgedBuckets?: boolean;
}

Type Parameters

  • T = number

Hierarchy (view full)

Properties

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

Properties

Optional ageBuckets

ageBuckets?: number

Configure how many buckets in the sliding window

calculate

calculate: CalculateMetric<T>

An optional function invoked to calculate the component metric instead of using .observe

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

ageBucketscalculatecompressCounthelplabelmaxAgeSecondspercentilespruneAgedBuckets