Package org.acemq.workloads

Class RampReport

java.lang.Object
org.acemq.workloads.RampReport
public final class RampReport extends Object
What a Ramp found: every step, the highest rate that met every rule and objective, and what stopped it.

Read isValid() before quoting the ceiling. A ramp stopped by an INVALID step found the generator's limit, or a resource alarm's, and the number below it is a floor for the broker rather than its ceiling.

  • Method Details

    • name

      public String name()

    • ramp

      public Ramp ramp()

    • steps

      public List<RampReport.Step> steps()
      Returns:
      every step in the order it ran, climb first and then any refinement

    • highestSustainedRate

      public long highestSustainedRate()
      Returns:
      the highest offered rate that met every rule and objective, or 0 if none did

    • stoppedBy

      public String stoppedBy()
      Returns:
      what ended the climb: the rules that fired on the first bad step, or maxRate, maxErrorRate, maxSteps or stopped

    • stoppingStep

      public Optional<RampReport.Step> stoppingStep()
      Returns:
      the first step that was not sustained, if the climb found one

    • reachedMaxRate

      public boolean reachedMaxRate()
      Returns:
      whether the climb reached maxRate without anything firing

    • isValid

      public boolean isValid()
      Returns:
      false when the climb was ended by an invalid step — the generator fell behind its schedule or the broker raised an alarm — so the ceiling is not the broker's

    • passed

      public boolean passed()
      Returns:
      with ceilingAtLeast set, whether the highest sustained rate reached it; otherwise whether the ramp was valid and sustained at least its first step

    • verdict

      public String verdict()
      Returns:
      PASSED, FAILED or INVALID, the way the command line says it

    • stoppingFinding

      public Optional<Finding> stoppingFinding()
      Returns:
      the finding that ended the climb, worst first, if one did

    • stopReason

      public String stopReason()
      Returns:
      a sentence on why the climb ended

    • format

      public String format()
      Returns:
      the whole ramp, formatted for a terminal

    • toString

      public String toString()
      Overrides:
      toString in class Object