Trait/Object

kamon.metric

Instrument

Related Docs: object Instrument | package metric

Permalink

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

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

Linear Supertypes
Tagging[Inst], AnyRef, Any
Known Subclasses
Atomic, Atomic, Atomic, Counter, Gauge, Histogram, LongAdder, RangeSampler, Timer, Volatile
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Instrument
  2. Tagging
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

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

    Permalink

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

  2. abstract def metric: Metric[Inst, Sett]

    Permalink

    Returns the metric to which this instrument belongs.

  3. abstract def tags: TagSet

    Permalink

    Returns the tags used to create this 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: (Inst) ⇒ Unit): Inst

    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.

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

    Permalink

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

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

    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.

  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.

  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): Inst

    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): Inst

    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): Inst

    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): Inst

    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 Tagging[Inst]

Inherited from AnyRef

Inherited from Any

Ungrouped