InstrumentedBuilder

The mixin trait for creating a class which is instrumented with metrics.

Use it as follows:

object Application {
  // The application wide metrics registry.
  val metricRegistry = new com.codahale.metrics.MetricRegistry()
}
trait Instrumented extends InstrumentedBuilder {
  val metricRegistry = Application.metricRegistry
}

class Example(db: Database) extends Instrumented {
  private[this] val loading = metrics.timer("loading")

  def loadStuff(): Seq[Row] = loading.time {
    db.fetchRows()
  }
}

As an alternative to your own Instrumented as above, it is possible to use DefaultInstrumented instead.

By default metric names are prefixed with the name of the current class. You can override this metric base name. For example:

class Example(db: Database) extends Instrumented {
override lazy val metricBaseName = MetricName("Overridden.Base.Name")
private[this] val loading = metrics.timer("loading")

def loadStuff(): Seq[Row] = loading.time {
  db.fetchRows()
}
}

If you want to use hdrhistograms, you can override the metric builder as follows:

trait Instrumented extends InstrumentedBuilder {
override lazy protected val metricBuilder = new HdrMetricBuilder(metricBaseName, metricRegistry, false)
val metricRegistry = Application.metricRegistry
}

See the the manual for more instructions on using hdrhistogram.

Linear Supertypes

BaseBuilder, AnyRef, Any

Known Subclasses

DefaultInstrumented

Abstract Value Members

abstract val metricRegistry: MetricRegistry

The MetricRegistry where created metrics are registered.

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def ==(arg0: Any): Boolean

Definition Classes
Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
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
lazy val metricBaseName: MetricName

The base name for all metrics created from this builder.
The base name for all metrics created from this builder.

Definition Classes
BaseBuilder
lazy val metricBuilder: MetricBuilder

Attributes
protected
def metrics: MetricBuilder

The MetricBuilder that can be used for creating timers, counters, etc.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

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

trait InstrumentedBuilder extends BaseBuilder

Abstract Value Members

abstract val metricRegistry: MetricRegistry

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

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

lazy val metricBaseName: MetricName

lazy val metricBuilder: MetricBuilder

def metrics: MetricBuilder

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

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

Inherited from BaseBuilder

Inherited from AnyRef

Inherited from Any

Ungrouped