Trait

nl.grons.metrics4.scala

InstrumentedBuilder

Related Doc: package scala

Permalink

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

    Permalink

    The MetricRegistry where created metrics are registered.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @throws( ... )

  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  8. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()

  9. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()

  10. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  11. lazy val metricBaseName: MetricName

    Permalink

    The base name for all metrics created from this builder.

    The base name for all metrics created from this builder.

    Definition Classes
    BaseBuilder

  12. lazy val metricBuilder: MetricBuilder

    Permalink
    Attributes
    protected

  13. def metrics: MetricBuilder

    Permalink

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

  14. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  15. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()

  16. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()

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

    Permalink
    Definition Classes
    AnyRef

  18. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  20. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  21. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from BaseBuilder

Inherited from AnyRef

Inherited from Any

Ungrouped