Package org.acemq.workloads

Class Workload

java.lang.Object
org.acemq.workloads.Workload
public final class Workload extends Object
A load test, described. 

 WorkloadReport report = Workload.named("orders-peak")
         .topology(t -> t
                 .exchange("orders", "topic")
                 .queue("orders.new")
                 .boundTo("orders", "order.created"))
         .publishers(p -> p
                 .threads(4)
                 .rate(50_000)
                 .messageSize(1024))
         .consumers(c -> c
                 .concurrency(8)
                 .prefetch(100)
                 .handlerTime(Duration.ofMillis(1)))
         .warmup(Duration.ofSeconds(10))
         .runFor(Duration.ofMinutes(2))
         .expect(Objective.throughputAtLeast(45_000))
         .expect(Objective.p99Below(Duration.ofMillis(50)))
         .run("amqp://localhost");

 System.out.println(report.format());

Three things kept apart

Topology is what the messages travel through. Publishers and consumers are the shape of the load. Objectives are what the result has to satisfy. They change independently — the same topology under ten load profiles, or the same load against a classic queue and a quorum queue — and a DSL that chained them together would force all three to be rewritten to vary one.

Warm-up is not measured

Workload.Builder.warmup(Duration) runs the workload and throws the measurements away. The first seconds of any JVM workload measure class loading, JIT compilation, connection and channel setup and the first garbage collection, none of which the broker is responsible for. Without a warm-up those costs land in the p99 and stay there.

  • Method Details

    • named

      public static Workload.Builder named(String name)
      Parameters:
      name - what to call this workload, in the report
      Returns:
      a builder

    • name

      public String name()

    • topology

      public TopologySpec topology()

    • publishers

      public PublisherSpec publishers()

    • consumers

      public ConsumerSpec consumers()

    • warmup

      public Duration warmup()

    • duration

      public Duration duration()

    • runsUntilStopped

      public boolean runsUntilStopped()
      Returns:
      true when this run ends only on being stopped, rather than after a set window

    • rules

      public List<Rule> rules()

    • run

      public WorkloadReport run(String brokerUrl)
      Runs it.
      Parameters:
      brokerUrl - an AMQP URL, for example amqp://guest:guest@localhost:5672
      Returns:
      what happened

    • run

      public WorkloadReport run(String brokerUrl, org.acemq.amqp.security.Security security)
      Runs it against a broker that needs more than a URL to reach.
      Parameters:
      brokerUrl - an AMQP URL, for example amqps://guest:guest@localhost:5671
      security - which certificates to believe, or null to let the URL decide — plaintext for amqp:// and the JVM's own trust store for amqps://
      Returns:
      what happened

    • start

      public RunHandle start(String brokerUrl, RunListener listener)
      Starts it on a thread of its own, and reports as it goes.

      For anything that cannot block for the length of a run: a user interface drawing it live, a scheduler, a test that stops the run once it has seen enough. 

      
 RunHandle run = workload.start("amqp://localhost", System.out::println);
 // ... and later
 run.stop();
 WorkloadReport report = run.report().join();
      Parameters:
      brokerUrl - an AMQP URL
      listener - told about each reading, or RunListener.NONE
      Returns:
      a handle on the run

    • start

      public RunHandle start(String brokerUrl, org.acemq.amqp.security.Security security, RunListener listener)
      Starts it against a broker that needs more than a URL to reach.
      Parameters:
      brokerUrl - an AMQP URL
      security - which certificates to believe, or null to let the URL decide
      listener - told about each reading, or RunListener.NONE
      Returns:
      a handle on the run

    • toString

      public String toString()
      Overrides:
      toString in class Object