Packages

t

nl.grons.metrics4.scala

ActorInstrumentedLifeCycle

trait ActorInstrumentedLifeCycle extends Actor

Stackable Actor trait which links Gauge life cycles with the actor life cycle.

When an actor is restarted, gauges can not be created again under the same name in the same metric registry. By mixing in this trait, all gauges created in this actor will be automatically unregistered before this actor restarts.

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 ExampleActor extends Actor with Instrumented with ActorInstrumentedLifecycle {

  var counter = 0

  // The following gauge will automatically unregister before a restart of this actor.
  metrics.gauge("sample-gauge"){
    counter
  }

  override def receive = {
    case 'increment =>
      counter += 1
      doWork()
  }

  def doWork(): Unit = {
    // etc etc etc
  }
}
Self Type
ActorInstrumentedLifeCycle with InstrumentedBuilder
Linear Supertypes
Actor, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ActorInstrumentedLifeCycle
  2. Actor
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. type Receive = PartialFunction[Any, Unit]
    Definition Classes
    Actor

Abstract Value Members

  1. abstract def receive: org.apache.pekko.actor.Actor.Receive
    Definition Classes
    Actor

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. def aroundPostRestart(reason: Throwable): Unit
    Attributes
    protected[pekko]
    Definition Classes
    Actor
    Annotations
    @InternalApi()
  5. def aroundPostStop(): Unit
    Attributes
    protected[pekko]
    Definition Classes
    Actor
    Annotations
    @InternalApi()
  6. def aroundPreRestart(reason: Throwable, message: Option[Any]): Unit
    Attributes
    protected[pekko]
    Definition Classes
    Actor
    Annotations
    @InternalApi()
  7. def aroundPreStart(): Unit
    Attributes
    protected[pekko]
    Definition Classes
    Actor
    Annotations
    @InternalApi()
  8. def aroundReceive(receive: org.apache.pekko.actor.Actor.Receive, msg: Any): Unit
    Attributes
    protected[pekko]
    Definition Classes
    Actor
    Annotations
    @InternalApi()
  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  11. implicit val context: ActorContext
    Definition Classes
    Actor
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  14. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. def postRestart(reason: Throwable): Unit
    Definition Classes
    Actor
    Annotations
    @throws( classOf[java.lang.Exception] )
  21. def postStop(): Unit
    Definition Classes
    Actor
    Annotations
    @throws( classOf[java.lang.Exception] )
  22. def preRestart(reason: Throwable, message: Option[Any]): Unit
    Definition Classes
    ActorInstrumentedLifeCycle → Actor
  23. def preStart(): Unit
    Definition Classes
    Actor
    Annotations
    @throws( classOf[java.lang.Exception] )
  24. implicit final val self: ActorRef
    Definition Classes
    Actor
  25. final def sender(): ActorRef
    Definition Classes
    Actor
  26. def supervisorStrategy: SupervisorStrategy
    Definition Classes
    Actor
  27. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  28. def toString(): String
    Definition Classes
    AnyRef → Any
  29. def unhandled(message: Any): Unit
    Definition Classes
    Actor
  30. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  32. 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 Actor

Inherited from AnyRef

Inherited from Any

Ungrouped