MetricsDirectiveFactory

Provides an entry point to creating metric accumulators specific to the Coda Hale Metrics library (http://metrics.codahale.com).

Overview

This trait is intended to be used to construct objects that provide spray.routing.Directives, which can then be used to instrument your spray.routing.Routes with metrics accumulators. You would create these instances, and then join them together however you like in order to ease how your code is instrumented.

Usage

import com.codahale.metrics.MetricRegistry

class MyApp extends Directives {
  val metricRegistry = new MetricRegistry()
  val metricFactory = CodaHaleMetricsDirectiveFactory(metricRegistry)

  // Creates a counter that measures failures only under the name of the
  // path to the current route
  val counter = metricFactory.counter.failures.noSuccesses.count

  // Creates a timer that measures everything under the name of the
  // path to the current route
  val timer = metricFactory.timer.time

  // Joins the two metrics into a single directive
  val measure = counter | timer

  val apiRoute =
    path("something") {
      measure {
        get {
          // do the thing
        }
      }
    }
}

Linear Supertypes

AnyRef, Any

Abstract Value Members

abstract val defaultMetricsActorFactory: MetricsActorFactory
abstract val metricsEventActor: ActorRef

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
def allCounter(counterPrefix: String): CounterMetric

Creates an instance of a CounterMetric with a specific prefix name that counts all types of events.
Creates an instance of a CounterMetric with a specific prefix name that counts all types of events.
counterPrefix
The prefix of the counter's identifier.
returns
The instance of the CounterMetric you can use to count events.
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def counter: CounterMetricByUri

Creates an instance of a CounterMetric that counts successes by default under an identifier unique to the path to the current route..
Creates an instance of a CounterMetric that counts successes by default under an identifier unique to the path to the current route..
returns
The instance of the CounterMetric you can use to count events.
def counter(counterPrefix: String): CounterMetric

Creates an instance of a CounterMetric with a specific prefix name that counts successes by default.
Creates an instance of a CounterMetric with a specific prefix name that counts successes by default.
counterPrefix
The prefix of the counter's identifier.
returns
The instance of the CounterMetric you can use to count events.
def counterWithMethod(counterPrefix: String): CounterMetric
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
def meter: MeterMetricByUri

Creates an instance of a MeterMetric that measures events with a name specific to the path to the current route.
Creates an instance of a MeterMetric that measures events with a name specific to the path to the current route.
returns
The instance of the MeterMetric you can use to measure events.
def meter(meterName: String): MeterMetric

Creates an instance of a MeterMetric that measures events with a specific name.
Creates an instance of a MeterMetric that measures events with a specific name.
meterName
The name of the meter in which measured events should be recorded.
returns
The instance of the MeterMetric you can use to measure events.
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 timer: TimerMetricByUri

Creates an instance of a TimerMetric that measures events with a name specific to the path to the current route.
Creates an instance of a TimerMetric that measures events with a name specific to the path to the current route.
returns
The instance of the TimerMetric you can use to measure events.
def timer(timerName: String): TimerMetric

Creates an instance of a TimerMetric that measures events with a specific name.
Creates an instance of a TimerMetric that measures events with a specific name.
timerName
The name of the timer in which measured events should be recorded.
returns
The instance of the TimerMetric you can use to measure events.
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 MetricsDirectiveFactory extends AnyRef

Overview

Usage

Abstract Value Members

abstract val defaultMetricsActorFactory: MetricsActorFactory

abstract val metricsEventActor: ActorRef

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def allCounter(counterPrefix: String): CounterMetric

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def counter: CounterMetricByUri

def counter(counterPrefix: String): CounterMetric

def counterWithMethod(counterPrefix: String): CounterMetric

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

def meter: MeterMetricByUri

def meter(meterName: String): MeterMetric

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

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

def timer: TimerMetricByUri

def timer(timerName: String): TimerMetric

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped