Class HistogramInstrument

A histogram instrument that tracks distributions of values.

Index

Constructors

Methods

getStats record reset

Constructors

constructor

new HistogramInstrument(
    collector: SimpleMetricsCollector,
    name: string,
    description: string,
    unit?: string,
    buckets?: number[],
): HistogramInstrument
Parameters
- collector: SimpleMetricsCollector
- name: string
- description: string
- unit: string = ""
- buckets: number[] = ...
Returns HistogramInstrument
- Defined in libraries/helpers/src/otel/helpers/instruments.ts:135

Methods

getStats

getStats(): {
    avg: number;
    count: number;
    max: number;
    min: number;
    sum: number;
}
Get current statistics.

Returns { avg: number; count: number; max: number; min: number; sum: number }
- Defined in libraries/helpers/src/otel/helpers/instruments.ts:183

record

record(value: number, attributes?: Record<string, unknown>): void
Record an observation.
Parameters
- value: number
- attributes: Record<string, unknown> = {}
Returns void
- Defined in libraries/helpers/src/otel/helpers/instruments.ts:155

reset

reset(): void
Clear all observations (useful for testing).

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