Packages

  • package root
    Definition Classes
    root
  • package org
    Definition Classes
    root
  • package dmonix
    Definition Classes
    org
  • package prometheus

    Adds a Scala layer on the official [Prometheus Java client](https://github.com/prometheus/client_java) library.

    Adds a Scala layer on the official [Prometheus Java client](https://github.com/prometheus/client_java) library. The purpose is to elevate on the capabilities of the Scala language and provide more fitting constructs. E.g. lambdas from Java don't translate very well into Scala, so this library provides functional approaches to where the original library uses lambdas. Also for time/latency/gauge measurement purposes this library provides means to measure Futures.

    E.g. measuring the time spent in a function block.

    val requestLatency:Histogram = ...
val result = requestLatency.measure{
  // Your code here.
}

    Or measuring the time to execute a future provided as result by a function. The code snippet below will measure the time from invoking the function block to when the future is completed

    val requestLatency:Histogram = ...
val f:Future[_] = requestLatency.measureAsync{
  Future {
    // Your code here.
  }
}
    Definition Classes
    dmonix
  • CounterImplicits
  • Counters
  • GaugeImplicits
  • Gauges
  • HistogramImplicits
  • Histograms
  • Implicits
  • Summaries
  • SummaryImplicits
  • TimeUnitImplicits
o

org.dmonix.prometheus

Histograms

object Histograms

Holds functions related to 'Histograms'

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Histograms
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

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() @HotSpotIntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. def measure[T](histogram: Child, unit: TimeUnit)(block: ⇒ T): T

    Measures the time it takes to execute the provided block of code.

    Measures the time it takes to execute the provided block of code.

    val histogram:Histogram.Child = ...
val res = Histograms.measure(histogram, TimeUnit.SECONDS){
  //code goes here
}
    histogram

    The histogram to use

    unit

    The timeunit to use when registering the duration

    block

    The block of code to execute/measure

    returns

    The result created from the provided function block

    Since

    1.0

  12. def measure[T](histogram: Histogram, unit: TimeUnit)(block: ⇒ T): T

    Measures the time it takes to execute the provided block of code.

    Measures the time it takes to execute the provided block of code.

    val histogram:Histogram = ...
val res = Histograms.measure(histogram, TimeUnit.SECONDS){
  //code goes here
}
    histogram

    The histogram to use

    unit

    The timeunit to use when registering the duration

    block

    The block of code to execute/measure

    returns

    The result created from the provided function block

    Since

    1.0

  13. def measureAsync[T](histogram: Child, unit: TimeUnit)(block: ⇒ Future[T])(implicit ec: ExecutionContext): Future[T]

    Measures the time it takes to execute the Future resulting from the provided block of code.

    Measures the time it takes to execute the Future resulting from the provided block of code.

    val histogram:Histogram.Child = ...
val fut = Histograms.measureAsync(histogram, TimeUnit.SECONDS){
  Future {
    //code goes here
  }
}
    histogram

    The histogram to use

    unit

    The timeunit to use when registering the duration

    block

    The function returning a Future which to measure

    returns

    The future created from the provided function block

    Since

    1.0

  14. def measureAsync[T](histogram: Histogram, unit: TimeUnit)(block: ⇒ Future[T])(implicit ec: ExecutionContext): Future[T]

    Measures the time it takes to execute the Future resulting from the provided block of code.

    Measures the time it takes to execute the Future resulting from the provided block of code.

    val histogram:Histogram = ...
val fut = Histograms.measureAsync(histogram, TimeUnit.SECONDS){
  Future {
    //code goes here
  }
}
    histogram

    The histogram to use

    unit

    The timeunit to use when registering the duration

    block

    The function returning a Future which to measure

    returns

    The future created from the provided function block

    Since

    1.0

  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. def record(histogram: Child, unit: TimeUnit)(duration: Duration): Child

    Record the duration in the unit as set by seen by the implicit unit visible to this class.

    Record the duration in the unit as set by seen by the implicit unit visible to this class.

    histogram

    The histogram to use

    unit

    The timeunit to use when registering the duration

    duration

    The duration to register

    returns

    itself

    Since

    1.0

  19. def record(histogram: Histogram, unit: TimeUnit)(duration: Duration): Histogram

    Record the duration in the unit as set by seen by the implicit unit visible to this class.

    Record the duration in the unit as set by seen by the implicit unit visible to this class.

    histogram

    The histogram to use

    unit

    The timeunit to use when registering the duration

    duration

    The duration to register

    returns

    itself

    Since

    1.0

  20. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  21. def toString(): String
    Definition Classes
    AnyRef → Any
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

Ungrouped