Gauge
Class: Gauge<T>
Defined in: node_modules/.pnpm/prom-client@15.1.3/node_modules/prom-client/index.d.ts:334
A gauge is a metric that represents a single numerical value that can arbitrarily go up and down.
Type Parameters
T
T extends string = string
Constructors
Constructor
new Gauge<
T>(configuration):Gauge<T>
Defined in: node_modules/.pnpm/prom-client@15.1.3/node_modules/prom-client/index.d.ts:338
Parameters
configuration
GaugeConfiguration<T>
Configuration when creating a Gauge metric. Name and Help is mandatory
Returns
Gauge<T>
Methods
dec()
Call Signature
dec(
labels,value?):void
Defined in: node_modules/.pnpm/prom-client@15.1.3/node_modules/prom-client/index.d.ts:358
Decrement gauge
Parameters
labels
LabelValues<T>
Object with label keys and values
value?
number
Value to decrement with
Returns
void
Call Signature
dec(
value?):void
Defined in: node_modules/.pnpm/prom-client@15.1.3/node_modules/prom-client/index.d.ts:364
Decrement gauge
Parameters
value?
number
The value to decrement with
Returns
void
get()
get():
Promise<MetricObjectWithValues<MetricValue<T>>>
Defined in: node_modules/.pnpm/prom-client@15.1.3/node_modules/prom-client/index.d.ts:382
Get gauge metric object
Returns
Promise<MetricObjectWithValues<MetricValue<T>>>
inc()
Call Signature
inc(
labels,value?):void
Defined in: node_modules/.pnpm/prom-client@15.1.3/node_modules/prom-client/index.d.ts:345
Increment gauge for given labels
Parameters
labels
LabelValues<T>
Object with label keys and values
value?
number
The value to increment with
Returns
void
Call Signature
inc(
value?):void
Defined in: node_modules/.pnpm/prom-client@15.1.3/node_modules/prom-client/index.d.ts:351
Increment gauge
Parameters
value?
number
The value to increment with
Returns
void
labels()
Call Signature
labels(...
values):Internal<T>
Defined in: node_modules/.pnpm/prom-client@15.1.3/node_modules/prom-client/index.d.ts:404
Return the child for given labels
Parameters
values
...string[]
Label values
Returns
Internal<T>
Configured gauge 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:411
Return the child for given labels
Parameters
labels
LabelValues<T>
Object with label keys and values
Returns
Internal<T>
Configured counter with given labels
remove()
Call Signature
remove(...
values):void
Defined in: node_modules/.pnpm/prom-client@15.1.3/node_modules/prom-client/index.d.ts:422
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:428
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:416
Reset gauge values
Returns
void
set()
Call Signature
set(
labels,value):void
Defined in: node_modules/.pnpm/prom-client@15.1.3/node_modules/prom-client/index.d.ts:371
Set gauge value for labels
Parameters
labels
LabelValues<T>
Object with label keys and values
value
number
The value to set
Returns
void
Call Signature
set(
value):void
Defined in: node_modules/.pnpm/prom-client@15.1.3/node_modules/prom-client/index.d.ts:377
Set gauge value
Parameters
value
number
The value to set
Returns
void
setToCurrentTime()
setToCurrentTime(
labels?):void
Defined in: node_modules/.pnpm/prom-client@15.1.3/node_modules/prom-client/index.d.ts:388
Set gauge value to current epoch time in seconds
Parameters
labels?
LabelValues<T>
Object with label keys and values
Returns
void
startTimer()
startTimer(
labels?): (labels?) =>number
Defined in: node_modules/.pnpm/prom-client@15.1.3/node_modules/prom-client/index.d.ts:397
Start a timer. Calling the returned function will set the gauge's value to the observed duration in seconds.
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