core/io.github.klient.prometheus.core/Collector

Collector

abstract class Collector(val fullName: String, val help: String, val labelNames: List<String> = emptyList(), val unit: String = "")

Abstract base class for all Prometheus metric collectors.

A collector gathers and exposes one or more MetricFamilySamples, representing the data for a specific metric (e.g., counters, gauges).

Inheritors

SimpleCollector

Constructors

Collector

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

Types

Companion

object Companion

MetricFamilySamples

class MetricFamilySamples(val name: String, val unit: String = "", val type: Collector.Type, val help: String, val samples: List<Collector.Sample>)

Represents a metric family and all of its associated Samples.

Sample

class Sample(val name: String, val labelNames: List<String>, val labelValues: List<String>, val value: Double, val timestamp: Long = getCurrentMillis())

Represents a single measurement of a metric.

Type

enum Type : Enum<Collector.Type>

Enum representing the types of Prometheus metrics.

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

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.

suspend fun register(registry: CollectorRegistry = CollectorRegistry.defaultRegistry): Collector

Registers this collector in the given CollectorRegistry.