prometheus-kotlin-client

core/io.github.klient.prometheus.core/CounterBuilder

CounterBuilder

class CounterBuilder : MetricBuilder<Counter>

Builder class for creating Counter metrics.

Counters represent cumulative values that increase over time (and may reset on restart).

Parameters

name

The metric name.

Functions

open override fun build(): Counter

Builds and returns the Counter instance.

fun help(help: String)

Sets the help description for the metric.

includeCreatedSeries

fun includeCreatedSeries(includeCreatedSeries: Boolean)

Configures whether the metric_created series should be included.

fun labelNames(vararg labelNames: String)

Sets the label names that this metric will use.

fun unit(unit: String)

Sets the unit of the metric.