Package org.mockserver.load

Class LoadScenario

java.lang.Object

org.mockserver.model.ObjectWithReflectiveEqualsHashCodeToString

org.mockserver.model.ObjectWithJsonToString

org.mockserver.load.LoadScenario

public class LoadScenario
extends ObjectWithJsonToString

An API-driven load scenario: an ordered list of templated request LoadSteps driven at a target concurrency described by a LoadProfile, with optional per-iteration data variation via the scenario's HttpTemplate.TemplateType.

Modelled on VerificationSequence (an ordered list of request steps) but oriented at producing traffic rather than asserting over it. It is a pure SLI producer: it records latency/error samples (into the metrics histograms and the SLO sample store) but contains no verdict logic — the SLO verify feature consumes those samples.

Off by default; PUT /mockserver/loadScenario returns 403 unless loadGenerationEnabled is set.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	LoadScenario.StepSelection	How each iteration selects which steps to run from getSteps().

Constructor Summary

Constructors

Constructor	Description
LoadScenario()

Method Summary

Modifier and Type	Method	Description
long	getAbortGraceMillis()	The abort grace window in milliseconds (default 0).
LoadFeeder	getFeeder()	The data feeder (may be null = no feeder).
Map<String,String>	getLabels()	Scenario-level custom labels (may be null/empty).
Integer	getMaxRequests()
String	getName()
LoadPacing	getPacing()	Adaptive iteration pacing (may be null = no pacing).
LoadProfile	getProfile()
long	getStartDelayMillis()	The start delay in milliseconds applied after a start trigger before this scenario's iterations begin (default 0).
List<LoadStep>	getSteps()
LoadScenario.StepSelection	getStepSelection()	The per-iteration step selection mode (may be null = LoadScenario.StepSelection.SEQUENTIAL).
HttpTemplate.TemplateType	getTemplateType()
List<LoadThreshold>	getThresholds()	In-run pass/fail thresholds (may be null/empty).
boolean	isAbortOnFail()	Whether a FAIL verdict aborts the run early (default false).
static LoadScenario	loadScenario()
static LoadScenario	loadScenario(String name)
LoadScenario	withAbortGraceMillis(long abortGraceMillis)
LoadScenario	withAbortOnFail(boolean abortOnFail)
LoadScenario	withFeeder(LoadFeeder feeder)
LoadScenario	withLabel(String name, String value)
LoadScenario	withLabels(Map<String,String> labels)
LoadScenario	withMaxRequests(Integer maxRequests)
LoadScenario	withName(String name)
LoadScenario	withPacing(LoadPacing pacing)
LoadScenario	withProfile(LoadProfile profile)
LoadScenario	withStartDelayMillis(long startDelayMillis)
LoadScenario	withSteps(List<LoadStep> steps)
LoadScenario	withSteps(LoadStep... steps)
LoadScenario	withStepSelection(LoadScenario.StepSelection stepSelection)
LoadScenario	withTemplateType(HttpTemplate.TemplateType templateType)
LoadScenario	withThresholds(List<LoadThreshold> thresholds)
LoadScenario	withThresholds(LoadThreshold... thresholds)

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

LoadScenario

public LoadScenario()

Method Details

loadScenario

public static LoadScenario loadScenario()

loadScenario

public static LoadScenario loadScenario(String name)

getName

public String getName()

withName

public LoadScenario withName(String name)

getSteps

public List<LoadStep> getSteps()

withSteps

public LoadScenario withSteps(LoadStep... steps)

withSteps

public LoadScenario withSteps(List<LoadStep> steps)

getProfile

public LoadProfile getProfile()

withProfile

public LoadScenario withProfile(LoadProfile profile)

getTemplateType

public HttpTemplate.TemplateType getTemplateType()

withTemplateType

public LoadScenario withTemplateType(HttpTemplate.TemplateType templateType)

getMaxRequests

public Integer getMaxRequests()

withMaxRequests

public LoadScenario withMaxRequests(Integer maxRequests)

getStartDelayMillis

public long getStartDelayMillis()

The start delay in milliseconds applied after a start trigger before this scenario's iterations begin (default 0). See startDelayMillis.

withStartDelayMillis

public LoadScenario withStartDelayMillis(long startDelayMillis)

getLabels

public Map<String,String> getLabels()

Scenario-level custom labels (may be null/empty). See labels.

withLabels

public LoadScenario withLabels(Map<String,String> labels)

withLabel

public LoadScenario withLabel(String name,
 String value)

getThresholds

public List<LoadThreshold> getThresholds()

In-run pass/fail thresholds (may be null/empty). See thresholds.

withThresholds

public LoadScenario withThresholds(LoadThreshold... thresholds)

withThresholds

public LoadScenario withThresholds(List<LoadThreshold> thresholds)

isAbortOnFail

public boolean isAbortOnFail()

Whether a FAIL verdict aborts the run early (default false). See abortOnFail.

withAbortOnFail

public LoadScenario withAbortOnFail(boolean abortOnFail)

getAbortGraceMillis

public long getAbortGraceMillis()

The abort grace window in milliseconds (default 0). See abortGraceMillis.

withAbortGraceMillis

public LoadScenario withAbortGraceMillis(long abortGraceMillis)

getPacing

public LoadPacing getPacing()

Adaptive iteration pacing (may be null = no pacing). See pacing.

withPacing

public LoadScenario withPacing(LoadPacing pacing)

getFeeder

public LoadFeeder getFeeder()

The data feeder (may be null = no feeder). See feeder.

withFeeder

public LoadScenario withFeeder(LoadFeeder feeder)

getStepSelection

public LoadScenario.StepSelection getStepSelection()

The per-iteration step selection mode (may be null = LoadScenario.StepSelection.SEQUENTIAL). See stepSelection.

withStepSelection

public LoadScenario withStepSelection(LoadScenario.StepSelection stepSelection)