Trait/Object

kamon.metric

Metric

Related Docs: object Metric | package metric

Permalink

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

Describes a property of a system to be measured, and contains all the necessary information to create the actual instrument instances used to measure and record said property. Practically, a Metric can be seen as a group instruments that measure different dimensions (via tags) of the same property of the system.

All instruments belonging to a given metric share the same settings and only differ from each other by the unique combination of tags used to create them.

Linear Supertypes
Tagging[Inst], AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Metric
  2. Tagging
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def description: String

    Permalink

    Short, concise and human readable explanation of what is being measured by a metric.

  2. abstract def name: String

    Permalink

    A unique identifier for this metric.

    A unique identifier for this metric. Metric names typically will be namespaced, meaning that their name has a structure similar to that of a package name that describes what component is generating the metric. For example, metrics related to the JVM have the "jvm." prefix while metrics related to Akka Actors have the "akka.actor." prefix.

  3. abstract def remove(tags: TagSet): Boolean

    Permalink

    Removes an instrument with the provided tags from a metric, if it exists.

    Removes an instrument with the provided tags from a metric, if it exists. Returns true if the instrument existed and was removed or false if no instrument was found with the provided tags.

  4. abstract def settings: Sett

    Permalink

    Configuration settings that apply to all instruments of this metric.

  5. abstract 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
    Tagging
  6. abstract 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
    Tagging
  7. abstract 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
    Tagging
  8. abstract 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
    Tagging
  9. abstract def withoutTags(): Inst

    Permalink

    Returns an instrument without tags for this metric.

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 clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  10. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  11. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  13. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  14. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  15. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  16. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long): Unit

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

Inherited from Tagging[Inst]

Inherited from AnyRef

Inherited from Any

Ungrouped