Histogram
Class: Histogram<T>
Defined in: node_modules/.pnpm/prom-client@15.1.3/node_modules/prom-client/index.d.ts:475
A histogram samples observations (usually things like request durations or response sizes) and counts them in configurable buckets
Type Parameters
T
T extends string = string
Constructors
Constructor
new Histogram<
T>(configuration):Histogram<T>
Defined in: node_modules/.pnpm/prom-client@15.1.3/node_modules/prom-client/index.d.ts:479
Parameters
configuration
HistogramConfiguration<T>
Configuration when creating the Histogram. Name and Help is mandatory
Returns
Histogram<T>
Methods
get()
get():
Promise<MetricObjectWithValues<MetricValueWithName<T>>>
Defined in: node_modules/.pnpm/prom-client@15.1.3/node_modules/prom-client/index.d.ts:502
Get histogram metric object
Returns
Promise<MetricObjectWithValues<MetricValueWithName<T>>>
labels()
Call Signature
labels(...
values):Internal<T>
Defined in: node_modules/.pnpm/prom-client@15.1.3/node_modules/prom-client/index.d.ts:541
Return the child for given labels
Parameters
values
...string[]
Label values
Returns
Internal<T>
Configured histogram with given labels
Call Signature
labels(
labels):Internal<T>
Defined in: node_modules/.pnpm/prom-client@15.1.3/node_modules/prom-client/index.d.ts:548
Return the child for given labels
Parameters
labels
LabelValues<T>
Object with label keys and values
Returns
Internal<T>
Configured counter with given labels
observe()
Call Signature
observe(
value):void
Defined in: node_modules/.pnpm/prom-client@15.1.3/node_modules/prom-client/index.d.ts:485
Observe value
Parameters
value
number
The value to observe
Returns
void
Call Signature
observe(
labels,value):void
Defined in: node_modules/.pnpm/prom-client@15.1.3/node_modules/prom-client/index.d.ts:491
Observe value for given labels
Parameters
labels
LabelValues<T>
Object with label keys and values
value
number
The value to observe
Returns
void
Call Signature
observe(
observeData):void
Defined in: node_modules/.pnpm/prom-client@15.1.3/node_modules/prom-client/index.d.ts:497
Observe with exemplars
Parameters
observeData
ObserveDataWithExemplar<T>
Object with labels, value and exemplars for an observation
Returns
void
remove()
Call Signature
remove(...
values):void
Defined in: node_modules/.pnpm/prom-client@15.1.3/node_modules/prom-client/index.d.ts:554
Remove metrics for the given label values
Parameters
values
...string[]
Label values
Returns
void
Call Signature
remove(
labels):void
Defined in: node_modules/.pnpm/prom-client@15.1.3/node_modules/prom-client/index.d.ts:560
Remove metrics for the given label values
Parameters
labels
LabelValues<T>
Object with label keys and values
Returns
void
reset()
reset():
void
Defined in: node_modules/.pnpm/prom-client@15.1.3/node_modules/prom-client/index.d.ts:529
Reset histogram values
Returns
void
startTimer()
Call Signature
startTimer(
labels?): (labels?) =>number
Defined in: node_modules/.pnpm/prom-client@15.1.3/node_modules/prom-client/index.d.ts:511
Start a timer. Calling the returned function will observe the duration in seconds in the histogram.
Parameters
labels?
LabelValues<T>
Object with label keys and values
Returns
Function to invoke when timer should be stopped. The value it returns is the timed duration.
(labels?) => number
Call Signature
startTimer(
labels?,exemplarLabels?): (labels?,exemplarLabels?) =>number
Defined in: node_modules/.pnpm/prom-client@15.1.3/node_modules/prom-client/index.d.ts:521
Start a timer with exemplar. Calling the returned function will observe the duration in seconds in the histogram.
Parameters
labels?
LabelValues<T>
Object with label keys and values
exemplarLabels?
LabelValues<T>
Object with label keys and values for exemplars
Returns
Function to invoke when timer should be stopped. The value it returns is the timed duration.
(labels?, exemplarLabels?) => number
zero()
zero(
labels):void
Defined in: node_modules/.pnpm/prom-client@15.1.3/node_modules/prom-client/index.d.ts:534
Initialize the metrics for the given combination of labels to zero
Parameters
labels
LabelValues<T>
Returns
void