Interface MetricGroup<T>

A group of related metrics loosely based on the interfaces exposed by the prom-client module

interface MetricGroup<T extends string = any> {
    decrement(values: Partial<Record<T, number | true>>): void;
    increment(values: Partial<Record<T, number | true>>): void;
    reset(): void;
    timer(key: string): StopTimer;
    update(values: Partial<Record<T, number>>): void;
}

Type Parameters

T extends string = any

Index

Methods

decrement increment reset timer update

Methods

decrement

decrement(values: Partial<Record<T, number | true>>): void
Decrement the metric group keys by the passed number or true to decrement by 1
Parameters
- values: Partial<Record<T, number | true>>
Returns void
- Defined in packages/interface/src/metrics.ts:95

increment

increment(values: Partial<Record<T, number | true>>): void
Increment the metric group keys by the passed number or true to increment by 1
Parameters
- values: Partial<Record<T, number | true>>
Returns void
- Defined in packages/interface/src/metrics.ts:89

reset

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

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

timer

timer(key: string): 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.ts:107

update

update(values: Partial<Record<T, number>>): void
Update the stored metric group to the passed value
Parameters
- values: Partial<Record<T, number>>
Returns void
- Defined in packages/interface/src/metrics.ts:83