Meter

abstract class Meter(val name: String, var level: Level) : CollectorRegistry.Collector(source)

The Meter class serves as an abstract base class for creating different types of metering instruments such as Counters, UpDownCounters, and Gauges. It extends CollectorRegistry.Collector and provides specialized methods to create these instruments with specified names, units of measurement, and optional descriptions.

Parameters

name

The name of the meter.

level

The logging level for the meter.

Inheritors

SimpleMeter

Constructors

Meter

constructor(name: String, level: Level)

Creates an instance of Meter with the specified name and logging level.

Types

Companion

object Companion

Instrument

sealed class Instrument

Represents a base instrument used for recording various types of metric data. https://opentelemetry.io/docs/specs/otel/metrics/api/#meter

Timed

class Timed

A bundle of instruments used to time an operation: a call Instrument.Counter, an error Instrument.Counter, and a duration Instrument.Histogram. Obtain one via Meter.timed.

Properties

level

override var level: Level

levelBeforeMute

open override var levelBeforeMute: Level

name

override val name: String

Functions

counter

fun <T : Number> counter(name: String, unit: String? = null, description: String? = null): Meter.Instrument.Counter<T>

Creates a new counter-instrument with the specified name, unit, and description.

gauge

fun <T : Number> gauge(name: String, unit: String? = null, description: String? = null): Meter.Instrument.Gauge<T>

Creates a new gauge instrument with the specified name, unit, and description.

histogram

fun <T : Number> histogram(name: String, unit: String? = null, description: String? = null, boundaries: List<Double> = DEFAULT_HISTOGRAM_BUCKET_BOUNDARIES): Meter.Instrument.Histogram<T>

Creates a new histogram instrument with the specified name, unit, description, and bucket boundaries.

isMuted

open fun isMuted(): Boolean

mute

open fun mute()

Mutes the logger by setting its logging level to Level.OFF.

timed

fun timed(name: String, vararg tags: Pair<String, Any>): Meter.Timed

Returns a Timed bundle — a call counter, an error counter and a duration histogram — for the given base name and tags, creating (and caching) it on first use.

unmute

open fun unmute()

Reverts the logger to its previous logging level before it was muted.

upDownCounter

fun <T : Number> upDownCounter(name: String, unit: String? = null, description: String? = null): Meter.Instrument.UpDownCounter<T>

Creates a new up-down counter instrument with the specified name, unit, and description.