Class CounterInstrument

A counter instrument that tracks cumulative values.

Index

Constructors

Methods

add getValue reset

Constructors

constructor

new CounterInstrument(
    collector: SimpleMetricsCollector,
    name: string,
    description: string,
    unit?: string,
): CounterInstrument
Parameters
- collector: SimpleMetricsCollector
- name: string
- description: string
- unit: string = ""
Returns CounterInstrument
- Defined in libraries/helpers/src/otel/helpers/instruments.ts:16

Methods

add

add(value: number, attributes?: Record<string, unknown>): void
Add a value to the counter.
Parameters
- value: number
- attributes: Record<string, unknown> = {}
Returns void
- Defined in libraries/helpers/src/otel/helpers/instruments.ts:31

getValue

getValue(): number
Get the current value.

Returns number
- Defined in libraries/helpers/src/otel/helpers/instruments.ts:50

reset

reset(): void
Reset the counter (useful for testing).

Returns void
- Defined in libraries/helpers/src/otel/helpers/instruments.ts:57