core/io.github.klient.prometheus.core/SimpleCollector

SimpleCollector

abstract class SimpleCollector<Child>(val fullName: String, val help: String, val labelNames: List<String>, val unit: String) : Collector

Abstract base class for Prometheus metric types that support labeled children.

This class provides common functionality for metric types like Counter and Gauge, including label management, child instance tracking, and sample collection.

Parameters

Child

The type of the labeled metric child (e.g., Counter.Child, Gauge.Child).

fullName

The full metric name (including suffix, if applicable).

help

A human-readable description of the metric's purpose.

labelNames

The list of label names (must be valid Prometheus identifiers).

unit

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

Inheritors

Constructors

SimpleCollector

constructor(fullName: String, help: String, labelNames: List<String>, unit: String)

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

abstract val name: String

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

type

abstract 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

abstract fun collect(): Collector.MetricFamilySamples

Collects the current set of metric samples.

getClassName

fun Collector.getClassName(): String

Returns the simple class name of the Collector instance.

labels

fun labels(vararg labelValues: String): Child

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

newChild

abstract fun newChild(): 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.