FutureMetrics

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[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( ... )

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[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( classOf[java.lang.Throwable] )

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

   

   Definition Classes

   AnyRef → Any

10. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

11. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

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

    

    Definition Classes

    AnyRef

13. final def notify(): Unit

    

    Definition Classes

    AnyRef

14. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

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

    

    Definition Classes

    AnyRef

16. def timed[A](metricName: String)(action: ⇒ A)(implicit context: ExecutionContext): Future[A]

    

    Creates a future that executes the given action and times it.

    Creates a future that executes the given action and times it.

    Use it as follows:

    object Application {
      // The application wide metrics registry.
      val metricRegistry = new com.codahale.metrics.MetricRegistry()
    }
    trait Instrumented extends InstrumentedBuilder with FutureMetrics {
      val metricRegistry = Application.metricRegistry
    }
    
    case class Row(record: Map[String,Any])
    
    trait SynchronousDb {
      def fetchRows(): Seq[Row]
    }
    
    class Example(db: Database) extends Instrumented {
      import scala.concurrent._
      import ExecutionContext.Implicits.global
    
      def loadStuffEventually()(implicit db: SynchronousDb): Future[Seq[Row]] = timed("loading") {
        db.fetchRows()
      }
    }

17. def timing[A](metricName: String)(future: ⇒ Future[A])(implicit context: ExecutionContext): Future[A]

    

    Starts a timer that stops when the given future completes.

    Starts a timer that stops when the given future completes.

    An important point is that the timer does not measure the exact execution time of the future, unlike timed. The future might not have been scheduled, or it could have been completed the moment timing is called. The onComplete listener also needs to be scheduled. If you need exact timings, please make sure to use a timer inside the future's execution.

    Use it as follows:

    object Application {
      // The application wide metrics registry.
      val metricRegistry = new com.codahale.metrics.MetricRegistry()
    }
    trait Instrumented extends InstrumentedBuilder with FutureMetrics {
      val metricRegistry = Application.metricRegistry
    }
    
    case class Row(record: Map[String,Any])
    
    trait AsynchronousDb {
      def fetchRows(): Future[Seq[Row]]
    }
    
    class Example(db: Database) extends Instrumented {
      import scala.concurrent._
      import ExecutionContext.Implicits.global
    
      def loadStuffEventually()(implicit db: AsynchronousDb): Future[Seq[Row]] = timing("loading") {
        db.fetchRows()
      }
    }

18. def toString(): String

    

    Definition Classes

    AnyRef → Any

19. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )