Package org.mockserver.load

Class LoadStage

java.lang.Object

org.mockserver.model.ObjectWithReflectiveEqualsHashCodeToString

org.mockserver.model.ObjectWithJsonToString

org.mockserver.load.LoadStage

public class LoadStage
extends ObjectWithJsonToString

One stage of a LoadProfile: a contiguous slice of the run holding or ramping a setpoint for durationMillis. Stages run in sequence; the total run ends after the last stage (or when maxRequests is hit, or on stop).

A stage is one of three LoadStageTypes:

• LoadStageType.VU — closed model. Either holds vus or ramps from startVus to endVus along the curve.
• LoadStageType.RATE — open model. Either holds rate or ramps from startRate to endRate (iterations/second) along the curve, optionally capped at maxVus virtual users for this stage (else the global VU cap).
• LoadStageType.PAUSE — drives no load for durationMillis.

targetVusAt(long) and targetRateAt(long) are the pure, deterministic setpoint functions the orchestrator reads each control tick; both honour the curve.

Constructor Summary

Constructors

Constructor	Description
LoadStage()

Method Summary

Modifier and Type	Method	Description
static LoadStage	constantRate(double rate, long durationMillis)
static LoadStage	constantVus(int vus, long durationMillis)
RampCurve	getCurve()
long	getDurationMillis()
Double	getEndRate()
Integer	getEndVus()
Integer	getMaxVus()
Double	getRate()
Double	getStartRate()
Integer	getStartVus()
LoadStageType	getType()
Integer	getVus()
boolean	isRateRamp()	True when this RATE stage is a ramp (both start and end rate supplied), else a hold.
boolean	isVuRamp()	True when this VU stage is a ramp (both start and end VUs supplied), else a hold.
static LoadStage	loadStage()
static LoadStage	pause(long durationMillis)
double	peakRate()	The largest arrival rate this stage can request (used to enforce the rate cap up-front).
int	peakVus()	The largest VU count this stage can request (used to enforce the VU cap up-front regardless of shape).
static LoadStage	rampRate(double startRate, double endRate, long durationMillis)
static LoadStage	rampRate(double startRate, double endRate, long durationMillis, RampCurve curve)
static LoadStage	rampVus(int startVus, int endVus, long durationMillis)
static LoadStage	rampVus(int startVus, int endVus, long durationMillis, RampCurve curve)
double	targetRateAt(long elapsedInStageMillis)	The target arrival rate (iterations/second) at elapsedInStageMillis into this RATE stage.
int	targetVusAt(long elapsedInStageMillis)	The target VU setpoint at elapsedInStageMillis into this VU stage.
LoadStage	withCurve(RampCurve curve)
LoadStage	withDurationMillis(long durationMillis)
LoadStage	withEndRate(Double endRate)
LoadStage	withEndVus(Integer endVus)
LoadStage	withMaxVus(Integer maxVus)
LoadStage	withRate(Double rate)
LoadStage	withStartRate(Double startRate)
LoadStage	withStartVus(Integer startVus)
LoadStage	withType(LoadStageType type)
LoadStage	withVus(Integer vus)

Methods inherited from class org.mockserver.model.ObjectWithJsonToString

toString

Methods inherited from class org.mockserver.model.ObjectWithReflectiveEqualsHashCodeToString

equals, fieldsExcludedFromEqualsAndHashCode, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

LoadStage

public LoadStage()

Method Details

loadStage

public static LoadStage loadStage()

constantVus

public static LoadStage constantVus(int vus,
 long durationMillis)

rampVus

public static LoadStage rampVus(int startVus,
 int endVus,
 long durationMillis,
 RampCurve curve)

rampVus

public static LoadStage rampVus(int startVus,
 int endVus,
 long durationMillis)

constantRate

public static LoadStage constantRate(double rate,
 long durationMillis)

rampRate

public static LoadStage rampRate(double startRate,
 double endRate,
 long durationMillis,
 RampCurve curve)

rampRate

public static LoadStage rampRate(double startRate,
 double endRate,
 long durationMillis)

pause

public static LoadStage pause(long durationMillis)

isVuRamp

public boolean isVuRamp()

True when this VU stage is a ramp (both start and end VUs supplied), else a hold.

isRateRamp

public boolean isRateRamp()

True when this RATE stage is a ramp (both start and end rate supplied), else a hold.

targetVusAt

public int targetVusAt(long elapsedInStageMillis)

The target VU setpoint at elapsedInStageMillis into this VU stage. For a hold this is vus; for a ramp it is round(curve.valueAt(startVus, endVus, progress)). Returns 0 for non-VU stages.

targetRateAt

public double targetRateAt(long elapsedInStageMillis)

The target arrival rate (iterations/second) at elapsedInStageMillis into this RATE stage. For a hold this is rate; for a ramp it is curve.valueAt(startRate, endRate, progress). Returns 0 for non-RATE stages.

peakVus

public int peakVus()

The largest VU count this stage can request (used to enforce the VU cap up-front regardless of shape).

peakRate

public double peakRate()

The largest arrival rate this stage can request (used to enforce the rate cap up-front).

getType

public LoadStageType getType()

withType

public LoadStage withType(LoadStageType type)

getDurationMillis

public long getDurationMillis()

withDurationMillis

public LoadStage withDurationMillis(long durationMillis)

getCurve

public RampCurve getCurve()

withCurve

public LoadStage withCurve(RampCurve curve)

getVus

public Integer getVus()

withVus

public LoadStage withVus(Integer vus)

getStartVus

public Integer getStartVus()

withStartVus

public LoadStage withStartVus(Integer startVus)

getEndVus

public Integer getEndVus()

withEndVus

public LoadStage withEndVus(Integer endVus)

getRate

public Double getRate()

withRate

public LoadStage withRate(Double rate)

getStartRate

public Double getStartRate()

withStartRate

public LoadStage withStartRate(Double startRate)

getEndRate

public Double getEndRate()

withEndRate

public LoadStage withEndRate(Double endRate)

getMaxVus

public Integer getMaxVus()

withMaxVus

public LoadStage withMaxVus(Integer maxVus)