class Histogram
extends MetricBase

Constructors

Histogram(
name: string,
config: MetricConfig,
buckets?: readonly number[]
)

Creates a new histogram.

Parameters
name: string

Metric name

config: MetricConfig

The metric configuration

optional
buckets: readonly number[]

Bucket boundaries (uses default if absent)

Properties

readonly
buckets: readonly number[]

The bucket boundaries.

Methods

getAllBucketCounts(): ReadonlyMap<
string,
{ buckets: ReadonlyMap<number, number>; sum: number; count: number; labels?: Readonly<Record<string, string>>; }
>

Gets all bucket counts for all observed label sets.

getBucketCounts(labels?: Readonly<Record<string, string>>): ReadonlyMap<number, number>

Gets the bucket counts for a label set.

getCount(labels?: Readonly<Record<string, string>>): number

Gets the count for a label set.

getSum(labels?: Readonly<Record<string, string>>): number

Gets the sum for a label set.

observe(
value: number,
labels?: Readonly<Record<string, string>>
): void

Records an observation.

Usage

import { Histogram } from "metrics-plugin/src/index.ts";