Interface Summary

A tracked summary loosely based on the Summary interface exposed by the prom-client module

interface Summary {
    observe(value: number): void;
    reset(): void;
    timer(): StopTimer;
}

Index

Methods

observe reset timer

Methods

observe

observe(value: number): void
Observe the passed value
Parameters
- value: number
Returns void
- Defined in packages/interface/src/metrics.ts:248

reset

reset(): void
Reset this summary to its default value

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

timer

timer(): StopTimer
Start a timed metric, call the returned function to stop the timer

Returns StopTimer
- Defined in packages/interface/src/metrics.ts:259