ActorInstrumentedLifeCycle
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
}
}
Attributes
- Graph
-
- Supertypes
-
trait Actorclass Objecttrait Matchableclass Any
- Self type
-
InstrumentedBuilder
Members list
Type members
Inherited types
Attributes
- Inherited from:
- Actor
Value members
Concrete methods
Scala API: User overridable callback: '''By default it disposes of all children and then calls postStop().'''
Scala API: User overridable callback: '''By default it disposes of all children and then calls postStop().'''
Value parameters
- message
-
optionally the current message the actor processed when failing, if applicable Is called on a crashed Actor right BEFORE it is restarted to allow clean up of resources before Actor is terminated.
- reason
-
the Throwable that caused the restart to happen
Attributes
Inherited methods
User overridable callback: By default it calls preStart().
User overridable callback: By default it calls preStart().
Value parameters
- reason
-
the Throwable that caused the restart to happen Is called right AFTER restart on the newly created Actor to allow reinitialization after an Actor crash.
Attributes
- Inherited from:
- Actor
User overridable callback.
User overridable callback.
Is called asynchronously after 'actor.stop()' is invoked. Empty default implementation.
Attributes
- Inherited from:
- Actor
User overridable callback.
User overridable callback.
Is called when an Actor is started. Actors are automatically started asynchronously when created. Empty default implementation.
Attributes
- Inherited from:
- Actor
The reference sender Actor of the last received message. Is defined if the message was sent from another Actor, else deadLetters in pekko.actor.ActorSystem.
The reference sender Actor of the last received message. Is defined if the message was sent from another Actor, else deadLetters in pekko.actor.ActorSystem.
WARNING: Only valid within the Actor itself, so do not close over it and publish it to other threads!
Attributes
- Inherited from:
- Actor
User overridable definition the strategy to use for supervising child actors.
User overridable definition the strategy to use for supervising child actors.
Attributes
- Inherited from:
- Actor
User overridable callback.
User overridable callback.
Is called when a message isn't handled by the current behavior of the actor by default it fails with either a pekko.actor.DeathPactException (in case of an unhandled pekko.actor.Terminated message) or publishes an pekko.actor.UnhandledMessage to the actor's system's pekko.event.EventStream
Attributes
- Inherited from:
- Actor
Inherited and Abstract methods
Scala API: This defines the initial actor behavior, it must return a partial function with the actor logic.
Scala API: This defines the initial actor behavior, it must return a partial function with the actor logic.
Attributes
- Inherited from:
- Actor
Implicits
Inherited implicits
Scala API: Stores the context for this actor, including self, and sender. It is implicit to support operations such as forward.
Scala API: Stores the context for this actor, including self, and sender. It is implicit to support operations such as forward.
WARNING: Only valid within the Actor itself, so do not close over it and publish it to other threads!
pekko.actor.ActorContext is the Scala API. getContext returns a pekko.actor.AbstractActor.ActorContext, which is the Java API of the actor context.
Attributes
- Inherited from:
- Actor
The 'self' field holds the ActorRef for this actor.
The 'self' field holds the ActorRef for this actor.
Can be used to send messages to itself:
self ! message
Attributes
- Inherited from:
- Actor