@ralphschuler.prom metrics decorator.<internal>.Histogram

Class: Histogram<T>

@ralphschuler/prom-metrics-decorator.<internal>.Histogram

A histogram samples observations (usually things like request durations or response sizes) and counts them in configurable buckets

Type parameters

Name	Type
T	extends string = string

Table of contents

Constructors

• constructor

Methods

• get
• labels
• observe
• remove
• reset
• startTimer
• zero

Constructors

constructor

• new Histogram<T>(configuration): Histogram<T>

Type parameters

Name	Type
T	extends string = string

Parameters

Name	Type	Description
configuration	HistogramConfiguration<T>	Configuration when creating the Histogram. Name and Help is mandatory

Returns

Histogram<T>

Defined in

node_modules/prom-client/index.d.ts:399

Methods

get

▸ get(): Promise<MetricObjectWithValues<MetricValueWithName<T>>>

Get histogram metric object

Returns

Promise<MetricObjectWithValues<MetricValueWithName<T>>>

Defined in

node_modules/prom-client/index.d.ts:416

---

labels

▸ labels(...values): Internal<T>

Return the child for given labels

Parameters

Name	Type	Description
...values	string[]	Label values

Returns

Internal<T>

Configured histogram with given labels

Defined in

node_modules/prom-client/index.d.ts:442

▸ labels(labels): Internal<T>

Return the child for given labels

Parameters

Name	Type	Description
labels	Partial<Record<T, string | number>>	Object with label keys and values

Returns

Internal<T>

Configured counter with given labels

Defined in

node_modules/prom-client/index.d.ts:449

---

observe

▸ observe(value): void

Observe value

Parameters

Name	Type	Description
value	number	The value to observe

Returns

void

Defined in

node_modules/prom-client/index.d.ts:405

▸ observe(labels, value): void

Observe value for given labels

Parameters

Name	Type	Description
labels	Partial<Record<T, string | number>>	Object with label keys and values
value	number	The value to observe

Returns

void

Defined in

node_modules/prom-client/index.d.ts:411

---

remove

▸ remove(...values): void

Remove metrics for the given label values

Parameters

Name	Type	Description
...values	string[]	Label values

Returns

void

Defined in

node_modules/prom-client/index.d.ts:455

▸ remove(labels): void

Remove metrics for the given label values

Parameters

Name	Type	Description
labels	Partial<Record<T, string | number>>	Object with label keys and values

Returns

void

Defined in

node_modules/prom-client/index.d.ts:461

---

reset

▸ reset(): void

Reset histogram values

Returns

void

Defined in

node_modules/prom-client/index.d.ts:430

---

startTimer

▸ startTimer(labels?): (labels?: Partial<Record<T, string | number>>) => number

Start a timer. Calling the returned function will observe the duration in seconds in the histogram.

Parameters

Name	Type	Description
labels?	Partial<Record<T, string | number>>	Object with label keys and values

Returns

fn

Function to invoke when timer should be stopped. The value it returns is the timed duration.

▸ (labels?): number

Start a timer. Calling the returned function will observe the duration in seconds in the histogram.

Parameters

Name	Type	Description
labels?	Partial<Record<T, string | number>>	Object with label keys and values

Returns

number

Function to invoke when timer should be stopped. The value it returns is the timed duration.

Defined in

node_modules/prom-client/index.d.ts:425

---

zero

▸ zero(labels): void

Initialize the metrics for the given combination of labels to zero

Parameters

Name	Type
labels	Partial<Record<T, string | number>>

Returns

void

Defined in

node_modules/prom-client/index.d.ts:435