Class JournalPerfSpec

This spec measures execution times of the basic operations that an PersistentActor provides, using the provided Journal (plugin).

It is NOT meant to be a comprehensive benchmark, but rather aims to help plugin developers to easily determine if their plugin's performance is roughly as expected. It also validates the plugin still works under "more messages" scenarios.

In case your journal plugin needs some kind of teardown, override the AfterAll method (don't forget to call base in your overridden methods).

Inheritance

Object

TestKitBase

TestKit

JournalPerfSpec

Implements

IActorRefFactory

IDisposable

Inherited Members

TestKit.Output

TestKit.DefaultConfig

TestKit.FullDebugConfig

TestKit.Assertions

TestKit.AfterAll()

TestKit.InitializeLogger(ActorSystem)

TestKit.InitializeLogger(ActorSystem, String)

TestKit.Dispose(Boolean)

TestKit.Dispose()

TestKitBase.InitializeTest(ActorSystem, ActorSystemSetup, String, String)

TestKitBase.InitializeTest(ActorSystem, Config, String, String)

TestKitBase.Sys

TestKitBase.TestKitSettings

TestKitBase.LastSender

TestKitBase.Now

TestKitBase.Log

TestKitBase.LastMessage

TestKitBase.TestActor

TestKitBase.EventFilter

TestKitBase.CreateEventFilter(ActorSystem)

TestKitBase.HasMessages

TestKitBase.IgnoreMessages(Func<Object, Boolean>)

TestKitBase.IgnoreMessages<TMsg>(Func<TMsg, Boolean>)

TestKitBase.IgnoreMessages<TMsg>()

TestKitBase.IgnoreNoMessages()

TestKitBase.Watch(IActorRef)

TestKitBase.WatchAsync(IActorRef)

TestKitBase.Unwatch(IActorRef)

TestKitBase.UnwatchAsync(IActorRef)

TestKitBase.SetAutoPilot(AutoPilot)

TestKitBase.RemainingOrDefault

TestKitBase.Remaining

TestKitBase.RemainingOr(TimeSpan)

TestKitBase.RemainingOrDilated(Nullable<TimeSpan>)

TestKitBase.Dilated(TimeSpan)

TestKitBase.GetTimeoutOrDefault(Nullable<TimeSpan>)

TestKitBase.Shutdown(Nullable<TimeSpan>, Boolean)

TestKitBase.Shutdown(ActorSystem, Nullable<TimeSpan>, Boolean)

TestKitBase.ChildActorOf(Props, String, SupervisorStrategy, CancellationToken)

TestKitBase.ChildActorOfAsync(Props, String, SupervisorStrategy, CancellationToken)

TestKitBase.ChildActorOf(Props, SupervisorStrategy, CancellationToken)

TestKitBase.ChildActorOfAsync(Props, SupervisorStrategy, CancellationToken)

TestKitBase.ChildActorOf(Props, String, CancellationToken)

TestKitBase.ChildActorOfAsync(Props, String, CancellationToken)

TestKitBase.ChildActorOf(Props, CancellationToken)

TestKitBase.ChildActorOfAsync(Props, CancellationToken)

TestKitBase.CreateTestActor(String)

TestKitBase.CreateTestProbe(String)

TestKitBase.CreateTestProbe(ActorSystem, String)

TestKitBase.CreateTestLatch(Int32)

TestKitBase.CreateTestBarrier(Int32)

TestKitBase.ActorOf(Props)

TestKitBase.ActorOf(Props, String)

TestKitBase.ActorOf<TActor>()

TestKitBase.ActorOf<TActor>(String)

TestKitBase.ActorOf<TActor>(Expression<Func<TActor>>)

TestKitBase.ActorOf<TActor>(Expression<Func<TActor>>, String)

TestKitBase.ActorOf(Action<IActorDsl, IActorContext>, String)

TestKitBase.ActorOf(Action<IActorDsl>, String)

TestKitBase.ActorSelection(ActorPath)

TestKitBase.ActorSelection(String)

TestKitBase.ActorSelection(IActorRef, String)

TestKitBase.ActorOfAsTestActorRef<TActor>(Props, IActorRef, String)

TestKitBase.ActorOfAsTestActorRef<TActor>(Props, String)

TestKitBase.ActorOfAsTestActorRef<TActor>(Expression<Func<TActor>>, IActorRef, String)

TestKitBase.ActorOfAsTestActorRef<TActor>(Expression<Func<TActor>>, String)

TestKitBase.ActorOfAsTestActorRef<TActor>(IActorRef, String)

TestKitBase.ActorOfAsTestActorRef<TActor>(String)

TestKitBase.ActorOfAsTestFSMRef<TFsmActor, TState, TData>(Props, IActorRef, String, Boolean)

TestKitBase.ActorOfAsTestFSMRef<TFsmActor, TState, TData>(Props, String, Boolean)

TestKitBase.ActorOfAsTestFSMRef<TFsmActor, TState, TData>(IActorRef, String, Boolean)

TestKitBase.ActorOfAsTestFSMRef<TFsmActor, TState, TData>(String, Boolean)

TestKitBase.ActorOfAsTestFSMRef<TFsmActor, TState, TData>(Expression<Func<TFsmActor>>, IActorRef, String, Boolean)

TestKitBase.ActorOfAsTestFSMRef<TFsmActor, TState, TData>(Expression<Func<TFsmActor>>, String, Boolean)

TestKitBase.AwaitAssert(Action, Nullable<TimeSpan>, Nullable<TimeSpan>, CancellationToken)

TestKitBase.AwaitAssertAsync(Action, Nullable<TimeSpan>, Nullable<TimeSpan>, CancellationToken)

TestKitBase.AwaitAssertAsync(Func<Task>, Nullable<TimeSpan>, Nullable<TimeSpan>, CancellationToken)

TestKitBase.AwaitCondition(Func<Boolean>, CancellationToken)

TestKitBase.AwaitConditionAsync(Func<Task<Boolean>>, CancellationToken)

TestKitBase.AwaitConditionAsync(Func<Boolean>, CancellationToken)

TestKitBase.AwaitCondition(Func<Boolean>, Nullable<TimeSpan>, CancellationToken)

TestKitBase.AwaitConditionAsync(Func<Task<Boolean>>, Nullable<TimeSpan>, CancellationToken)

TestKitBase.AwaitCondition(Func<Boolean>, Nullable<TimeSpan>, String, CancellationToken)

TestKitBase.AwaitConditionAsync(Func<Task<Boolean>>, Nullable<TimeSpan>, String, CancellationToken)

TestKitBase.AwaitConditionAsync(Func<Boolean>, Nullable<TimeSpan>, String, CancellationToken)

TestKitBase.AwaitCondition(Func<Boolean>, Nullable<TimeSpan>, Nullable<TimeSpan>, String, CancellationToken)

TestKitBase.AwaitConditionAsync(Func<Task<Boolean>>, Nullable<TimeSpan>, Nullable<TimeSpan>, String, CancellationToken)

TestKitBase.AwaitConditionAsync(Func<Boolean>, Nullable<TimeSpan>, Nullable<TimeSpan>, String, CancellationToken)

TestKitBase.AwaitConditionNoThrow(Func<Boolean>, TimeSpan, Nullable<TimeSpan>, CancellationToken)

TestKitBase.AwaitConditionNoThrowAsync(Func<Task<Boolean>>, TimeSpan, Nullable<TimeSpan>, CancellationToken)

TestKitBase.AwaitConditionNoThrowAsync(Func<Boolean>, TimeSpan, Nullable<TimeSpan>, CancellationToken)

TestKitBase.InternalAwaitCondition(Func<Boolean>, TimeSpan, Nullable<TimeSpan>, Action<String, Object[]>, CancellationToken)

TestKitBase.InternalAwaitConditionAsync(Func<Task<Boolean>>, TimeSpan, Nullable<TimeSpan>, Action<String, Object[]>, CancellationToken)

TestKitBase.InternalAwaitCondition(Func<Boolean>, TimeSpan, Nullable<TimeSpan>, Action<String, Object[]>, ILoggingAdapter, CancellationToken)

TestKitBase.InternalAwaitConditionAsync(Func<Task<Boolean>>, TimeSpan, Nullable<TimeSpan>, Action<String, Object[]>, ILoggingAdapter, CancellationToken)

TestKitBase.ExpectMsg<T>(Nullable<TimeSpan>, String, CancellationToken)

TestKitBase.ExpectMsgAsync<T>(Nullable<TimeSpan>, String, CancellationToken)

TestKitBase.ExpectMsg<T>(T, Nullable<TimeSpan>, String, CancellationToken)

TestKitBase.ExpectMsgAsync<T>(T, Nullable<TimeSpan>, String, CancellationToken)

TestKitBase.ExpectMsg<T>(Predicate<T>, Nullable<TimeSpan>, String, CancellationToken)

TestKitBase.ExpectMsgAsync<T>(Predicate<T>, Nullable<TimeSpan>, String, CancellationToken)

TestKitBase.ExpectMsg<T>(Action<T>, Nullable<TimeSpan>, String, CancellationToken)

TestKitBase.ExpectMsgAsync<T>(Action<T>, Nullable<TimeSpan>, String, CancellationToken)

TestKitBase.ExpectMsg<T>(Func<T, IActorRef, Boolean>, Nullable<TimeSpan>, String, CancellationToken)

TestKitBase.ExpectMsgAsync<T>(Func<T, IActorRef, Boolean>, Nullable<TimeSpan>, String, CancellationToken)

TestKitBase.ExpectMsg<T>(Action<T, IActorRef>, Nullable<TimeSpan>, String, CancellationToken)

TestKitBase.ExpectMsgAsync<T>(Action<T, IActorRef>, Nullable<TimeSpan>, String, CancellationToken)

TestKitBase.ExpectMsg<T>(T, Func<T, T, Boolean>, Nullable<TimeSpan>, String, CancellationToken)

TestKitBase.ExpectMsgAsync<T>(T, Func<T, T, Boolean>, Nullable<TimeSpan>, String, CancellationToken)

TestKitBase.ExpectTerminated(IActorRef, Nullable<TimeSpan>, String, CancellationToken)

TestKitBase.ExpectTerminatedAsync(IActorRef, Nullable<TimeSpan>, String, CancellationToken)

TestKitBase.ExpectNoMsg(CancellationToken)

TestKitBase.ExpectNoMsgAsync(CancellationToken)

TestKitBase.ExpectNoMsg(TimeSpan, CancellationToken)

TestKitBase.ExpectNoMsgAsync(TimeSpan, CancellationToken)

TestKitBase.ExpectNoMsg(Int32, CancellationToken)

TestKitBase.ExpectNoMsgAsync(Int32, CancellationToken)

TestKitBase.ExpectMsgAnyOf<T>(IEnumerable<T>, CancellationToken)

TestKitBase.ExpectMsgAnyOfAsync<T>(IEnumerable<T>, CancellationToken)

TestKitBase.ExpectMsgAllOf<T>(T[])

TestKitBase.ExpectMsgAllOf<T>(IReadOnlyCollection<T>, CancellationToken)

TestKitBase.ExpectMsgAllOfAsync<T>(IReadOnlyCollection<T>, CancellationToken)

TestKitBase.ExpectMsgAllOf<T>(TimeSpan, T[])

TestKitBase.ExpectMsgAllOf<T>(TimeSpan, IReadOnlyCollection<T>, CancellationToken)

TestKitBase.ExpectMsgAllOfAsync<T>(TimeSpan, IReadOnlyCollection<T>, CancellationToken)

TestKitBase.ExpectMsgAllOfMatchingPredicates(PredicateInfo[])

TestKitBase.ExpectMsgAllOfMatchingPredicates(IReadOnlyCollection<PredicateInfo>, CancellationToken)

TestKitBase.ExpectMsgAllOfMatchingPredicatesAsync(IReadOnlyCollection<PredicateInfo>, CancellationToken)

TestKitBase.ExpectMsgAllOfMatchingPredicates(TimeSpan, PredicateInfo[])

TestKitBase.ExpectMsgAllOfMatchingPredicates(TimeSpan, IReadOnlyCollection<PredicateInfo>, CancellationToken)

TestKitBase.ExpectMsgAllOfMatchingPredicatesAsync(TimeSpan, IReadOnlyCollection<PredicateInfo>, CancellationToken)

TestKitBase.ExpectMsgFrom<T>(IActorRef, Nullable<TimeSpan>, String, CancellationToken)

TestKitBase.ExpectMsgFromAsync<T>(IActorRef, Nullable<TimeSpan>, String, CancellationToken)

TestKitBase.ExpectMsgFrom<T>(IActorRef, T, Nullable<TimeSpan>, String, CancellationToken)

TestKitBase.ExpectMsgFromAsync<T>(IActorRef, T, Nullable<TimeSpan>, String, CancellationToken)

TestKitBase.ExpectMsgFrom<T>(IActorRef, Predicate<T>, Nullable<TimeSpan>, String, CancellationToken)

TestKitBase.ExpectMsgFromAsync<T>(IActorRef, Predicate<T>, Nullable<TimeSpan>, String, CancellationToken)

TestKitBase.ExpectMsgFrom<T>(Predicate<IActorRef>, Predicate<T>, Nullable<TimeSpan>, String, CancellationToken)

TestKitBase.ExpectMsgFromAsync<T>(Predicate<IActorRef>, Predicate<T>, Nullable<TimeSpan>, String, CancellationToken)

TestKitBase.ExpectMsgFrom<T>(IActorRef, Action<T>, Nullable<TimeSpan>, String, CancellationToken)

TestKitBase.ExpectMsgFromAsync<T>(IActorRef, Action<T>, Nullable<TimeSpan>, String, CancellationToken)

TestKitBase.ExpectMsgFrom<T>(Action<IActorRef>, Action<T>, Nullable<TimeSpan>, String, CancellationToken)

TestKitBase.ExpectMsgFromAsync<T>(Action<IActorRef>, Action<T>, Nullable<TimeSpan>, String, CancellationToken)

TestKitBase.FishForMessage(Predicate<Object>, Nullable<TimeSpan>, String, CancellationToken)

TestKitBase.FishForMessageAsync(Predicate<Object>, Nullable<TimeSpan>, String, CancellationToken)

TestKitBase.FishForMessage<T>(Predicate<T>, Nullable<TimeSpan>, String, CancellationToken)

TestKitBase.FishForMessageAsync<T>(Predicate<T>, Nullable<TimeSpan>, String, CancellationToken)

TestKitBase.FishForMessage<T>(Predicate<T>, ArrayList, Nullable<TimeSpan>, String, CancellationToken)

TestKitBase.FishForMessageAsync<T>(Predicate<T>, ArrayList, Nullable<TimeSpan>, String, CancellationToken)

TestKitBase.FishUntilMessageAsync<T>(Nullable<TimeSpan>, CancellationToken)

TestKitBase.WaitForRadioSilenceAsync(Nullable<TimeSpan>, Nullable<UInt32>, CancellationToken)

TestKitBase.ReceiveOne(Nullable<TimeSpan>, CancellationToken)

TestKitBase.ReceiveOneAsync(Nullable<TimeSpan>, CancellationToken)

TestKitBase.TryReceiveOne(MessageEnvelope, Nullable<TimeSpan>, CancellationToken)

TestKitBase.TryReceiveOneAsync(Nullable<TimeSpan>, CancellationToken)

TestKitBase.PeekOne(Nullable<TimeSpan>, CancellationToken)

TestKitBase.PeekOneAsync(Nullable<TimeSpan>, CancellationToken)

TestKitBase.PeekOne(CancellationToken)

TestKitBase.PeekOneAsync(CancellationToken)

TestKitBase.TryPeekOne(MessageEnvelope, Nullable<TimeSpan>, CancellationToken)

TestKitBase.TryPeekOneAsync(Nullable<TimeSpan>, CancellationToken)

TestKitBase.ReceiveWhile<T>(Nullable<TimeSpan>, Func<Object, T>, Int32, CancellationToken)

TestKitBase.ReceiveWhileAsync<T>(Nullable<TimeSpan>, Func<Object, T>, Int32, CancellationToken)

TestKitBase.ReceiveWhile<T>(Nullable<TimeSpan>, Nullable<TimeSpan>, Func<Object, T>, Int32, CancellationToken)

TestKitBase.ReceiveWhileAsync<T>(Nullable<TimeSpan>, Nullable<TimeSpan>, Func<Object, T>, Int32, CancellationToken)

TestKitBase.ReceiveWhile<T>(Func<Object, T>, Nullable<TimeSpan>, Nullable<TimeSpan>, Int32, CancellationToken)

TestKitBase.ReceiveWhileAsync<T>(Func<Object, T>, Nullable<TimeSpan>, Nullable<TimeSpan>, Int32, CancellationToken)

TestKitBase.ReceiveWhile<T>(Predicate<T>, Nullable<TimeSpan>, Nullable<TimeSpan>, Int32, Boolean, CancellationToken)

TestKitBase.ReceiveWhileAsync<T>(Predicate<T>, Nullable<TimeSpan>, Nullable<TimeSpan>, Int32, Boolean, CancellationToken)

TestKitBase.ReceiveN(Int32, CancellationToken)

TestKitBase.ReceiveNAsync(Int32, CancellationToken)

TestKitBase.ReceiveN(Int32, TimeSpan, CancellationToken)

TestKitBase.ReceiveNAsync(Int32, TimeSpan, CancellationToken)

TestKitBase.Within(TimeSpan, Action, Nullable<TimeSpan>, CancellationToken)

TestKitBase.WithinAsync(TimeSpan, Func<Task>, Nullable<TimeSpan>, CancellationToken)

TestKitBase.Within(TimeSpan, TimeSpan, Action, String, Nullable<TimeSpan>, CancellationToken)

TestKitBase.WithinAsync(TimeSpan, TimeSpan, Func<Task>, String, Nullable<TimeSpan>, CancellationToken)

TestKitBase.Within<T>(TimeSpan, Func<T>, Nullable<TimeSpan>, CancellationToken)

TestKitBase.WithinAsync<T>(TimeSpan, Func<Task<T>>, Nullable<TimeSpan>, CancellationToken)

TestKitBase.Within<T>(TimeSpan, TimeSpan, Func<T>, String, Nullable<TimeSpan>, CancellationToken)

TestKitBase.WithinAsync<T>(TimeSpan, TimeSpan, Func<Task<T>>, String, Nullable<TimeSpan>, CancellationToken)

Object.Equals(Object)

Object.Equals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Object.ToString()

Namespace: Akka.Persistence.TestKit.Performance

Assembly: Akka.Persistence.TCK.dll

Syntax

public abstract class JournalPerfSpec : TestKit, IActorRefFactory, IDisposable

Constructors

| Improve this Doc View Source

JournalPerfSpec(Config, String, ITestOutputHelper)

Declaration

protected JournalPerfSpec(Config config, string actorSystem, ITestOutputHelper output)

Parameters

Type	Name	Description
Config	config
String	actorSystem
Xunit.Abstractions.ITestOutputHelper	output

Fields

| Improve this Doc View Source

EventsCount

Number of messages sent to the PersistentActor under test for each test iteration

Declaration

protected int EventsCount

Field Value

Type	Description
Int32

| Improve this Doc View Source

ExpectDuration

Override in order to customize timeouts used for ExpectMsg, in order to tune the awaits to your journal's perf

Declaration

protected TimeSpan ExpectDuration

Field Value

Type	Description
TimeSpan

| Improve this Doc View Source

MeasurementIterations

Number of measurement iterations each test will be run.

Declaration

protected int MeasurementIterations

Field Value

Type	Description
Int32

| Improve this Doc View Source

OutlierRejectionSigma

Sigma value for the z-score outlier rejection algorithm

Declaration

protected double OutlierRejectionSigma

Field Value

Type	Description
Double

Methods

| Improve this Doc View Source

PersistenceActor_performance_must_measure_Persist()

Declaration

[Fact]
public void PersistenceActor_performance_must_measure_Persist()

| Improve this Doc View Source

PersistenceActor_performance_must_measure_PersistAll()

Declaration

[Fact]
public void PersistenceActor_performance_must_measure_PersistAll()

| Improve this Doc View Source

PersistenceActor_performance_must_measure_PersistAllAsync()

Declaration

[Fact]
public void PersistenceActor_performance_must_measure_PersistAllAsync()

| Improve this Doc View Source

PersistenceActor_performance_must_measure_PersistAsync()

Declaration

[Fact]
public void PersistenceActor_performance_must_measure_PersistAsync()

| Improve this Doc View Source

PersistenceActor_performance_must_measure_PersistGroup10()

Declaration

[Fact]
public void PersistenceActor_performance_must_measure_PersistGroup10()

| Improve this Doc View Source

PersistenceActor_performance_must_measure_PersistGroup100()

Declaration

[Fact]
public void PersistenceActor_performance_must_measure_PersistGroup100()

| Improve this Doc View Source

PersistenceActor_performance_must_measure_PersistGroup200()

Declaration

[Fact]
public void PersistenceActor_performance_must_measure_PersistGroup200()

| Improve this Doc View Source

PersistenceActor_performance_must_measure_PersistGroup25()

Declaration

[Fact]
public void PersistenceActor_performance_must_measure_PersistGroup25()

| Improve this Doc View Source

PersistenceActor_performance_must_measure_PersistGroup50()

Declaration

[Fact]
public void PersistenceActor_performance_must_measure_PersistGroup50()

| Improve this Doc View Source

PersistenceActor_performance_must_measure_Recovering()

Declaration

[Fact]
public void PersistenceActor_performance_must_measure_Recovering()

| Improve this Doc View Source

PersistenceActor_performance_must_measure_RecoveringFour()

Declaration

[Fact]
public void PersistenceActor_performance_must_measure_RecoveringFour()

| Improve this Doc View Source

PersistenceActor_performance_must_measure_RecoveringTwo()

Declaration

[Fact]
public void PersistenceActor_performance_must_measure_RecoveringTwo()

Implements

IActorRefFactory

IDisposable

Extension Methods

ObjectExtensions.IsDefaultForType<T>(T)

ObjectExtensions.AsOption<T>(T)

Extensions.AsInstanceOf<T>(Object)