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

Class: Registry

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

Container for all registered metrics

Table of contents

Constructors

• constructor

Properties

• contentType

Methods

• clear
• getMetricsAsArray
• getMetricsAsJSON
• getSingleMetric
• getSingleMetricAsString
• metrics
• registerMetric
• removeSingleMetric
• resetMetrics
• setDefaultLabels
• merge

Constructors

constructor

• new Registry(): Registry

Returns

Registry

Properties

contentType

• contentType: string

Gets the Content-Type of the metrics for use in the response headers.

Defined in

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

Methods

clear

▸ clear(): void

Remove all metrics from the registry

Returns

void

Defined in

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

---

getMetricsAsArray

▸ getMetricsAsArray(): MetricObject[]

Get all metrics as objects

Returns

MetricObject[]

Defined in

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

---

getMetricsAsJSON

▸ getMetricsAsJSON(): Promise<MetricObjectWithValues<MetricValue<string>>[]>

Get all metrics as objects

Returns

Promise<MetricObjectWithValues<MetricValue<string>>[]>

Defined in

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

---

getSingleMetric

▸ getSingleMetric<T>(name): undefined | Metric<T>

Get a single metric

Type parameters

Name	Type
T	extends string

Parameters

Name	Type	Description
name	string	The name of the metric

Returns

undefined | Metric<T>

Defined in

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

---

getSingleMetricAsString

▸ getSingleMetricAsString(name): Promise<string>

Get a string representation of a single metric by name

Parameters

Name	Type	Description
name	string	The name of the metric

Returns

Promise<string>

Defined in

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

---

metrics

▸ metrics(): Promise<string>

Get string representation for all metrics

Returns

Promise<string>

Defined in

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

---

registerMetric

▸ registerMetric<T>(metric): void

Register metric to register

Type parameters

Name	Type
T	extends string

Parameters

Name	Type	Description
metric	Metric<T>	Metric to add to register

Returns

void

Defined in

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

---

removeSingleMetric

▸ removeSingleMetric(name): void

Remove a single metric

Parameters

Name	Type	Description
name	string	The name of the metric to remove

Returns

void

Defined in

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

---

resetMetrics

▸ resetMetrics(): void

Reset all metrics in the registry

Returns

void

Defined in

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

---

setDefaultLabels

▸ setDefaultLabels(labels): void

Set static labels to every metric emitted by this registry

Parameters

Name	Type	Description
labels	Object	of name/value pairs: { defaultLabel: "value", anotherLabel: "value 2" }

Returns

void

Defined in

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

---

merge

▸ merge(registers): Registry

Merge registers

Parameters

Name	Type	Description
registers	Registry[]	The registers you want to merge together

Returns

Registry

Defined in

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