core/io.github.klient.prometheus.core/Histogram

Histogram

class Histogram : SimpleCollector<Histogram.Child>

A histogram metric that tracks the distribution of values over a set of buckets.

Parameters

fullName

The full name of the histogram.

help

A description of the histogram's purpose.

labelNames

The names of the labels for the histogram.

unit

The unit of measurement for the histogram.

includeCreatedSeries

Whether to include a _created time series.

buckets

The bucket boundaries for the histogram.

Types

Child

inner class Child(buckets: List<Double>)

Represents a labeled instance of the histogram, allowing for operations on specific label sets.

Timer

class Timer(child: Histogram.Child, start: Long)

A utility class for measuring the duration of operations and recording the observed duration in the associated histogram.

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 the current metric samples for this histogram.

get

fun get(): ValueHistogram

Retrieves the current state of the histogram without labels.

getClassName

fun Collector.getClassName(): String

Returns the simple class name of the Collector instance.

labels

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

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

newChild

open override fun newChild(): Histogram.Child

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

observe

suspend fun observe(value: Double)

Observes a value and records it in the histogram without labels.

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.

time

suspend fun time(runnable: Runnable): Double

Starts a timer for measuring the duration of an operation without labels.