trait Instrumentation extends AnyRef
Service Provider Interface for instrumenting the operation of the persistence plugin
The persistence plugin is allowed to reuse instances of this class and methods may be called from different threads. Accordingly, implementations which mutate their state will need to use some form of concurrency control.
Implementations must have a constructor which takes a akka.actor.ClassicActorSystemProvider as its only parameter. At most one instance of this class will be constructed per actor system.
- Alphabetic
- By Inheritance
- Instrumentation
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def afterDeserializeEvent(eventContext: AnyRef): Unit
Called after an event is deserialized
Called after an event is deserialized
- eventContext
the potentially null context object returned by a call to queryReceivedEvent
- abstract def afterSerializeEvent(sequenceNumber: Long, context: AnyRef): Unit
Called after an event is serialized in the journal
- abstract def beforeDeserializeEvent(eventContext: AnyRef): Unit
Called before an event is deserialized
Called before an event is deserialized
- eventContext
the potentially null context object returned by a call to queryReceivedEvent
- abstract def beforeSerializeEvent(sequenceNumber: Long, context: AnyRef): Unit
Called before an event is serialized in the journal
- abstract def bySliceQueryCalled(entityType: String, slice: Int, correlationId: String): AnyRef
Called when a query by-slice stream is run (which might not be when a request is made against DDB)
Called when a query by-slice stream is run (which might not be when a request is made against DDB)
The returned context object is passed to subsequent methods and may be accessed concurrently on different threads
- correlationId
possibly empty correlation ID see akka.persistence.query.QueryCorrelationId
- returns
a context object, or emptyContext (null) if no context object is needed
- abstract def eventsByPersistenceIdCalled(persistenceId: String, fromSequenceNumber: Long, toSequenceNumber: Long, correlationId: String): AnyRef
Called when CurrentEventsByPersistenceIdTypedQuery is performed (either to load a persistent actor for processing commands or by a projection to fill a detected gap)
Called when CurrentEventsByPersistenceIdTypedQuery is performed (either to load a persistent actor for processing commands or by a projection to fill a detected gap)
The returned context object is passed to subsequent methods and may be accessed concurrently on different threads
- correlationId
possibly empty correlation ID see akka.persistence.query.QueryCorrelationId
- returns
a context object, or emptyContext (null) if no context object is needed
- abstract def loadEventCalled(persistenceId: String, sequenceNumber: Long): AnyRef
Called when a LoadEventQuery is performed, to load a specific event from the journal
Called when a LoadEventQuery is performed, to load a specific event from the journal
The returned context object is passed to subsequent methods and may be accessed concurrently on different threads
- returns
a context object, or emptyContext (null) if no context object is needed
- abstract def pubsubEventDropped(entityType: String, persistenceId: String, sequenceNumber: Long): Unit
Called when an event is dropped from the pubsub buffer
- abstract def queryReceivedEvent(persistenceId: String, sequenceNumber: Long, queryContext: AnyRef): AnyRef
Called when a query stream receives an event from DynamoDB, before deserializing the payload.
Called when a query stream receives an event from DynamoDB, before deserializing the payload.
The returned context object is passed to subsequent calls for this event and may be accessed concurrently on different threads.
- queryContext
the potentially null context object returned by a call to bySliceQueryCalled or loadEventCalled or eventsByPersistenceIdCalled
- returns
a context object, or emptyContext (null) if no context object is needed
- abstract def writeEventsCalled(persistenceId: String, firstSequenceNr: Long, count: Int): AnyRef
Called when persisting events.
Called when persisting events.
The returned context object is passed to subsequent calls for this event and may be accessed concurrently on different threads.
- returns
a context object, or emptyContext (null) if no context object is needed
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
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()