0.32.0

log4k/io.github.smyrgeorge.log4k/Meter

Meter

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

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

Constructors

constructor(name: String, level: Level)

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

Types

object Companion

sealed class Instrument

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

Properties

override var level: Level

levelBeforeMute

open override var levelBeforeMute: Level

override val name: String

Functions

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.

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.

open fun isMuted(): Boolean

open fun mute()

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

open fun unmute()

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

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.