BaseMetric

Instance Constructors

new BaseMetric(name: String, description: String, settings: Sett, instrumentBuilder: InstrumentBuilder[Inst, Sett, Snap], scheduler: ScheduledExecutorService)

Abstract Value Members

abstract def buildMetricSnapshot(metric: Metric[Inst, Sett], instruments: Seq[Snapshot[Snap]]): MetricSnapshot[Sett, Snap]

Attributes
protected
abstract def instrumentType: Type

Used by the Status API only
Used by the Status API only

Attributes
protected

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[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val 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.

Definition Classes
BaseMetric → Metric
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

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

Definition Classes
AnyRef → Any
def hashCode(): Int

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

Definition Classes
Any
val 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.

Definition Classes
BaseMetric → Metric
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
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.

Definition Classes
BaseMetric → Metric
def schedule(instrument: Inst, action: Runnable, interval: Duration): Any
val settings: Sett

Configuration settings that apply to all instruments of this metric.
Configuration settings that apply to all instruments of this metric.

Definition Classes
BaseMetric → Metric
def snapshot(resetState: Boolean): MetricSnapshot[Sett, Snap]

Creates a snapshot for a metric.
Creates a snapshot for a metric. If the resetState flag is set to true, the internal state of all instruments associated with this metric will be reset, if applicable.

Definition Classes
BaseMetric → Snapshotting
def status(): status.Status.Metric
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( ... )
final def wait(arg0: Long, arg1: Int): Unit

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

Definition Classes
AnyRef
Annotations
@throws( ... )
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
BaseMetric → Tagging
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
BaseMetric → Tagging
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
BaseMetric → Tagging
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
BaseMetric → Tagging
def withoutTags(): Inst

Returns an instrument without tags for this metric.
Returns an instrument without tags for this metric.

Definition Classes
BaseMetric → Metric

Related Doc: package Metric

abstract class BaseMetric[Inst <: Instrument[Inst, Sett], Sett <: Settings, Snap] extends Metric[Inst, Sett] with Snapshotting[Sett, Snap]

Instance Constructors

new BaseMetric(name: String, description: String, settings: Sett, instrumentBuilder: InstrumentBuilder[Inst, Sett, Snap], scheduler: ScheduledExecutorService)

Abstract Value Members

abstract def buildMetricSnapshot(metric: Metric[Inst, Sett], instruments: Seq[Snapshot[Snap]]): MetricSnapshot[Sett, Snap]

abstract def instrumentType: Type

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

val description: String

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

val name: String

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def remove(tags: TagSet): Boolean

def schedule(instrument: Inst, action: Runnable, interval: Duration): Any

val settings: Sett

def snapshot(resetState: Boolean): MetricSnapshot[Sett, Snap]

def status(): status.Status.Metric

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def withTag(key: String, value: Long): Inst

def withTag(key: String, value: Boolean): Inst

def withTag(key: String, value: String): Inst

def withTags(tags: TagSet): Inst

def withoutTags(): Inst

Inherited from Snapshotting[Sett, Snap]

Inherited from Metric[Inst, Sett]

Inherited from Tagging[Inst]

Inherited from AnyRef

Inherited from Any

Ungrouped