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.
- Alphabetic
- By Inheritance
- Metric
- Tagging
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def description: String
Short, concise and human readable explanation of what is being measured by a metric.
- abstract def name: String
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.
- abstract def remove(tags: TagSet): Boolean
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.
- abstract def settings: Sett
Configuration settings that apply to all instruments of this metric.
- abstract def withTag(key: String, value: Long): Inst
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
- abstract def withTag(key: String, value: Boolean): Inst
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
- abstract def withTag(key: String, value: String): Inst
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
- abstract def withTags(tags: TagSet): Inst
Returns an instrument with additional tags from the provided TagSet.
Returns an instrument with additional tags from the provided TagSet.
- Definition Classes
- Tagging
- abstract def withoutTags(): Inst
Returns an instrument without tags for this metric.
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()