core/io.github.klient.prometheus.core/Counter

Counter

class Counter : SimpleCollector<Counter.Child>

A Counter is a metric that only increases (monotonically), typically used for counting occurrences.

This implementation supports optional creation of a _created time series and allows for use with and without labels.

Parameters

fullName

The full name of the metric.

help

Help text describing what the counter measures.

labelNames

List of label names for this counter.

unit

The unit of the metric (e.g., "meters", "seconds").

includeCreatedSeries

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

Types

Child

inner class Child

Represents a labeled child of the counter 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.

includeCreatedSeries

val includeCreatedSeries: Boolean = false

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 counter.

countExceptions

suspend fun <T> Counter.countExceptions(vararg exceptionTypes: KClass<out Throwable>, block: () -> T): T?

Executes the given block and increments the counter if an exception of the specified types is thrown.

get

fun get(): Double

Retrieves the current value of the counter.

getClassName

fun Collector.getClassName(): String

Returns the simple class name of the Collector instance.

inc

suspend fun inc(): Unit?

Increments the counter by 1.

suspend fun inc(amount: Double): Unit?

Increments the counter by the specified amount.

labels

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

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

newChild

open override fun newChild(): Counter.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.