core/io.github.klient.prometheus.core/Gauge

Gauge

class Gauge : SimpleCollector<Gauge.Child>

A Gauge is a metric that represents a single numerical value that can go up and down.

Parameters

fullName

Full name of the metric.

help

Description of what the metric measures.

labelNames

List of label names.

unit

Optional unit of measurement.

clock

Clock used to set the current time as gauge value.

Types

Child

inner class Child

Represents a labeled child of the gauge metric.

Properties

fullName

val fullName: String

Full metric name (including any suffix or unit).

help

val help: String

Description of the metric, explaining what it measures.

labelNames

val labelNames: List<String>

List of label names associated with this metric (e.g., "method", "status").

name

open override val name: String

The base name of the metric (without unit suffix).

type

open override val type: Collector.Type

The metric type (e.g., counter, gauge).

unit

val unit: String

Unit of the metric (e.g., "seconds", "bytes").

Functions

clear

fun clear()

Removes all labeled child instances and resets the no-label child (if applicable).

collect

open override fun collect(): Collector.MetricFamilySamples

Collects all current samples from this gauge, across all label sets.

dec

suspend fun dec()

Decrements the unlabeled gauge by 1.

suspend fun dec(amount: Double)

Decrements the unlabeled gauge by a specific amount.

get

fun get(): Double

Returns the current value of the unlabeled gauge.

getClassName

fun Collector.getClassName(): String

Returns the simple class name of the Collector instance.

inc

suspend fun inc()

Increments the unlabeled gauge by 1.

suspend fun inc(amount: Double)

Increments the unlabeled gauge by a specific amount.

labels

fun labels(vararg labelValues: String): Gauge.Child

Retrieves or creates a Child associated with the given label values.

newChild

open override fun newChild(): Gauge.Child

Creates a new child instance. Called internally when a new label set is first seen.

suspend fun register(registry: CollectorRegistry = CollectorRegistry.defaultRegistry): Collector

Registers this collector in the given CollectorRegistry.

remove

fun remove(vararg labelValues: String)

Removes the child instance associated with the given label values.

set

suspend fun set(amount: Double)

Sets the unlabeled gauge to a specific value.

setDuration

suspend fun <T> Gauge.setDuration(block: () -> T): T

Measures the duration of a block and stores it in the unlabeled gauge.

setToCurrentTime

suspend fun setToCurrentTime()

Sets the unlabeled gauge to the current Unix time in seconds.

track

inline suspend fun <T> Gauge.track(block: () -> T): T

Increments the unlabeled gauge while the block is running, and decrements it when the block completes.