trait Timer extends Instrument[Timer, ForDistributionInstrument]

Instrument that tracks the distribution of latency values within a configured range and precision. Timers are just a special case of histograms that provide special APIs dedicated to recording latency measurements.

Linear Supertypes
Instrument[Timer, ForDistributionInstrument], Tagging[Timer], AnyRef, Any
Known Subclasses
Atomic
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Timer
  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: (Timer) ⇒ Unit, interval: Duration): Timer

    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 metric: Metric[Timer, ForDistributionInstrument]

    Returns the metric to which this instrument belongs.

    Returns the metric to which this instrument belongs.

    Definition Classes
    Instrument
  3. abstract def record(elapsed: Long, unit: TimeUnit): Timer

    Records one occurrence of the provided duration.

    Records one occurrence of the provided duration. Keep in mind that the provided value will not be recorded as-is on the resulting Histogram but will be rather adjusted to a bucket within the configured precision. By default, all Kamon histograms are configured to achieve up to 1% error margin across the entire range.

  4. abstract def record(duration: Duration): Timer

    Records one occurrence of the provided duration.

    Records one occurrence of the provided duration. Keep in mind that the provided value will not be recorded as-is on the resulting Histogram but will be rather adjusted to a bucket within the configured precision. By default, all Kamon histograms are configured to achieve up to 1% error margin across the entire range.

  5. abstract def record(nanos: Long): Timer

    Records one occurrence of the provided latency value.

    Records one occurrence of the provided latency value. Keep in mind that the provided value will not be recorded as-is on the resulting Histogram but will be rather adjusted to a bucket within the configured precision. By default, all Kamon histograms are configured to achieve up to 1% error margin across the entire range.

  6. abstract def start(): Started

    Starts counting elapsed time from the instant this method is called and until the returned Timer.Started instance is stopped.

  7. abstract def tags: TagSet

    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
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def autoUpdate(consumer: (Timer) ⇒ Unit): Timer

    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[Timer], interval: Duration): Timer

    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[Timer]): Timer

    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
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  11. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. def remove(): Boolean

    Removes this instrument from the metric.

    Removes this instrument from the metric.

    Definition Classes
    Instrument
  19. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  20. def toString(): String
    Definition Classes
    AnyRef → Any
  21. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  24. def withTag(key: String, value: Long): Timer

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

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

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

    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[Timer, ForDistributionInstrument]

Inherited from Tagging[Timer]

Inherited from AnyRef

Inherited from Any

Ungrouped