Timer

User-facing API for a Timer-based metric. All Kamon APIs returning a Timer-based metric to users should always return this interface rather than internal representations.

trait Tagging[Timer]
class Object
trait Matchable
class Any

Value members

Inherited methods

def description: String

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

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

Inherited from:
Metric
def name: String

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.

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.

Inherited from:
Metric
def remove(tags: TagSet): Boolean

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.

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.

Inherited from:
Metric

Configuration settings that apply to all instruments of this metric.

Configuration settings that apply to all instruments of this metric.

Inherited from:
Metric
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.

Inherited from:
Tagging
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.

Inherited from:
Tagging
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.

Inherited from:
Tagging
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.

Inherited from:
Tagging

Returns an instrument without tags for this metric.

Returns an instrument without tags for this metric.

Inherited from:
Metric