core/io.github.klient.prometheus.core/Summary

Summary

class Summary : SimpleCollector<Summary.Child>

A Summary is a metric that provides statistical information about observed values, including quantiles.

This implementation supports quantiles, sum, count, and allows for time-based observation tracking.

Parameters

fullName

The full name of the summary metric.

help

A description of what the summary measures.

labelNames

Optional list of label names for the summary.

unit

Optional unit of measurement for the summary.

includeCreatedSeries

If true, also emits a _created series per label set.

quantiles

A list of Quantiles.Quantile to include in the summary.

maxAgeSeconds

The maximum age of observations in seconds. Defaults to 60.

ageBuckets

The number of buckets to divide the observation window into. Defaults to 5.

Types

Child

inner class Child

Represents a labeled child of the summary metric.

Timer

class Timer(child: Summary.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 set of metric samples.

get

fun get(): ValueSummary

getClassName

fun Collector.getClassName(): String

Returns the simple class name of the Collector instance.

labels

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

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

newChild

open override fun newChild(): Summary.Child

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

observe

suspend fun observe(value: Double)

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