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

Class: Summary<T>

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

A summary samples observations

Type parameters

Name	Type
T	extends string = string

Table of contents

Constructors

• constructor

Methods

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

Constructors

constructor

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

Type parameters

Name	Type
T	extends string = string

Parameters

Name	Type	Description
configuration	SummaryConfiguration<T>	Configuration when creating Summary metric. Name and Help is mandatory

Returns

Summary<T>

Defined in

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

Methods

get

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

Get summary metric object

Returns

Promise<MetricObjectWithValues<MetricValueWithName<T>>>

Defined in

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

---

labels

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

Return the child for given labels

Parameters

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

Returns

Internal<T>

Configured summary with given labels

Defined in

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

▸ 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:550

---

observe

▸ observe(value): void

Observe value in summary

Parameters

Name	Type	Description
value	number	The value to observe

Returns

void

Defined in

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

▸ 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	Value to observe

Returns

void

Defined in

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

---

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:556

▸ 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:562

---

reset

▸ reset(): void

Reset all values in the summary

Returns

void

Defined in

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

---

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 summary.

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

▸ (labels?): number

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

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

Defined in

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