t

nl.grons.metrics4.scala

InstrumentedBuilder

trait InstrumentedBuilder extends BaseBuilder

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
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. InstrumentedBuilder
  2. BaseBuilder
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def metricRegistry: MetricRegistry

    The MetricRegistry where created metrics are registered.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. 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
  13. lazy val metricBuilder: MetricBuilder
    Attributes
    protected
  14. def metrics: MetricBuilder

    The MetricBuilder that can be used for creating timers, counters, etc.

  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  19. def toString(): String
    Definition Classes
    AnyRef → Any
  20. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from BaseBuilder

Inherited from AnyRef

Inherited from Any

Ungrouped