Trait/Object

kamon.metric

RangeSampler

Related Docs: object RangeSampler | package metric

Permalink

trait RangeSampler extends Instrument[RangeSampler, ForDistributionInstrument]

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.

Linear Supertypes
Instrument[RangeSampler, ForDistributionInstrument], Tagging[RangeSampler], AnyRef, Any
Known Subclasses
Atomic
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RangeSampler
  2. Instrument
  3. Tagging
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def autoUpdate(consumer: (RangeSampler) ⇒ Unit, interval: Duration): RangeSampler

    Permalink

    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.

    Definition Classes
    Instrument

  2. abstract def decrement(times: Long): RangeSampler

    Permalink

    Decrements the current value the provided number of times.

  3. abstract def decrement(): RangeSampler

    Permalink

    Decrements the current value by one.

  4. abstract def increment(times: Long): RangeSampler

    Permalink

    Increments the current value the provided number of times.

  5. abstract def increment(): RangeSampler

    Permalink

    Increments the current value by one.

  6. abstract def metric: Metric[RangeSampler, ForDistributionInstrument]

    Permalink

    Returns the metric to which this instrument belongs.

    Returns the metric to which this instrument belongs.

    Definition Classes
    Instrument

  7. abstract def sample(): RangeSampler

    Permalink

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

  8. abstract def tags: TagSet

    Permalink

    Returns the tags used to create this instrument.

    Returns the tags used to create this instrument.

    Definition Classes
    Instrument

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. def autoUpdate(consumer: (RangeSampler) ⇒ Unit): RangeSampler

    Permalink

    Schedules a call to the provided consumer with a reference to this histogram as parameter.

    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.

    Definition Classes
    Instrument

  6. def autoUpdate(consumer: Consumer[RangeSampler], interval: Duration): RangeSampler

    Permalink

    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.

    Definition Classes
    Instrument

  7. def autoUpdate(consumer: Consumer[RangeSampler]): RangeSampler

    Permalink

    Schedules a call to the provided consumer with a reference to this histogram as parameter.

    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.

    Definition Classes
    Instrument

  8. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  9. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  10. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  11. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  12. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  13. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  14. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  15. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  16. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  17. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  18. def remove(): Boolean

    Permalink

    Removes this instrument from the metric.

    Removes this instrument from the metric.

    Definition Classes
    Instrument

  19. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  20. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  21. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  22. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  23. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  24. def withTag(key: String, value: Long): RangeSampler

    Permalink

    Returns an instrument with one additional tag defined by the provided key and value pair.

    Returns an instrument with one additional tag defined by the provided key and value pair.

    Definition Classes
    Instrument → Tagging

  25. def withTag(key: String, value: Boolean): RangeSampler

    Permalink

    Returns an instrument with one additional tag defined by the provided key and value pair.

    Returns an instrument with one additional tag defined by the provided key and value pair.

    Definition Classes
    Instrument → Tagging

  26. def withTag(key: String, value: String): RangeSampler

    Permalink

    Returns an instrument with one additional tag defined by the provided key and value pair.

    Returns an instrument with one additional tag defined by the provided key and value pair.

    Definition Classes
    Instrument → Tagging

  27. def withTags(tags: TagSet): RangeSampler

    Permalink

    Returns an instrument with additional tags from the provided TagSet.

    Returns an instrument with additional tags from the provided TagSet.

    Definition Classes
    Instrument → Tagging

Inherited from Instrument[RangeSampler, ForDistributionInstrument]

Inherited from Tagging[RangeSampler]

Inherited from AnyRef

Inherited from Any

Ungrouped