RangeSampler

Instrument that tracks the behavior of a variable that can increase and decrease over time. A range sampler keeps track of the observed minimum and maximum values for the tracked variable and is constantly recording and resetting those indicators to the current variable value to get the most descriptive possible approximation of the behavior presented by the variable.

When a snapshot is taken, this instrument generates a distribution of values observed which is guaranteed to have the minimum and maximum values of the observed variable as well as several samples across time since the last snapshot.

Companion:
object
class Object
trait Matchable
class Any
class Atomic

Value members

Abstract methods

Decrements the current value by one.

Decrements the current value by one.

def decrement(times: Long): RangeSampler

Decrements the current value the provided number of times.

Decrements the current value the provided number of times.

Increments the current value by one.

Increments the current value by one.

def increment(times: Long): RangeSampler

Increments the current value the provided number of times.

Increments the current value the provided number of times.

Resets the minimum, maximum and current value indicators.

Resets the minimum, maximum and current value indicators.

Triggers the sampling of the internal minimum, maximum and current value indicators.

Triggers the sampling of the internal minimum, maximum and current value indicators.

Inherited methods

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

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.

Inherited from:
Instrument
def autoUpdate(consumer: Consumer[RangeSampler], interval: Duration): RangeSampler

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.

Inherited from:
Instrument
def autoUpdate(consumer: Consumer[RangeSampler]): RangeSampler

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.

Inherited from:
Instrument
def autoUpdate(consumer: RangeSampler => Unit, interval: Duration): RangeSampler

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.

Inherited from:
Instrument

Returns the metric to which this instrument belongs.

Returns the metric to which this instrument belongs.

Inherited from:
Instrument
def remove(): Boolean

Removes this instrument from the metric.

Removes this instrument from the metric.

Inherited from:
Instrument

Returns the tags used to create this instrument.

Returns the tags used to create this instrument.

Inherited from:
Instrument
override def withTag(key: String, value: Long): RangeSampler
Definition Classes
Inherited from:
Instrument
override def withTag(key: String, value: Boolean): RangeSampler
Definition Classes
Inherited from:
Instrument
override def withTag(key: String, value: String): RangeSampler
Definition Classes
Inherited from:
Instrument
override def withTags(tags: TagSet): RangeSampler
Definition Classes
Inherited from:
Instrument