kamon-core/kamon.metric/Instrument

Instrument

trait Instrument[Inst <: Instrument[Inst, Sett], Sett <: Settings] extends Tagging[Inst]

Base user-facing API for all metric instruments in Kamon.

Companion:
object
trait Tagging[Inst]
class Object
trait Matchable
class Any
trait Counter
class LongAdder
trait Gauge
class Volatile
trait Histogram
class Atomic
class Atomic
trait Timer
class Atomic

Value members

Abstract methods

def autoUpdate(consumer: Inst => Unit, interval: Duration): Inst

Schedules a call to the provided consumer with a reference to this histogram as parameter, overriding the metric's auto-update interval.

Schedules a call to the provided consumer with a reference to this histogram as parameter, overriding the metric's auto-update interval.

def metric: Metric[Inst, Sett]

Returns the metric to which this instrument belongs.

Returns the metric to which this instrument belongs.

def tags: TagSet

Returns the tags used to create this instrument.

Returns the tags used to create this instrument.

Concrete methods

def autoUpdate(consumer: Consumer[Inst]): Inst

Schedules a call to the provided consumer with a reference to this histogram as parameter. The schedule uses the default auto-update interval. See the kamon.metric.instrument-factory configuration settings for more details.

Schedules a call to the provided consumer with a reference to this histogram as parameter. The schedule uses the default auto-update interval. See the kamon.metric.instrument-factory configuration settings for more details.

def autoUpdate(consumer: Consumer[Inst], interval: Duration): Inst

Schedules a call to the provided consumer with a reference to this histogram as parameter, overriding the metric's auto-update interval.

Schedules a call to the provided consumer with a reference to this histogram as parameter, overriding the metric's auto-update interval.

def autoUpdate(consumer: Inst => Unit): Inst

Schedules a call to the provided consumer with a reference to this histogram as parameter. The schedule uses the default auto-update interval. See the kamon.metric.instrument-factory configuration settings for more details.

Schedules a call to the provided consumer with a reference to this histogram as parameter. The schedule uses the default auto-update interval. See the kamon.metric.instrument-factory configuration settings for more details.

def remove(): Boolean

Removes this instrument from the metric.

Removes this instrument from the metric.

override def withTag(key: String, value: String): Inst
Definition Classes
override def withTag(key: String, value: Boolean): Inst
Definition Classes
override def withTag(key: String, value: Long): Inst
Definition Classes
override def withTags(tags: TagSet): Inst
Definition Classes