class Summary
extends MetricBase

Constructors

Summary(
name: string,
config: MetricConfig,
quantiles?: readonly number[],
maxSamples?: number
)

Creates a new summary.

Parameters
name: string

Metric name

config: MetricConfig

The metric configuration

optional
quantiles: readonly number[]

Quantiles to compute (defaults to [0.5, 0.9, 0.99])

optional
maxSamples: number

Maximum samples to retain (defaults to 512)

Properties

readonly
quantiles: readonly number[]

The quantiles.

Methods

getAllQuantiles(): ReadonlyMap<
string,
{ quantiles: ReadonlyMap<number, number>; sum: number; count: number; labels?: Readonly<Record<string, string>>; }
>

Gets all quantile data for all observed label sets.

getCount(labels?: Readonly<Record<string, string>>): number

Gets the count for a label set.

getQuantiles(labels?: Readonly<Record<string, string>>): ReadonlyMap<number, number>

Gets the quantile values for a label set.

getSampleCount(labels?: Readonly<Record<string, string>>): number

Gets the current sample window size.

getSum(labels?: Readonly<Record<string, string>>): number

Gets the sum for a label set.

observe(
value: number,
labels?: Readonly<Record<string, string>>
): void

Records an observation.

Usage

import { Summary } from "metrics-plugin/src/index.ts";