Interface SummaryGroup<T>

A group of tracked summaries loosely based on the Summary interface exposed by the prom-client module

interface SummaryGroup<T> {
    observe(values): void;
    reset(): void;
    timer(key): StopTimer;
}

Type Parameters

T extends string = any

Index

Methods

observe reset timer

Methods

observe

observe(values): void
Observe the passed value for the named key in the group
Parameters
- values: Partial<Record<T, number>>
Returns void
- Defined in packages/interface/src/metrics/index.ts:270

reset

reset(): void
Reset the passed key in this summary group to its default value or all keys if no key is passed

Returns void
- Defined in packages/interface/src/metrics/index.ts:276

timer

timer(key): StopTimer
Start a timed metric for the named key in the group, call the returned function to stop the timer
Parameters
- key: string
Returns StopTimer
- Defined in packages/interface/src/metrics/index.ts:282