This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Reference

List of all possible steps and handlers that can be used for the benchmark development

1: Steps

1.1: addItem
1.2: addToInt
1.3: addToSharedCounter
1.4: awaitAllResponses
1.5: awaitDelay
1.6: awaitInt
1.7: awaitVar
1.8: breakIfFinished
1.9: breakSequence
1.10: clearHttpCache
1.11: conditional
1.12: fail
1.13: foreach
1.14: getIndex
1.15: getItem
1.16: getSharedCounter
1.17: getSize
1.18: hotrodRequest
1.19: httpRequest
1.20: json
1.21: log
1.22: loop
1.23: markRequestInvalid
1.24: newSequence
1.25: noop
1.26: publishAgentData
1.27: publishGlobalCounters
1.28: pullSharedMap
1.29: pushSharedMap
1.30: randomCsvRow
1.31: randomFile
1.32: randomInt
1.33: randomItem
1.34: randomUUID
1.35: readAgentData
1.36: removeItem
1.37: restartSequence
1.38: scheduleDelay
1.39: set
1.40: setInt
1.41: setItem
1.42: setSharedCounter
1.43: stop
1.44: stopwatch
1.45: stringToInt
1.46: template
1.47: thinkTime
1.48: timestamp
1.49: unset

2: Processors

2.1: addItem
2.2: addToInt
2.3: addToSharedCounter
2.4: array
2.5: clearHttpCache
2.6: closeConnection
2.7: collection
2.8: conditional
2.9: count
2.10: fail
2.11: getIndex
2.12: getItem
2.13: getSharedCounter
2.14: getSize
2.15: gzipInflator
2.16: json
2.17: log
2.18: logInvalid
2.19: markRequestInvalid
2.20: newSequence
2.21: parseHtml
2.22: publishAgentData
2.23: publishGlobalCounters
2.24: queue
2.25: readAgentData
2.26: removeItem
2.27: restartSequence
2.28: set
2.29: setInt
2.30: setItem
2.31: setSharedCounter
2.32: store
2.33: storeInt
2.34: stringToInt
2.35: unset

3: Actions

3.1: addItem
3.2: addToInt
3.3: addToSharedCounter
3.4: clearHttpCache
3.5: conditional
3.6: fail
3.7: getIndex
3.8: getItem
3.9: getSharedCounter
3.10: getSize
3.11: log
3.12: markRequestInvalid
3.13: newSequence
3.14: publishAgentData
3.15: publishGlobalCounters
3.16: readAgentData
3.17: removeItem
3.18: restartSequence
3.19: set
3.20: setInt
3.21: setItem
3.22: setSharedCounter
3.23: stringToInt
3.24: unset

Before exploring this reference you should be familiar with the basic structure of a benchmark. If you’re not sure what is the difference between the phase, scenario and sequence check out the concepts in user guide.

This reference lists all the steps and handlers used in a scenario. The lists below are not finite; you can also easily develop and use your own components, but Hyperfoil provides generic components for the most common tasks out of the box.

There are few generic types of components:

This documentation is auto-generated from Javadoc in source code, explaining format for each key-value pair in benchmark YAML. If there is an issue with these docs (e.g. property showing no description) please file an issue on GitHub.

This is the basic structure of the docs:

EXAMPLE

Example description.

Property	Type	Description
Key	Class	Explanation for the value

YAML syntax

EXAMPLE:
  Key: Value

For example, the POST definition in httpRequest step looks like this:

POST

Generic builder for generating a string.

Property	Type	Description
fromVar	String	Load the string from session variable.
pattern	String	Use pattern replacing session variables.
value	String	String value used verbatim.

YAML syntax

POST:
  pattern: /user/${userId}/info

You might be wondering why the documentation above does not mention anything about issuing a HTTP request. In fact the top-level POST property httpRequest says “Issue HTTP POST request to given path.” but the POST() method returns a generic string builder; this generic builder is used as the path for the HTTP request with POST method.

If the ’type’ is not a scalar value, the key in ‘property’ works as a link to further property mapping. It’s also possible that the property has multiple options, e.g. accepting both property mapping and list of values.

For brevity some components have inline definition like this:

SET

Set variable in session to certain value.

Inline definition
Use `var <- value`.

YAML syntax

set: myVar <- "This is my value"

Hyperfoil defines automatically generated JSON schema for the benchmark; you can use that in Visual Studio Code to automatically check the YAML syntax.

1 - Steps

Steps are the basic building blocks that form each sequence of a scenario, similar to statements in a programming language. Steps are potentially blocking (the sequence cannot continue with next step until previous one finishes).

Note that every action can be also used as a step that simply never blocks, as actions do not require any extra input.

1.1 - addItem

Appends value to an array stored in another variable.

Property	Type	Description
fromVar	String	Fetch value from session variable.
toVar	String	Destination variable with the array.
value	String	Verbatim value.

1.2 - addToInt

Add value to integer variable in the session.

Inline definition
Accepting one of: `var++`, `var–`, `var += value`, `var -= value`.

Property	Type	Description
orElseSetTo	int	If the variable is currently not set, set it to this value instead of addition.
value	int	Value added (can be negative).
var	String	Variable name.

1.3 - addToSharedCounter

Adds value to a counter shared by all sessions in the same executor.

Inline definition
Use on of: `counter++`, `counter–`, `counter += <value>`,
`counter -= <value>`

Property	Type	Description
fromVar	String	Input variable name.
key	String	Identifier for the counter.
operator	enum	Operation to perform on the counter. Default is `ADD`. Options: `ADD` `SUBTRACT`
value	int	Value (integer).

1.4 - awaitAllResponses

Block current sequence until all requests receive the response.

1.5 - awaitDelay

Block this sequence until referenced delay point.

Inline definition
Delay point created in `scheduleDelay.key`.

Property	Type	Description
key	String	Delay point created in `scheduleDelay.key`.

1.6 - awaitInt

Block current sequence until condition becomes true.

Property	Type	Description
equalTo	Builder	Compared variable must be equal to this value.
greaterOrEqualTo	Builder	Compared variable must be greater or equal to this value.
greaterThan	Builder	Compared variable must be greater than this value.
lessOrEqualTo	Builder	Compared variable must be lower or equal to this value.
lessThan	Builder	Compared variable must be lower than this value.
notEqualTo	Builder	Compared variable must not be equal to this value.
var	String	Variable name storing the compared value.

equalTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

greaterOrEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

greaterThan

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

lessOrEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

lessThan

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

notEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

1.7 - awaitVar

Block current sequence until this variable gets set/unset.

Inline definition
Variable name or `!variable` if we are waiting for it to be unset.

Property	Type	Description
var	String	Variable name or `!variable` if we are waiting for it to be unset.

1.8 - breakIfFinished

Stop execution of current sequence if the phase is in finished state.

This is useful for a long-running (looping) sequence that should not extend the duration of its phase.

1.9 - breakSequence

Prematurely stops execution of this sequence if the condition is satisfied.

Property	Type	Description
allConditions	Builder	Condition combining multiple other conditions with ‘AND’ logic.
boolCondition	Builder	Condition comparing boolean variables.
dependency	String	This step is blocked if this variable does not have set value (none by default).
intCondition	Builder	Condition comparing integer variables.
onBreak	Action.Builder	Action performed when the condition is true and the sequence is to be ended.
stringCondition	Builder	Condition comparing string variables.

allConditions

Test more conditions and combine the results using AND logic.

Property	Type	Description
<list of mappings>	<list of builders>	List of conditions.

allConditions.<list of mappings>

Selector for condition type.

Property	Type	Description
allConditions	Builder	Condition combining multiple other conditions with ‘AND’ logic.
boolCondition	Builder	Condition comparing boolean variables.
intCondition	Builder	Condition comparing integer variables.
stringCondition	Builder	Condition comparing string variables.

allConditions.<list of mappings>.allConditions

Test more conditions and combine the results using AND logic.

Property	Type	Description
<list of mappings>	<list of builders>	List of conditions.

allConditions.<list of mappings>.boolCondition

Tests session variable containing boolean value.

Property	Type	Description
fromVar	String	Variable name.
value	boolean	Expected value.

allConditions.<list of mappings>.intCondition

Condition comparing integer in session variable.

Inline definition
Parses condition in the form <variable> <operator> <value>
where operator is one of: `==`, `!=`,
`<>` (the same as `!=`),
`>=`, `>`, `<=`, `<`.

Property	Type	Description
equalTo	Builder	Compared variable must be equal to this value.
fromVar	Object	Variable name.
greaterOrEqualTo	Builder	Compared variable must be greater or equal to this value.
greaterThan	Builder	Compared variable must be greater than this value.
isSet	boolean	Check if the value is set or unset. By default the variable must be set.
lessOrEqualTo	Builder	Compared variable must be lower or equal to this value.
lessThan	Builder	Compared variable must be lower than this value.
notEqualTo	Builder	Compared variable must not be equal to this value.

allConditions.<list of mappings>.stringCondition

Condition comparing string in session variable.

Property	Type	Description
caseSensitive	boolean	True if the case must match, false if the check is case-insensitive.
endsWith	CharSequence	Suffix for the string.
equalTo	CharSequence	Literal value the string should match (the same as {@link #value}).
fromVar	Object	Variable name.
isSet	boolean	Check if the value is set or unset. By default the variable must be set.
length	int	Check the length of the string.
length (alternative)	Builder	Check the length of the string.
matchVar	String	Fetch the value from a variable.
negate	boolean	Invert the logic of this condition. Defaults to false.
notEqualTo	CharSequence	Value that the string must not match.
startsWith	CharSequence	Prefix for the string.
value	CharSequence	Literal value the string should match.

boolCondition

Tests session variable containing boolean value.

Property	Type	Description
fromVar	String	Variable name.
value	boolean	Expected value.

intCondition

Condition comparing integer in session variable.

Inline definition
Parses condition in the form <variable> <operator> <value>
where operator is one of: `==`, `!=`,
`<>` (the same as `!=`),
`>=`, `>`, `<=`, `<`.

Property	Type	Description
equalTo	Builder	Compared variable must be equal to this value.
fromVar	Object	Variable name.
greaterOrEqualTo	Builder	Compared variable must be greater or equal to this value.
greaterThan	Builder	Compared variable must be greater than this value.
isSet	boolean	Check if the value is set or unset. By default the variable must be set.
lessOrEqualTo	Builder	Compared variable must be lower or equal to this value.
lessThan	Builder	Compared variable must be lower than this value.
notEqualTo	Builder	Compared variable must not be equal to this value.

intCondition.equalTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

intCondition.greaterOrEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

intCondition.greaterThan

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

intCondition.lessOrEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

intCondition.lessThan

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

intCondition.notEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

stringCondition

Condition comparing string in session variable.

Property	Type	Description
caseSensitive	boolean	True if the case must match, false if the check is case-insensitive.
endsWith	CharSequence	Suffix for the string.
equalTo	CharSequence	Literal value the string should match (the same as {@link #value}).
fromVar	Object	Variable name.
isSet	boolean	Check if the value is set or unset. By default the variable must be set.
length	int	Check the length of the string.
length (alternative)	Builder	Check the length of the string.
matchVar	String	Fetch the value from a variable.
negate	boolean	Invert the logic of this condition. Defaults to false.
notEqualTo	CharSequence	Value that the string must not match.
startsWith	CharSequence	Prefix for the string.
value	CharSequence	Literal value the string should match.

stringCondition.length

Property	Type	Description
equalTo	Builder	Compared variable must be equal to this value.
greaterOrEqualTo	Builder	Compared variable must be greater or equal to this value.
greaterThan	Builder	Compared variable must be greater than this value.
lessOrEqualTo	Builder	Compared variable must be lower or equal to this value.
lessThan	Builder	Compared variable must be lower than this value.
notEqualTo	Builder	Compared variable must not be equal to this value.

stringCondition.length.equalTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

stringCondition.length.greaterOrEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

stringCondition.length.greaterThan

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

stringCondition.length.lessOrEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

stringCondition.length.lessThan

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

stringCondition.length.notEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

1.10 - clearHttpCache

Drops all entries from HTTP cache in the session.

1.11 - conditional

Perform an action or sequence of actions conditionally.

Property	Type	Description
actions	Action.Builder	Actions that should be executed should the condition hold.
allConditions	Builder	Condition combining multiple other conditions with ‘AND’ logic.
boolCondition	Builder	Condition comparing boolean variables.
intCondition	Builder	Condition comparing integer variables.
stringCondition	Builder	Condition comparing string variables.

allConditions

Test more conditions and combine the results using AND logic.

Property	Type	Description
<list of mappings>	<list of builders>	List of conditions.

allConditions.<list of mappings>

Selector for condition type.

Property	Type	Description
allConditions	Builder	Condition combining multiple other conditions with ‘AND’ logic.
boolCondition	Builder	Condition comparing boolean variables.
intCondition	Builder	Condition comparing integer variables.
stringCondition	Builder	Condition comparing string variables.

allConditions.<list of mappings>.allConditions

Test more conditions and combine the results using AND logic.

Property	Type	Description
<list of mappings>	<list of builders>	List of conditions.

allConditions.<list of mappings>.boolCondition

Tests session variable containing boolean value.

Property	Type	Description
fromVar	String	Variable name.
value	boolean	Expected value.

allConditions.<list of mappings>.intCondition

Condition comparing integer in session variable.

Inline definition
Parses condition in the form <variable> <operator> <value>
where operator is one of: `==`, `!=`,
`<>` (the same as `!=`),
`>=`, `>`, `<=`, `<`.

Property	Type	Description
equalTo	Builder	Compared variable must be equal to this value.
fromVar	Object	Variable name.
greaterOrEqualTo	Builder	Compared variable must be greater or equal to this value.
greaterThan	Builder	Compared variable must be greater than this value.
isSet	boolean	Check if the value is set or unset. By default the variable must be set.
lessOrEqualTo	Builder	Compared variable must be lower or equal to this value.
lessThan	Builder	Compared variable must be lower than this value.
notEqualTo	Builder	Compared variable must not be equal to this value.

allConditions.<list of mappings>.stringCondition

Condition comparing string in session variable.

Property	Type	Description
caseSensitive	boolean	True if the case must match, false if the check is case-insensitive.
endsWith	CharSequence	Suffix for the string.
equalTo	CharSequence	Literal value the string should match (the same as {@link #value}).
fromVar	Object	Variable name.
isSet	boolean	Check if the value is set or unset. By default the variable must be set.
length	int	Check the length of the string.
length (alternative)	Builder	Check the length of the string.
matchVar	String	Fetch the value from a variable.
negate	boolean	Invert the logic of this condition. Defaults to false.
notEqualTo	CharSequence	Value that the string must not match.
startsWith	CharSequence	Prefix for the string.
value	CharSequence	Literal value the string should match.

boolCondition

Tests session variable containing boolean value.

Property	Type	Description
fromVar	String	Variable name.
value	boolean	Expected value.

intCondition

Condition comparing integer in session variable.

Inline definition
Parses condition in the form <variable> <operator> <value>
where operator is one of: `==`, `!=`,
`<>` (the same as `!=`),
`>=`, `>`, `<=`, `<`.

Property	Type	Description
equalTo	Builder	Compared variable must be equal to this value.
fromVar	Object	Variable name.
greaterOrEqualTo	Builder	Compared variable must be greater or equal to this value.
greaterThan	Builder	Compared variable must be greater than this value.
isSet	boolean	Check if the value is set or unset. By default the variable must be set.
lessOrEqualTo	Builder	Compared variable must be lower or equal to this value.
lessThan	Builder	Compared variable must be lower than this value.
notEqualTo	Builder	Compared variable must not be equal to this value.

intCondition.equalTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

intCondition.greaterOrEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

intCondition.greaterThan

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

intCondition.lessOrEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

intCondition.lessThan

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

intCondition.notEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

stringCondition

Condition comparing string in session variable.

Property	Type	Description
caseSensitive	boolean	True if the case must match, false if the check is case-insensitive.
endsWith	CharSequence	Suffix for the string.
equalTo	CharSequence	Literal value the string should match (the same as {@link #value}).
fromVar	Object	Variable name.
isSet	boolean	Check if the value is set or unset. By default the variable must be set.
length	int	Check the length of the string.
length (alternative)	Builder	Check the length of the string.
matchVar	String	Fetch the value from a variable.
negate	boolean	Invert the logic of this condition. Defaults to false.
notEqualTo	CharSequence	Value that the string must not match.
startsWith	CharSequence	Prefix for the string.
value	CharSequence	Literal value the string should match.

stringCondition.length

Property	Type	Description
equalTo	Builder	Compared variable must be equal to this value.
greaterOrEqualTo	Builder	Compared variable must be greater or equal to this value.
greaterThan	Builder	Compared variable must be greater than this value.
lessOrEqualTo	Builder	Compared variable must be lower or equal to this value.
lessThan	Builder	Compared variable must be lower than this value.
notEqualTo	Builder	Compared variable must not be equal to this value.

stringCondition.length.equalTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

stringCondition.length.greaterOrEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

stringCondition.length.greaterThan

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

stringCondition.length.lessOrEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

stringCondition.length.lessThan

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

stringCondition.length.notEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

1.12 - fail

Fail the phase with given message. Used mostly for testing/debugging.

Inline definition
Message to fail with (unconditionally).

Property	Type	Description
allConditions	Builder	Condition combining multiple other conditions with ‘AND’ logic.
boolCondition	Builder	Condition comparing boolean variables.
intCondition	Builder	Condition comparing integer variables.
message	String	Message attached to the failure exception.
stringCondition	Builder	Condition comparing string variables.

allConditions

Test more conditions and combine the results using AND logic.

Property	Type	Description
<list of mappings>	<list of builders>	List of conditions.

allConditions.<list of mappings>

Selector for condition type.

Property	Type	Description
allConditions	Builder	Condition combining multiple other conditions with ‘AND’ logic.
boolCondition	Builder	Condition comparing boolean variables.
intCondition	Builder	Condition comparing integer variables.
stringCondition	Builder	Condition comparing string variables.

allConditions.<list of mappings>.allConditions

Test more conditions and combine the results using AND logic.

Property	Type	Description
<list of mappings>	<list of builders>	List of conditions.

allConditions.<list of mappings>.boolCondition

Tests session variable containing boolean value.

Property	Type	Description
fromVar	String	Variable name.
value	boolean	Expected value.

allConditions.<list of mappings>.intCondition

Condition comparing integer in session variable.

Inline definition
Parses condition in the form <variable> <operator> <value>
where operator is one of: `==`, `!=`,
`<>` (the same as `!=`),
`>=`, `>`, `<=`, `<`.

Property	Type	Description
equalTo	Builder	Compared variable must be equal to this value.
fromVar	Object	Variable name.
greaterOrEqualTo	Builder	Compared variable must be greater or equal to this value.
greaterThan	Builder	Compared variable must be greater than this value.
isSet	boolean	Check if the value is set or unset. By default the variable must be set.
lessOrEqualTo	Builder	Compared variable must be lower or equal to this value.
lessThan	Builder	Compared variable must be lower than this value.
notEqualTo	Builder	Compared variable must not be equal to this value.

allConditions.<list of mappings>.stringCondition

Condition comparing string in session variable.

Property	Type	Description
caseSensitive	boolean	True if the case must match, false if the check is case-insensitive.
endsWith	CharSequence	Suffix for the string.
equalTo	CharSequence	Literal value the string should match (the same as {@link #value}).
fromVar	Object	Variable name.
isSet	boolean	Check if the value is set or unset. By default the variable must be set.
length	int	Check the length of the string.
length (alternative)	Builder	Check the length of the string.
matchVar	String	Fetch the value from a variable.
negate	boolean	Invert the logic of this condition. Defaults to false.
notEqualTo	CharSequence	Value that the string must not match.
startsWith	CharSequence	Prefix for the string.
value	CharSequence	Literal value the string should match.

boolCondition

Tests session variable containing boolean value.

Property	Type	Description
fromVar	String	Variable name.
value	boolean	Expected value.

intCondition

Condition comparing integer in session variable.

Inline definition
Parses condition in the form <variable> <operator> <value>
where operator is one of: `==`, `!=`,
`<>` (the same as `!=`),
`>=`, `>`, `<=`, `<`.

Property	Type	Description
equalTo	Builder	Compared variable must be equal to this value.
fromVar	Object	Variable name.
greaterOrEqualTo	Builder	Compared variable must be greater or equal to this value.
greaterThan	Builder	Compared variable must be greater than this value.
isSet	boolean	Check if the value is set or unset. By default the variable must be set.
lessOrEqualTo	Builder	Compared variable must be lower or equal to this value.
lessThan	Builder	Compared variable must be lower than this value.
notEqualTo	Builder	Compared variable must not be equal to this value.

intCondition.equalTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

intCondition.greaterOrEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

intCondition.greaterThan

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

intCondition.lessOrEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

intCondition.lessThan

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

intCondition.notEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

stringCondition

Condition comparing string in session variable.

Property	Type	Description
caseSensitive	boolean	True if the case must match, false if the check is case-insensitive.
endsWith	CharSequence	Suffix for the string.
equalTo	CharSequence	Literal value the string should match (the same as {@link #value}).
fromVar	Object	Variable name.
isSet	boolean	Check if the value is set or unset. By default the variable must be set.
length	int	Check the length of the string.
length (alternative)	Builder	Check the length of the string.
matchVar	String	Fetch the value from a variable.
negate	boolean	Invert the logic of this condition. Defaults to false.
notEqualTo	CharSequence	Value that the string must not match.
startsWith	CharSequence	Prefix for the string.
value	CharSequence	Literal value the string should match.

stringCondition.length

Property	Type	Description
equalTo	Builder	Compared variable must be equal to this value.
greaterOrEqualTo	Builder	Compared variable must be greater or equal to this value.
greaterThan	Builder	Compared variable must be greater than this value.
lessOrEqualTo	Builder	Compared variable must be lower or equal to this value.
lessThan	Builder	Compared variable must be lower than this value.
notEqualTo	Builder	Compared variable must not be equal to this value.

stringCondition.length.equalTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

stringCondition.length.greaterOrEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

stringCondition.length.greaterThan

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

stringCondition.length.lessOrEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

stringCondition.length.lessThan

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

stringCondition.length.notEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

1.13 - foreach

Instantiate new sequences based on array variable content.

Property	Type	Description
counterVar	String	Variable to be set to the number of created sequences (optional).
dependency	String	This step is blocked if this variable does not have set value (none by default).
fromVar	String	Variable holding the array.
sequence	String	Name of the instantiated sequence.

1.14 - getIndex

Lookup index of an item in an array/collection.

Property	Type	Description
collection	String	Variable to fetch the collection from.
item	Builder	Item that should be looked up (using equality).
toVar	String	Integer variable to store the index, or -1 if the item is not found.

item

Inline definition
Verbatim value.

Property	Type	Description
fromVar	String	Fetch value from session variable.
value	String	Verbatim value.

1.15 - getItem

Retrieves n-th item from an array or collection.

Property	Type	Description
fromVar	String	Source variable with an array or list.
index	Builder	Source for index into the array/list.
toVar	String	Destination variable for the n-th element.

index

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

1.16 - getSharedCounter

Retrieves value from a counter shared by all sessions in the same executor and stores that in a session variable.

Retrieves value from a counter shared by all sessions in the same executor and stores that in a session variable.
If the value exceeds allowed integer range (-2^31 .. 2^31 - 1) it is capped.

Inline definition
Both the key and variable name.

Property	Type	Description
key	String	Identifier for the counter.
toVar	String	Session variable for storing the value.

1.17 - getSize

Calculates size of an array/collection held in variable into another variable

Property	Type	Description
boolFilter	Builder	Count only items matching the condition.
fromVar	String	Variable holding the collection.
intFilter	Builder	Count only items matching the condition.
stringFilter	Builder	Count only items matching the condition.
toVar	String	Variable storing the size.
undefinedValue	int	Value to use when `fromVar` is unset or it does not contain any array/collection.

boolFilter

Property	Type	Description
value	boolean	Expected value.

intFilter

Property	Type	Description
equalTo	Builder	Compared variable must be equal to this value.
greaterOrEqualTo	Builder	Compared variable must be greater or equal to this value.
greaterThan	Builder	Compared variable must be greater than this value.
lessOrEqualTo	Builder	Compared variable must be lower or equal to this value.
lessThan	Builder	Compared variable must be lower than this value.
notEqualTo	Builder	Compared variable must not be equal to this value.

intFilter.equalTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

intFilter.greaterOrEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

intFilter.greaterThan

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

intFilter.lessOrEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

intFilter.lessThan

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

intFilter.notEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

stringFilter

Property	Type	Description
caseSensitive	boolean	True if the case must match, false if the check is case-insensitive.
endsWith	CharSequence	Suffix for the string.
equalTo	CharSequence	Literal value the string should match (the same as {@link #value}).
length	int	Check the length of the string.
length (alternative)	Builder	Check the length of the string.
matchVar	String	Fetch the value from a variable.
negate	boolean	Invert the logic of this condition. Defaults to false.
notEqualTo	CharSequence	Value that the string must not match.
startsWith	CharSequence	Prefix for the string.
value	CharSequence	Literal value the string should match.

stringFilter.length

Property	Type	Description
equalTo	Builder	Compared variable must be equal to this value.
greaterOrEqualTo	Builder	Compared variable must be greater or equal to this value.
greaterThan	Builder	Compared variable must be greater than this value.
lessOrEqualTo	Builder	Compared variable must be lower or equal to this value.
lessThan	Builder	Compared variable must be lower than this value.
notEqualTo	Builder	Compared variable must not be equal to this value.

stringFilter.length.equalTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

stringFilter.length.greaterOrEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

stringFilter.length.greaterThan

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

stringFilter.length.lessOrEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

stringFilter.length.lessThan

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

stringFilter.length.notEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

1.18 - hotrodRequest

Issues a HotRod request and registers handlers for the response.

Property	Type	Description
cacheName	String	Name of the cache used for the operation. This can be a pattern.
cacheName (alternative)	Builder	<no description>
get	String	Get specified entry in the remote cache.
key	String	Key used for the operation. This can be a pattern.
key (alternative)	Builder	<no description>
metric	String	Requests statistics will use this metric name.
metric (alternative)	<list of strings>	Allows categorizing request statistics into metrics based on the request path.
operation	enum	Options: `PUT`Adds or overrides each specified entry in the remote cache. `GET`Get specified entry in the remote cache.
put	String	Adds or overrides each specified entry in the remote cache.
value	String	Value for the operation. This can be a pattern.
value (alternative)	Builder	<no description>

cacheName

Generic builder for generating a string.

Inline definition
A pattern for string interpolation.

Property	Type	Description
fromVar	Object	Load the string from session variable.
pattern	String	Use pattern replacing session variables.
value	String	String value used verbatim.

key

Generic builder for generating a string.

Inline definition
A pattern for string interpolation.

Property	Type	Description
fromVar	Object	Load the string from session variable.
pattern	String	Use pattern replacing session variables.
value	String	String value used verbatim.

metric

Allows categorizing request statistics into metrics based on the request path.

Property	Type	Description
<list of strings>	<list of strings>	Allows categorizing request statistics into metrics based on the request path. The expressions are evaluated in the order as provided in the list. Use one of: `regexp -> replacement`, e.g. `([^?])(?.)? -> $1` to drop the query part. `regexp` (don’t do any replaces and use the full path), e.g. `.*.jpg` `-> name` (metric applied if none of the previous expressions match).

value

Generic builder for generating a string.

Inline definition
A pattern for string interpolation.

Property	Type	Description
fromVar	Object	Load the string from session variable.
pattern	String	Use pattern replacing session variables.
value	String	String value used verbatim.

1.19 - httpRequest

Issues a HTTP request and registers handlers for the response.

Property	Type	Description
authority	String	HTTP authority (host:port) this request should target. Must match one of the entries in `http` section. The string can use string interpolation.
authority (alternative)	Builder	HTTP authority (host:port) this request should target. Must match one of the entries in `http` section.
body	Builder	HTTP request body.
body (alternative)	String	HTTP request body (possibly a pattern).
compensation	Builder	Configures additional metric compensated for coordinated omission.
compression	Builder	Configure response compression.
compression (alternative)	String	Request server to respond with compressed entity using specified content encoding.
CONNECT	String	Issue HTTP CONNECT request to given path. This can be a pattern.
CONNECT (alternative)	Builder	Issue HTTP CONNECT request to given path.
DELETE	String	Issue HTTP DELETE request to given path. This can be a pattern.
DELETE (alternative)	Builder	Issue HTTP DELETE request to given path.
endpoint	Builder	HTTP endpoint this request should target. Must match to the `name` of the entries in `http` section.
GET	String	Issue HTTP GET request to given path. This can be a pattern.
GET (alternative)	Builder	Issue HTTP GET request to given path.
handler	Builder	HTTP response handlers.
HEAD	String	Issue HTTP HEAD request to given path. This can be a pattern.
HEAD (alternative)	Builder	Issue HTTP HEAD request to given path.
headers	Builder	HTTP headers sent in the request.
method	enum	HTTP method used for the request. Options: `GET` `HEAD` `POST` `PUT` `DELETE` `OPTIONS` `PATCH` `TRACE` `CONNECT`
metric	String	Requests statistics will use this metric name.
metric (alternative)	<list of strings>	Allows categorizing request statistics into metrics based on the request path.
OPTIONS	String	Issue HTTP OPTIONS request to given path. This can be a pattern.
OPTIONS (alternative)	Builder	Issue HTTP OPTIONS request to given path.
PATCH	String	Issue HTTP PATCH request to given path. This can be a pattern.
PATCH (alternative)	Builder	Issue HTTP PATCH request to given path.
path	String	HTTP path (absolute or relative), including query and fragment. The string can use string interpolation.
path (alternative)	Builder	HTTP path (absolute or relative), including query and fragment.
POST	String	Issue HTTP POST request to given path. This can be a pattern.
POST (alternative)	Builder	Issue HTTP POST request to given path.
PUT	String	Issue HTTP PUT request to given path. This can be a pattern.
PUT (alternative)	Builder	Issue HTTP PUT request to given path.
sla	Builder	List of SLAs the requests are subject to.
sync	boolean	This request is synchronous; execution of the sequence does not continue until the full response is received. If this step is executed from multiple parallel instances of this sequence the progress of all sequences is blocked until there is a request in flight without response. Default is `true`.
timeout	String	Request timeout - after this time the request will be marked as failed and connection will be closed. Defaults to value set globally in `http` section.
TRACE	String	Issue HTTP TRACE request to given path. This can be a pattern.
TRACE (alternative)	Builder	Issue HTTP TRACE request to given path.

authority

Generic builder for generating a string.

Inline definition
A pattern for string interpolation.

Property	Type	Description
fromVar	Object	Load the string from session variable.
pattern	String	Use pattern replacing session variables.
value	String	String value used verbatim.

body

Allows building HTTP request body from session variables.

Property	Type	Description
form	Builder	Build form as if we were sending the request using HTML form. This option automatically adds `Content-Type: application/x-www-form-urlencoded` to the request headers.
fromFile	String	Send contents of the file. Note that this method does NOT set content-type automatically.
fromVar	String	Use variable content as request body.
pattern	String	Pattern replacing `${sessionvar}` with variable contents in a string.
text	String	String sent as-is.

body.form

Property	Type	Description
<list of mappings>	<list of builders>	Add input pair described in the mapping.

body.form.<list of mappings>

Form element (e.g. as if coming from an INPUT field).

Property	Type	Description
fromVar	String	Input field value from session variable.
name	String	Input field name.
pattern	String	Input field value replacing session variables in a pattern, e.g. `foo${myvariable}var`
value	String	Input field value (verbatim).

compensation

Property	Type	Description
metric	String	Metric name for the compensated results.
metric (alternative)	<list of strings>	Configure a custom metric for the compensated results.
targetRate	double	Desired rate of new virtual users per second. This is similar to `constantRate.usersPerSec` phase settings but works closer to legacy benchmark drivers by fixing the concurrency.
targetRate (alternative)	Builder	Desired rate of new virtual users per second. This is similar to `constantRate.usersPerSec` phase settings but works closer to legacy benchmark drivers by fixing the concurrency.

compensation.metric

Configure a custom metric for the compensated results.

Property	Type	Description
<list of strings>	<list of strings>	Allows categorizing request statistics into metrics based on the request path. The expressions are evaluated in the order as provided in the list. Use one of: `regexp -> replacement`, e.g. `([^?])(?.)? -> $1` to drop the query part. `regexp` (don’t do any replaces and use the full path), e.g. `.*.jpg` `-> name` (metric applied if none of the previous expressions match).

compensation.targetRate

Property	Type	Description
base	double	Base value used for first iteration.
increment	double	Value by which the base value is incremented for each (but the very first) iteration.

compression

Property	Type	Description
encoding	String	Encoding used for `Accept-Encoding`/`TE` header. The only currently supported is `gzip`.
type	enum	Type of compression (resource vs. transfer based). Options: `CONTENT_ENCODING`Use `Accept-Encoding` in request and expect `Content-Encoding` in response. `TRANSFER_ENCODING`Use `TE` in request and expect `Transfer-Encoding` in response.

CONNECT

Generic builder for generating a string.

Inline definition
A pattern for string interpolation.

Property	Type	Description
fromVar	Object	Load the string from session variable.
pattern	String	Use pattern replacing session variables.
value	String	String value used verbatim.

DELETE

Generic builder for generating a string.

Inline definition
A pattern for string interpolation.

Property	Type	Description
fromVar	Object	Load the string from session variable.
pattern	String	Use pattern replacing session variables.
value	String	String value used verbatim.

endpoint

Generic builder for generating a string.

Inline definition
A pattern for string interpolation.

Property	Type	Description
fromVar	Object	Load the string from session variable.
pattern	String	Use pattern replacing session variables.
value	String	String value used verbatim.

GET

Generic builder for generating a string.

Inline definition
A pattern for string interpolation.

Property	Type	Description
fromVar	Object	Load the string from session variable.
pattern	String	Use pattern replacing session variables.
value	String	String value used verbatim.

handler

Manages processing of HTTP responses.

Property	Type	Description
autoRangeCheck	boolean	Inject status handler that marks the request as invalid on status 4xx or 5xx. Default value depends on `ergonomics.autoRangeCheck` (see User Guide).
body	Processor.Builder	Handle HTTP response body.
followRedirect	enum	Automatically fire requests when the server responds with redirection. Default value depends on `ergonomics.followRedirect` (see User Guide). Options: `NEVER`Do not insert any automatic redirection handling. `LOCATION_ONLY`Redirect only upon status 3xx accompanied with a ’location’ header. Status, headers, body and completions handlers are suppressed in this case (only raw-bytes handlers are still running). This is the default option. `HTML_ONLY`Handle only HTML response with META refresh header. Status, headers and body handlers are invoked both on the original response and on the response from subsequent requests. Completion handlers are suppressed on this request and invoked after the last response arrives (in case of multiple redirections). `ALWAYS`Implement both status 3xx + location and HTML redirects.
header	HeaderHandler.Builder	Handle HTTP response headers.
onCompletion	Action.Builder	Action executed when the HTTP response is fully received.
rawBytes	RawBytesHandler.Builder	Handler processing HTTP response before parsing.
status	StatusHandler.Builder	Handle HTTP response status.
stopOnInvalid	boolean	Inject completion handler that will stop the session if the request has been marked as invalid. Default value depends on `ergonomics.stopOnInvalid` (see User Guide).

handler.header

Handle HTTP response headers.

Property	Type	Description
conditional	ConditionalHeaderHandler.Builder	Passes the headers to nested handler if the condition holds. Note that the condition may be evaluated multiple times and therefore any nested handlers should not change the results of the condition.
countHeaders	CountHeadersHandler.Builder	Stores number of occurences of each header in custom statistics (these can be displayed in CLI using the `stats -c` command).
filter	FilterHeaderHandler.Builder	Compares if the header name matches expression and invokes a processor with the value.
logInvalid	LogInvalidHandler.HeaderHandlerBuilder	Logs headers from requests marked as invalid.
recordHeaderTime	RecordHeaderTimeHandler.Builder	Records alternative metric based on values from a header (e.g. when a proxy reports processing time).

handler.header.conditional

Passes the headers to nested handler if the condition holds. Note that the condition may be evaluated multiple times and therefore any nested handlers should not change the results of the condition.

Property	Type	Description
allConditions	Builder	Condition combining multiple other conditions with ‘AND’ logic.
boolCondition	Builder	Condition comparing boolean variables.
handler	HeaderHandler.Builder	One or more header handlers that should be invoked.
intCondition	Builder	Condition comparing integer variables.
stringCondition	Builder	Condition comparing string variables.

handler.header.conditional.allConditions

Test more conditions and combine the results using AND logic.

Property	Type	Description
<list of mappings>	<list of builders>	List of conditions.

handler.header.conditional.allConditions.<list of mappings>

Selector for condition type.

Property	Type	Description
allConditions	Builder	Condition combining multiple other conditions with ‘AND’ logic.
boolCondition	Builder	Condition comparing boolean variables.
intCondition	Builder	Condition comparing integer variables.
stringCondition	Builder	Condition comparing string variables.

handler.header.conditional.allConditions.<list of mappings>.allConditions

Test more conditions and combine the results using AND logic.

Property	Type	Description
<list of mappings>	<list of builders>	List of conditions.

handler.header.conditional.allConditions.<list of mappings>.boolCondition

Tests session variable containing boolean value.

Property	Type	Description
fromVar	String	Variable name.
value	boolean	Expected value.

handler.header.conditional.allConditions.<list of mappings>.intCondition

Condition comparing integer in session variable.

Inline definition
Parses condition in the form <variable> <operator> <value>
where operator is one of: `==`, `!=`,
`<>` (the same as `!=`),
`>=`, `>`, `<=`, `<`.

Property	Type	Description
equalTo	Builder	Compared variable must be equal to this value.
fromVar	Object	Variable name.
greaterOrEqualTo	Builder	Compared variable must be greater or equal to this value.
greaterThan	Builder	Compared variable must be greater than this value.
isSet	boolean	Check if the value is set or unset. By default the variable must be set.
lessOrEqualTo	Builder	Compared variable must be lower or equal to this value.
lessThan	Builder	Compared variable must be lower than this value.
notEqualTo	Builder	Compared variable must not be equal to this value.

handler.header.conditional.allConditions.<list of mappings>.stringCondition

Condition comparing string in session variable.

Property	Type	Description
caseSensitive	boolean	True if the case must match, false if the check is case-insensitive.
endsWith	CharSequence	Suffix for the string.
equalTo	CharSequence	Literal value the string should match (the same as {@link #value}).
fromVar	Object	Variable name.
isSet	boolean	Check if the value is set or unset. By default the variable must be set.
length	int	Check the length of the string.
length (alternative)	Builder	Check the length of the string.
matchVar	String	Fetch the value from a variable.
negate	boolean	Invert the logic of this condition. Defaults to false.
notEqualTo	CharSequence	Value that the string must not match.
startsWith	CharSequence	Prefix for the string.
value	CharSequence	Literal value the string should match.

handler.header.conditional.boolCondition

Tests session variable containing boolean value.

Property	Type	Description
fromVar	String	Variable name.
value	boolean	Expected value.

handler.header.conditional.handler

One or more header handlers that should be invoked.

Property	Type	Description
conditional	ConditionalHeaderHandler.Builder	Passes the headers to nested handler if the condition holds. Note that the condition may be evaluated multiple times and therefore any nested handlers should not change the results of the condition.
countHeaders	CountHeadersHandler.Builder	Stores number of occurences of each header in custom statistics (these can be displayed in CLI using the `stats -c` command).
filter	FilterHeaderHandler.Builder	Compares if the header name matches expression and invokes a processor with the value.
logInvalid	LogInvalidHandler.HeaderHandlerBuilder	Logs headers from requests marked as invalid.
recordHeaderTime	RecordHeaderTimeHandler.Builder	Records alternative metric based on values from a header (e.g. when a proxy reports processing time).

handler.header.conditional.intCondition

Condition comparing integer in session variable.

Inline definition
Parses condition in the form <variable> <operator> <value>
where operator is one of: `==`, `!=`,
`<>` (the same as `!=`),
`>=`, `>`, `<=`, `<`.

Property	Type	Description
equalTo	Builder	Compared variable must be equal to this value.
fromVar	Object	Variable name.
greaterOrEqualTo	Builder	Compared variable must be greater or equal to this value.
greaterThan	Builder	Compared variable must be greater than this value.
isSet	boolean	Check if the value is set or unset. By default the variable must be set.
lessOrEqualTo	Builder	Compared variable must be lower or equal to this value.
lessThan	Builder	Compared variable must be lower than this value.
notEqualTo	Builder	Compared variable must not be equal to this value.

handler.header.conditional.intCondition.equalTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

handler.header.conditional.intCondition.greaterOrEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

handler.header.conditional.intCondition.greaterThan

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

handler.header.conditional.intCondition.lessOrEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

handler.header.conditional.intCondition.lessThan

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

handler.header.conditional.intCondition.notEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

handler.header.conditional.stringCondition

Condition comparing string in session variable.

Property	Type	Description
caseSensitive	boolean	True if the case must match, false if the check is case-insensitive.
endsWith	CharSequence	Suffix for the string.
equalTo	CharSequence	Literal value the string should match (the same as {@link #value}).
fromVar	Object	Variable name.
isSet	boolean	Check if the value is set or unset. By default the variable must be set.
length	int	Check the length of the string.
length (alternative)	Builder	Check the length of the string.
matchVar	String	Fetch the value from a variable.
negate	boolean	Invert the logic of this condition. Defaults to false.
notEqualTo	CharSequence	Value that the string must not match.
startsWith	CharSequence	Prefix for the string.
value	CharSequence	Literal value the string should match.

handler.header.conditional.stringCondition.length

Property	Type	Description
equalTo	Builder	Compared variable must be equal to this value.
greaterOrEqualTo	Builder	Compared variable must be greater or equal to this value.
greaterThan	Builder	Compared variable must be greater than this value.
lessOrEqualTo	Builder	Compared variable must be lower or equal to this value.
lessThan	Builder	Compared variable must be lower than this value.
notEqualTo	Builder	Compared variable must not be equal to this value.

handler.header.conditional.stringCondition.length.equalTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

handler.header.conditional.stringCondition.length.greaterOrEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

handler.header.conditional.stringCondition.length.greaterThan

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

handler.header.conditional.stringCondition.length.lessOrEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

handler.header.conditional.stringCondition.length.lessThan

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

handler.header.conditional.stringCondition.length.notEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

handler.header.filter

Compares if the header name matches expression and invokes a processor with the value.

Property	Type	Description
header	Builder	Condition on the header name.
processor	Processor.Builder	Add one or more processors.

handler.header.filter.header

Inline definition
Literal value the string should match.

Property	Type	Description
caseSensitive	boolean	True if the case must match, false if the check is case-insensitive.
endsWith	CharSequence	Suffix for the string.
equalTo	CharSequence	Literal value the string should match (the same as {@link #value}).
length	int	Check the length of the string.
length (alternative)	Builder	Check the length of the string.
matchVar	String	Fetch the value from a variable.
negate	boolean	Invert the logic of this condition. Defaults to false.
notEqualTo	CharSequence	Value that the string must not match.
startsWith	CharSequence	Prefix for the string.
value	CharSequence	Literal value the string should match.

handler.header.filter.header.length

Property	Type	Description
equalTo	Builder	Compared variable must be equal to this value.
greaterOrEqualTo	Builder	Compared variable must be greater or equal to this value.
greaterThan	Builder	Compared variable must be greater than this value.
lessOrEqualTo	Builder	Compared variable must be lower or equal to this value.
lessThan	Builder	Compared variable must be lower than this value.
notEqualTo	Builder	Compared variable must not be equal to this value.

handler.header.recordHeaderTime

Records alternative metric based on values from a header (e.g. when a proxy reports processing time).

Property	Type	Description
header	String	Header carrying the time.
metric	String	Name of the created metric.
unit	String	Time unit in the header; use either `ms` or `ns`.

handler.rawBytes

Handler processing HTTP response before parsing.

Property	Type	Description
transferSizeRecorder	TransferSizeRecorder.Builder	Accumulates request and response sizes into custom metrics.

handler.rawBytes.transferSizeRecorder

Accumulates request and response sizes into custom metrics.

Property	Type	Description
key	String	Name of the custom metric for collecting request/response bytes.

handler.status

Handle HTTP response status.

Property	Type	Description
action	ActionStatusHandler.Builder	Perform certain actions when the status falls into a range.
counter	StatusToCounterHandler.Builder	Counts how many times given status is received.
multiplex	MultiplexStatusHandler.Builder	Multiplexes the status based on range into different status handlers.
range	RangeStatusValidator.Builder	Marks requests that don’t fall into the desired range as invalid.
stats	StatusToStatsHandler.Builder	Records number of occurrences of each status counts into custom statistics (these can be displayed in CLI using `stats -c`).
store	StoreStatusHandler.Builder	Stores the status into session variable.

handler.status.action

Perform certain actions when the status falls into a range.

Property	Type	Description
<any>	Builder	Perform a sequence of actions if the range matches. Use range as the key and action in the mapping. Possible values of the status should be separated by commas (,). Ranges can be set using low-high (inclusive) (e.g. 200-299), or replacing lower digits with ‘x’ (e.g. 2xx).

handler.status.counter

Counts how many times given status is received.

Property	Type	Description
add	int	Number to be added to the session variable.
expectStatus	int	Expected status (others are ignored). All status codes match by default.
init	int	Initial value for the session variable.
set	int	Do not accumulate (add), just set the variable to this value.
var	String	Variable name.

handler.status.multiplex

Multiplexes the status based on range into different status handlers.

Property	Type	Description
<any>	Builder	Run another handler if the range matches. Use range as the key and another status handler in the mapping. Possible values of the status should be separated by commas (,). Ranges can be set using low-high (inclusive) (e.g. 200-299), or replacing lower digits with ‘x’ (e.g. 2xx).

handler.status.multiplex.<any>

Run another handler if the range matches. Use range as the key and another status handler in the mapping. Possible values of the status should be separated by commas (,). Ranges can be set using low-high (inclusive) (e.g. 200-299), or replacing lower digits with ‘x’ (e.g. 2xx).

Property	Type	Description
action	ActionStatusHandler.Builder	Perform certain actions when the status falls into a range.
counter	StatusToCounterHandler.Builder	Counts how many times given status is received.
multiplex	MultiplexStatusHandler.Builder	Multiplexes the status based on range into different status handlers.
range	RangeStatusValidator.Builder	Marks requests that don’t fall into the desired range as invalid.
stats	StatusToStatsHandler.Builder	Records number of occurrences of each status counts into custom statistics (these can be displayed in CLI using `stats -c`).
store	StoreStatusHandler.Builder	Stores the status into session variable.

handler.status.range

Marks requests that don’t fall into the desired range as invalid.

Inline definition
Single status code (`204`), masked code (`2xx`) or range (`200-399`).

Property	Type	Description
max	int	Highest accepted status code.
min	int	Lowest accepted status code.

handler.status.store

Stores the status into session variable.

Inline definition
Variable name.

Property	Type	Description
toVar	Object	Variable name.

HEAD

Generic builder for generating a string.

Inline definition
A pattern for string interpolation.

Property	Type	Description
fromVar	Object	Load the string from session variable.
pattern	String	Use pattern replacing session variables.
value	String	String value used verbatim.

headers

Property	Type	Description
<any>	String	Use header name (e.g. `Content-Type`) as key and value (possibly a pattern).
<any> (alternative)	Builder	Use header name (e.g. `Content-Type`) as key and specify value in the mapping.

headers.<any>

Specifies value that should be sent in headers.

Inline definition
The value. This can be a pattern.

Property	Type	Description
fromVar	String	Load header value from session variable.
pattern	String	Load header value using a pattern.

metric

Allows categorizing request statistics into metrics based on the request path.

Property	Type	Description
<list of strings>	<list of strings>	Allows categorizing request statistics into metrics based on the request path. The expressions are evaluated in the order as provided in the list. Use one of: `regexp -> replacement`, e.g. `([^?])(?.)? -> $1` to drop the query part. `regexp` (don’t do any replaces and use the full path), e.g. `.*.jpg` `-> name` (metric applied if none of the previous expressions match).

OPTIONS

Generic builder for generating a string.

Inline definition
A pattern for string interpolation.

Property	Type	Description
fromVar	Object	Load the string from session variable.
pattern	String	Use pattern replacing session variables.
value	String	String value used verbatim.

PATCH

Generic builder for generating a string.

Inline definition
A pattern for string interpolation.

Property	Type	Description
fromVar	Object	Load the string from session variable.
pattern	String	Use pattern replacing session variables.
value	String	String value used verbatim.

path

Generic builder for generating a string.

Inline definition
A pattern for string interpolation.

Property	Type	Description
fromVar	Object	Load the string from session variable.
pattern	String	Use pattern replacing session variables.
value	String	String value used verbatim.

POST

Generic builder for generating a string.

Inline definition
A pattern for string interpolation.

Property	Type	Description
fromVar	Object	Load the string from session variable.
pattern	String	Use pattern replacing session variables.
value	String	String value used verbatim.

PUT

Generic builder for generating a string.

Inline definition
A pattern for string interpolation.

Property	Type	Description
fromVar	Object	Load the string from session variable.
pattern	String	Use pattern replacing session variables.
value	String	String value used verbatim.

sla

Defines a list of Service Level Agreements (SLAs) - conditions that must hold for benchmark to be deemed successful.

Property	Type	Description
<list of mappings>	<list of builders>	One or more SLA configurations.

sla.<list of mappings>

Defines a Service Level Agreement (SLA) - conditions that must hold for benchmark to be deemed successful.

Property	Type	Description
blockedRatio	double	Maximum allowed ratio of time spent waiting for usable connection to sum of response latencies and blocked time. Default is 0 - client must not be blocked. Set to 1 if the client can block without limits.
errorRatio	double	Maximum allowed ratio of errors: connection failures or resets, timeouts and internal errors. Valid values are 0.0 - 1.0 (inclusive). Note: 4xx and 5xx statuses are NOT considered errors for this SLA parameter. Use `invalidRatio` for that.
invalidRatio	double	Maximum allowed ratio of requests with responses marked as invalid. Valid values are 0.0 - 1.0 (inclusive). Note: With default settings 4xx and 5xx statuses are considered invalid. Check out `ergonomics.autoRangeCheck` or `httpRequest.handler.autoRangeCheck` to change this.
limits	Builder	Percentile limits.
meanResponseTime	String	Maximum allowed mean (average) response time. Use suffix `ns`, `us`, `ms` or `s` to specify units.
window	String	Period over which the stats should be collected. By default the SLA applies to stats from whole phase.

sla.<list of mappings>.limits

Percentile limits.

Property	Type	Description
<any>	String	Use percentile (value between 0.0 and 1.0) as key and response time with unit (e.g. `ms`) in suffix as value.

TRACE

Generic builder for generating a string.

Inline definition
A pattern for string interpolation.

Property	Type	Description
fromVar	Object	Load the string from session variable.
pattern	String	Use pattern replacing session variables.
value	String	String value used verbatim.

1.20 - json

Parse JSON in variable into another variable.

Property	Type	Description
delete	boolean	If this is set to true, the selected key will be deleted from the JSON and the modified JSON will be passed to the `processor`.
format	enum	Conversion to apply on the matching parts with ’toVar’ or ’toArray’ shortcuts. Options: `BYTEBUF`Store the buffer directly. Beware that this may cause memory leaks! `BYTES`Store data as byte array. `STRING`Interprets the bytes as UTF-8 string.
fromVar	String	Variable to load JSON from.
processor	Processor.Builder	Add one or more processors.
query	String	Query selecting the part of JSON.
replace	Transformer.Builder	Custom transformation executed on the value of the selected item. Note that the output value must contain quotes (if applicable) and be correctly escaped.
replace (alternative)	String	Replace value of selected item with value generated through a pattern. Note that the result must contain quotes and be correctly escaped.
toArray	String	Shortcut to store selected parts in an array in the session. Must follow the pattern `variable[maxSize]`
toVar	String	Shortcut to store first match in given variable. Further matches are ignored.
unquote	boolean	Automatically unquote and unescape the input values. By default true.

replace

Custom transformation executed on the value of the selected item. Note that the output value must contain quotes (if applicable) and be correctly escaped.

Property	Type	Description
actions	ActionsTransformer.Builder	This transformer stores the (defragmented) input into a variable, using requested format. After that it executes all the actions and fetches transformed value using the pattern.
pattern	Pattern.TransformerBuilder	Use pattern replacing session variables.

replace.actions

This transformer stores the (defragmented) input into a variable, using requested format. After that it executes all the actions and fetches transformed value using the pattern.

Property	Type	Description
actions	Action.Builder	Actions to be executed.
format	enum	Format into which should this transformer convert the buffers before storing. Default is `STRING`. Options: `BYTEBUF`Store the buffer directly. Beware that this may cause memory leaks! `BYTES`Store data as byte array. `STRING`Interprets the bytes as UTF-8 string.
pattern	String	Pattern to use when fetching the transformed value.
var	String	Variable used as the intermediate storage for the data.

replace.pattern

Use pattern replacing session variables.

Inline definition
The pattern formatting string.

Property	Type	Description
pattern	String	Use pattern replacing session variables.

1.21 - log

Log a message and variable values.

Inline definition
A pattern for string interpolation.

Property	Type	Description
message	String	Message format pattern. Use string interpolation for variables.

1.22 - loop

Repeats a set of steps fixed number of times.

This step is supposed to be inserted as the first step of a sequence and the counterVar should not be set during the first invocation.

Before the loop the counterVar is initialized to zero, and in each after the last step in the steps sequence the counter is incremented. If the result is lesser than repeats this sequence is restarted from the beginning (this is also why the step must be the first step in the sequence).

It is legal to place steps after the looped steps.

Example:

scenario:
- mySequence:
  - loop:
      counterVar: myCounter
      repeats: 5
      steps:
      - httpRequest:
          GET: /foo/${myCounter}
          # ...
      - someOtherStep: ...
  - anotherStepExecutedAfterThoseFiveLoops

Property	Type	Description
counterVar	String	Variable holding number of iterations.
repeats	int	Number of iterations that should be executed.
steps	Builder	List of steps that should be looped.

1.23 - markRequestInvalid

Unconditionally mark currently processed request as invalid.

1.24 - newSequence

Instantiates a sequence for each invocation.

Inline definition
Sequence name.

Property	Type	Description
concurrencyPolicy	enum	Options: `FAIL` `WARN`
forceSameIndex	boolean	Forces that the sequence will have the same index as the currently executing sequence. This can be useful if the sequence is passing some data to the new sequence using sequence-scoped variables. Note that the new sequence must have same concurrency factor as the currently executing sequence.
sequence	String	Name of the instantiated sequence.

1.25 - noop

Does nothing. Only for demonstration purposes.

1.26 - publishAgentData

Makes the data available to all sessions in the same agent, including those using different executors.

Inline definition
Both name of source variable and the key used to read the data.

Property	Type	Description
fromVar	String	Source session variable name.
name	String	Arbitrary unique identifier for the data.

1.27 - publishGlobalCounters

Gathers values from session variables and publishes them globally (to all agents).

Gathers values from session variables and publishes them globally (to all agents).
You can name the counters individually (example 1) or use the variable names (example 2):

# Example 1:
- publishGlobalCounters:
    key: myKey
    vars: [ foo, bar ]
# Example 2:
- publishGlobalCounters:
    key: someOtherKey
    vars:
    - foo: myFoo
    - bar: bbb
</code>```


| Property | Type | Description |
| ------- | ------- | -------- |
| key | String | Identifier of the global record. |
| vars | [Builder](#vars) | List of names and session variables. |

### vars

| Property | Type | Description |
| ------- | ------- | ------- |
| &lt;any&gt; | &lt;unknown&gt; | <font color="#606060">&lt;no description&gt;</font> |
| &lt;list of strings&gt; | &lt;unknown&gt; | <font color="#606060">&lt;no description&gt;</font> |

1.28 - pullSharedMap

Move values from a map shared across all sessions using the same executor into session variables.

The executor can host multiple shared maps, each holding an entry with several variables. This step moves variables from either a random entry (if no match is set) or with an entry that has the same value for given variable as the current session. When data is moved to the current session the entry is dropped from the shared map. If the map contains records for which the {@link #vars()} don’t contain a destination variable the contents is lost.

Property	Type	Description
key	String	Key identifying the shared map.
match	String	Name of the session variable that stores value identifying the entry in the shared map.
vars	<list of strings>	List of variables the map should be pulled into.

vars

List of variables the map should be pulled into.

Property	Type	Description
<list of strings>	<unknown>	<no description>

1.29 - pushSharedMap

Store values from session variables into a map shared across all sessions using the same executor into session variables.

The executor can host multiple shared maps, each holding an entry with several variables. This step creates one entry in the map, copying values from session variables into the entry.

Property	Type	Description
key	String	Key identifying the shared map.
vars	<list of strings>	List of variable names that should be stored in the entry.

vars

List of variable names that should be stored in the entry.

Property	Type	Description
<list of strings>	<unknown>	<no description>

1.30 - randomCsvRow

Stores random row from a CSV-formatted file to variables.

Property	Type	Description
columns	Builder	Defines mapping from columns to session variables.
file	String	Path to the CSV file that should be loaded.
separator	char	Set character used for column separation. By default it is comma (`,`).
skipComments	boolean	Skip lines starting with character ‘#’. By default set to false.

columns

Property	Type	Description
<any>	String	Use 0-based column as the key and variable name as the value.

1.31 - randomFile

Reads bytes from a randomly chosen file into a variable.

Reads bytes from a randomly chosen file into a variable.
Two formats are supported:
Example 1 - without weights:

toVar: myVar
files:
- /path/to/file1.txt
- file2_relative_to_benchmark.txt

Example 2 - with weights (the second file will be returned twice as often):

toVar: myVar
files:
  /path/to/file1.txt: 1
  file2_relative_to_benchmark.txt: 2

Property	Type	Description
filenameVar	String	Optional variable to store the filename of the random file.
files	Builder	Potentially weighted list of files to choose from.
toVar	String	Variable where the chosen byte array should be stored.

files

Property	Type	Description
<any>	<list of strings>	Item as the key and weight (arbitrary floating-point number, defaults to 1.0) as the value.
<list of strings>	<list of strings>	Item as the key and weight (arbitrary floating-point number, defaults to 1.0) as the value.

1.32 - randomInt

Stores random (linearly distributed) integer into session variable.

Property	Type	Description
max	Builder	Highest possible value (inclusive). Default is Integer.MAX_VALUE.
min	Builder	Lowest possible value (inclusive). Default is 0.
toVar	String	Variable name to store the result.

max

Inline definition
Constant value.

Property	Type	Description
fromVar	String	Initialize with a value from session variable.
value	int	Initialize with a constant value.

min

Inline definition
Constant value.

Property	Type	Description
fromVar	String	Initialize with a value from session variable.
value	int	Initialize with a constant value.

1.33 - randomItem

Stores random item from a list or array into session variable.

Property	Type	Description
file	String	This file will be loaded into memory and the step will choose on line as the item.
fromVar	String	Variable containing an array or list.
list	Builder	Potentially weighted list of items to choose from.
toVar	String	Variable where the chosen item should be stored.

list

Property	Type	Description
<any>	<list of strings>	Item as the key and weight (arbitrary floating-point number, defaults to 1.0) as the value.
<list of strings>	<list of strings>	Item as the key and weight (arbitrary floating-point number, defaults to 1.0) as the value.

1.34 - randomUUID

Stores random string into session variable based on the UUID generator.

Property	Type	Description
toVar	String	Variable name to store the result.

1.35 - readAgentData

Reads data from agent-wide scope into session variable.

Reads data from agent-wide scope into session variable.
The data must be published in a phase that has terminated before this phase starts: usually this is achieved using the startAfterStrict property on the phase.

Inline definition
Both the identifier and destination session variable.

Property	Type	Description
name	String	Unique identifier for the data.
toVar	String	Destination session variable name.

1.36 - removeItem

Removes element from an array of variables.

Property	Type	Description
fromVar	String	Variable containing an existing array of object variables.
index	Builder	Set index at which the item should be removed. Elements to the right of this are moved to the left.

index

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

1.37 - restartSequence

Restarts current sequence from beginning.

1.38 - scheduleDelay

Define a point in future until which we should wait. Does not cause waiting.

Property	Type	Description
duration	String	Duration of the delay with appropriate suffix (e.g. `ms` or `s`).
fromLast	<none>	Set previous delay point reference as the reference for next delay point; it will be computed as `(previous delay point or now) + duration`. Note: property does not have any value
fromNow	<none>	Set this step invocation as the delay point reference; it will be computed as `now + duration`. Note: property does not have any value
key	String	Key that is referenced later in `awaitDelay` step. If you’re introducing the delay through `thinkTime` do not use this property.
max	String	Upper cap on the duration (if randomized).
min	String	Lower cap on the duration (if randomized).
random	enum	Randomize the duration. Options: `CONSTANT`Do not randomize; use constant duration. `LINEAR`Use linearly random duration between `min` and `max` (inclusively). `NEGATIVE_EXPONENTIAL`Use negative-exponential duration with expected value of `duration`, capped at `min` and `max` (inclusively).
type	enum	Alternative way to set delay reference point. See `fromNow` and `fromLast` property setters. Options: `FROM_LAST` `FROM_NOW`

1.39 - set

Set variable in session to certain value.

Inline definition
Use `var <- value`.

Property	Type	Description
intArray	Builder	Set variable to an (unset) integer array.
objectArray	Builder	Set variable to an (unset) object array.
value	String	String value.
var	String	Variable name.

intArray

Creates integer arrays to be stored in the session.

Property	Type	Description
fromVar	String	Contents of the new array. If the variable contains an array or a list, items will be copied to the elements with the same index up to the size of this array. If the variable contains a different value all elements will be initialized to this value.
size	int	Size of the array.

objectArray

Creates object arrays to be stored in the session.

Property	Type	Description
fromVar	String	Contents of the new array. If the variable contains an array or a list, items will be copied to the elements with the same index up to the size of this array. If the variable contains a different value all elements will be initialized to this value.
size	int	Size of the array.

1.40 - setInt

Set session variable to an integral value.

Inline definition
Use `var <- value`.

Property	Type	Description
fromVar	String	Input variable name.
intCondition	Builder	Set variable only if the current value satisfies certain condition.
max	Builder	Set to value that is the maximum of this list of values.
min	Builder	Set to value that is the minimum of this list of values.
onlyIfNotSet	boolean	Set variable to the value only if it is not already set.
value	int	Value (integer).
var	String	Variable name.

intCondition

Property	Type	Description
equalTo	Builder	Compared variable must be equal to this value.
greaterOrEqualTo	Builder	Compared variable must be greater or equal to this value.
greaterThan	Builder	Compared variable must be greater than this value.
lessOrEqualTo	Builder	Compared variable must be lower or equal to this value.
lessThan	Builder	Compared variable must be lower than this value.
notEqualTo	Builder	Compared variable must not be equal to this value.

intCondition.equalTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

intCondition.greaterOrEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

intCondition.greaterThan

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

intCondition.lessOrEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

intCondition.lessThan

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

intCondition.notEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

max

Property	Type	Description
<list of mappings>	<list of builders>	<no description>

max.<list of mappings>

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

min

Property	Type	Description
<list of mappings>	<list of builders>	<no description>

1.41 - setItem

Set element in a collection on given position.

Property	Type	Description
fromVar	String	Fetch value from session variable.
index	Builder	Integer session variable with an index into the collection.
toVar	String	Session variable with the collection.
value	String	Verbatim value.

index

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

1.42 - setSharedCounter

Sets value in a counter shared by all sessions in the same executor.

Inline definition
Both the name of the counter and variable name.

Property	Type	Description
fromVar	String	Input variable name.
key	String	Identifier for the counter.
value	int	Value (integer).

1.43 - stop

Immediately stop the user session (break all running sequences).

1.44 - stopwatch

Run nested sequence of steps, recording execution time.

1.45 - stringToInt

Parse string into integer and store it in a variable.

If the parsing fails the target variable is not modified.

Inline definition
Use `fromVar -> toVar`

Property	Type	Description
fromVar	String	Source variable name.
toVar	String	Target variable name.

1.46 - template

Format pattern into session variable.

Property	Type	Description
pattern	String	Pattern to be encoded, e.g. `foo${variable}bar${another-variable}`
toVar	String	Variable name to store the result.

1.47 - thinkTime

Block current sequence for specified duration.

Inline definition
Duration of the delay with appropriate suffix (e.g. `ms` or `s`).

Property	Type	Description
duration	String	Duration of the delay with appropriate suffix (e.g. `ms` or `s`).
fromLast	<none>	Set previous delay point reference as the reference for next delay point; it will be computed as `(previous delay point or now) + duration`. Note: property does not have any value
fromNow	<none>	Set this step invocation as the delay point reference; it will be computed as `now + duration`. Note: property does not have any value
key	String	Key that is referenced later in `awaitDelay` step. If you’re introducing the delay through `thinkTime` do not use this property.
max	String	Upper cap on the duration (if randomized).
min	String	Lower cap on the duration (if randomized).
random	enum	Randomize the duration. Options: `CONSTANT`Do not randomize; use constant duration. `LINEAR`Use linearly random duration between `min` and `max` (inclusively). `NEGATIVE_EXPONENTIAL`Use negative-exponential duration with expected value of `duration`, capped at `min` and `max` (inclusively).
type	enum	Alternative way to set delay reference point. See `fromNow` and `fromLast` property setters. Options: `FROM_LAST` `FROM_NOW`

1.48 - timestamp

Stores the current time in milliseconds as string to a session variable.

Inline definition
Variable name.

Property	Type	Description
localeCountry	String	2-letter ISO country code used in the formatter locale. Defaults to ‘US’.
pattern	String	Format the timestamp using `SimpleDateFormat` pattern.
toVar	String	Target variable name.

1.49 - unset

Undefine variable name.

Inline definition
Variable name.

Property	Type	Description
var	Object	Variable name.

2 - Processors

Processors can work either as consumers of input bytes (e.g. storing part of the input into session variables), as filters (passing modified version of the input to delegated processors) or combination of the above.

Some processors can expect extra context in the session, such as an ongoing (HTTP) request. It is possible to use processors that don’t expect specific type of request in places where a more specific type is provided; opposite is not allowed.

Also it is possible to use an action instead of a processor; Hyperfoil automatically inserts an adapter. That’s why the list below includes actions as well.

2.1 - addItem

Appends value to an array stored in another variable.

Property	Type	Description
fromVar	String	Fetch value from session variable.
toVar	String	Destination variable with the array.
value	String	Verbatim value.

2.2 - addToInt

Add value to integer variable in the session.

Inline definition
Accepting one of: `var++`, `var–`, `var += value`, `var -= value`.

Property	Type	Description
orElseSetTo	int	If the variable is currently not set, set it to this value instead of addition.
value	int	Value added (can be negative).
var	String	Variable name.

2.3 - addToSharedCounter

Adds value to a counter shared by all sessions in the same executor.

Inline definition
Use on of: `counter++`, `counter–`, `counter += <value>`,
`counter -= <value>`

Property	Type	Description
fromVar	String	Input variable name.
key	String	Identifier for the counter.
operator	enum	Operation to perform on the counter. Default is `ADD`. Options: `ADD` `SUBTRACT`
value	int	Value (integer).

2.4 - array

Stores data in an array stored as session variable.

Inline definition
Use format `toVar[maxSize]`.

Property	Type	Description
format	enum	Format into which should this processor convert the buffers before storing. Default is `STRING`. Options: `BYTEBUF`Store the buffer directly. Beware that this may cause memory leaks! `BYTES`Store data as byte array. `STRING`Interprets the bytes as UTF-8 string.
maxSize	int	Maximum size of the array.
silent	boolean	Do not log warnings when the maximum size is exceeded.
toVar	String	Variable name.

2.5 - clearHttpCache

Drops all entries from HTTP cache in the session.

2.6 - closeConnection

Prevents reuse connection after the response has been handled.

2.7 - collection

Collects results of processor invocation into a unbounded list.

Collects results of processor invocation into a unbounded list.
WARNING: This processor should be used rarely as it allocates memory during the benchmark.

Inline definition
Variable name to store the list.

Property	Type	Description
format	enum	Format into which should this processor convert the buffers before storing. Default is `STRING`. Options: `BYTEBUF`Store the buffer directly. Beware that this may cause memory leaks! `BYTES`Store data as byte array. `STRING`Interprets the bytes as UTF-8 string.
toVar	String	Variable name.

2.8 - conditional

Passes the data to nested processor if the condition holds.

Passes the data to nested processor if the condition holds.
Note that the condition may be evaluated multiple times and therefore any nested processors should not change the results of the condition.

Property	Type	Description
allConditions	Builder	Condition combining multiple other conditions with ‘AND’ logic.
boolCondition	Builder	Condition comparing boolean variables.
intCondition	Builder	Condition comparing integer variables.
processor	Processor.Builder	One or more processors that should be invoked if the condition holds.
stringCondition	Builder	Condition comparing string variables.

allConditions

Test more conditions and combine the results using AND logic.

Property	Type	Description
<list of mappings>	<list of builders>	List of conditions.

allConditions.<list of mappings>

Selector for condition type.

Property	Type	Description
allConditions	Builder	Condition combining multiple other conditions with ‘AND’ logic.
boolCondition	Builder	Condition comparing boolean variables.
intCondition	Builder	Condition comparing integer variables.
stringCondition	Builder	Condition comparing string variables.

allConditions.<list of mappings>.allConditions

Test more conditions and combine the results using AND logic.

Property	Type	Description
<list of mappings>	<list of builders>	List of conditions.

allConditions.<list of mappings>.boolCondition

Tests session variable containing boolean value.

Property	Type	Description
fromVar	String	Variable name.
value	boolean	Expected value.

allConditions.<list of mappings>.intCondition

Condition comparing integer in session variable.

Inline definition
Parses condition in the form <variable> <operator> <value>
where operator is one of: `==`, `!=`,
`<>` (the same as `!=`),
`>=`, `>`, `<=`, `<`.

Property	Type	Description
equalTo	Builder	Compared variable must be equal to this value.
fromVar	Object	Variable name.
greaterOrEqualTo	Builder	Compared variable must be greater or equal to this value.
greaterThan	Builder	Compared variable must be greater than this value.
isSet	boolean	Check if the value is set or unset. By default the variable must be set.
lessOrEqualTo	Builder	Compared variable must be lower or equal to this value.
lessThan	Builder	Compared variable must be lower than this value.
notEqualTo	Builder	Compared variable must not be equal to this value.

allConditions.<list of mappings>.stringCondition

Condition comparing string in session variable.

Property	Type	Description
caseSensitive	boolean	True if the case must match, false if the check is case-insensitive.
endsWith	CharSequence	Suffix for the string.
equalTo	CharSequence	Literal value the string should match (the same as {@link #value}).
fromVar	Object	Variable name.
isSet	boolean	Check if the value is set or unset. By default the variable must be set.
length	int	Check the length of the string.
length (alternative)	Builder	Check the length of the string.
matchVar	String	Fetch the value from a variable.
negate	boolean	Invert the logic of this condition. Defaults to false.
notEqualTo	CharSequence	Value that the string must not match.
startsWith	CharSequence	Prefix for the string.
value	CharSequence	Literal value the string should match.

boolCondition

Tests session variable containing boolean value.

Property	Type	Description
fromVar	String	Variable name.
value	boolean	Expected value.

intCondition

Condition comparing integer in session variable.

Inline definition
Parses condition in the form <variable> <operator> <value>
where operator is one of: `==`, `!=`,
`<>` (the same as `!=`),
`>=`, `>`, `<=`, `<`.

Property	Type	Description
equalTo	Builder	Compared variable must be equal to this value.
fromVar	Object	Variable name.
greaterOrEqualTo	Builder	Compared variable must be greater or equal to this value.
greaterThan	Builder	Compared variable must be greater than this value.
isSet	boolean	Check if the value is set or unset. By default the variable must be set.
lessOrEqualTo	Builder	Compared variable must be lower or equal to this value.
lessThan	Builder	Compared variable must be lower than this value.
notEqualTo	Builder	Compared variable must not be equal to this value.

intCondition.equalTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

intCondition.greaterOrEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

intCondition.greaterThan

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

intCondition.lessOrEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

intCondition.lessThan

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

intCondition.notEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

stringCondition

Condition comparing string in session variable.

Property	Type	Description
caseSensitive	boolean	True if the case must match, false if the check is case-insensitive.
endsWith	CharSequence	Suffix for the string.
equalTo	CharSequence	Literal value the string should match (the same as {@link #value}).
fromVar	Object	Variable name.
isSet	boolean	Check if the value is set or unset. By default the variable must be set.
length	int	Check the length of the string.
length (alternative)	Builder	Check the length of the string.
matchVar	String	Fetch the value from a variable.
negate	boolean	Invert the logic of this condition. Defaults to false.
notEqualTo	CharSequence	Value that the string must not match.
startsWith	CharSequence	Prefix for the string.
value	CharSequence	Literal value the string should match.

stringCondition.length

Property	Type	Description
equalTo	Builder	Compared variable must be equal to this value.
greaterOrEqualTo	Builder	Compared variable must be greater or equal to this value.
greaterThan	Builder	Compared variable must be greater than this value.
lessOrEqualTo	Builder	Compared variable must be lower or equal to this value.
lessThan	Builder	Compared variable must be lower than this value.
notEqualTo	Builder	Compared variable must not be equal to this value.

stringCondition.length.equalTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

stringCondition.length.greaterOrEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

stringCondition.length.greaterThan

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

stringCondition.length.lessOrEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

stringCondition.length.lessThan

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

stringCondition.length.notEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

2.9 - count

Records number of parts this processor is invoked on.

Inline definition
Name of variable for the number of occurrences.

Property	Type	Description
toVar	String	Variable where to store number of occurrences.

2.10 - fail

Fail the phase with given message. Used mostly for testing/debugging.

Inline definition
Message to fail with (unconditionally).

Property	Type	Description
allConditions	Builder	Condition combining multiple other conditions with ‘AND’ logic.
boolCondition	Builder	Condition comparing boolean variables.
intCondition	Builder	Condition comparing integer variables.
message	String	Message attached to the failure exception.
stringCondition	Builder	Condition comparing string variables.

allConditions

Test more conditions and combine the results using AND logic.

Property	Type	Description
<list of mappings>	<list of builders>	List of conditions.

allConditions.<list of mappings>

Selector for condition type.

Property	Type	Description
allConditions	Builder	Condition combining multiple other conditions with ‘AND’ logic.
boolCondition	Builder	Condition comparing boolean variables.
intCondition	Builder	Condition comparing integer variables.
stringCondition	Builder	Condition comparing string variables.

allConditions.<list of mappings>.allConditions

Test more conditions and combine the results using AND logic.

Property	Type	Description
<list of mappings>	<list of builders>	List of conditions.

allConditions.<list of mappings>.boolCondition

Tests session variable containing boolean value.

Property	Type	Description
fromVar	String	Variable name.
value	boolean	Expected value.

allConditions.<list of mappings>.intCondition

Condition comparing integer in session variable.

Inline definition
Parses condition in the form <variable> <operator> <value>
where operator is one of: `==`, `!=`,
`<>` (the same as `!=`),
`>=`, `>`, `<=`, `<`.

Property	Type	Description
equalTo	Builder	Compared variable must be equal to this value.
fromVar	Object	Variable name.
greaterOrEqualTo	Builder	Compared variable must be greater or equal to this value.
greaterThan	Builder	Compared variable must be greater than this value.
isSet	boolean	Check if the value is set or unset. By default the variable must be set.
lessOrEqualTo	Builder	Compared variable must be lower or equal to this value.
lessThan	Builder	Compared variable must be lower than this value.
notEqualTo	Builder	Compared variable must not be equal to this value.

allConditions.<list of mappings>.stringCondition

Condition comparing string in session variable.

Property	Type	Description
caseSensitive	boolean	True if the case must match, false if the check is case-insensitive.
endsWith	CharSequence	Suffix for the string.
equalTo	CharSequence	Literal value the string should match (the same as {@link #value}).
fromVar	Object	Variable name.
isSet	boolean	Check if the value is set or unset. By default the variable must be set.
length	int	Check the length of the string.
length (alternative)	Builder	Check the length of the string.
matchVar	String	Fetch the value from a variable.
negate	boolean	Invert the logic of this condition. Defaults to false.
notEqualTo	CharSequence	Value that the string must not match.
startsWith	CharSequence	Prefix for the string.
value	CharSequence	Literal value the string should match.

boolCondition

Tests session variable containing boolean value.

Property	Type	Description
fromVar	String	Variable name.
value	boolean	Expected value.

intCondition

Condition comparing integer in session variable.

Inline definition
Parses condition in the form <variable> <operator> <value>
where operator is one of: `==`, `!=`,
`<>` (the same as `!=`),
`>=`, `>`, `<=`, `<`.

Property	Type	Description
equalTo	Builder	Compared variable must be equal to this value.
fromVar	Object	Variable name.
greaterOrEqualTo	Builder	Compared variable must be greater or equal to this value.
greaterThan	Builder	Compared variable must be greater than this value.
isSet	boolean	Check if the value is set or unset. By default the variable must be set.
lessOrEqualTo	Builder	Compared variable must be lower or equal to this value.
lessThan	Builder	Compared variable must be lower than this value.
notEqualTo	Builder	Compared variable must not be equal to this value.

intCondition.equalTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

intCondition.greaterOrEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

intCondition.greaterThan

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

intCondition.lessOrEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

intCondition.lessThan

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

intCondition.notEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

stringCondition

Condition comparing string in session variable.

Property	Type	Description
caseSensitive	boolean	True if the case must match, false if the check is case-insensitive.
endsWith	CharSequence	Suffix for the string.
equalTo	CharSequence	Literal value the string should match (the same as {@link #value}).
fromVar	Object	Variable name.
isSet	boolean	Check if the value is set or unset. By default the variable must be set.
length	int	Check the length of the string.
length (alternative)	Builder	Check the length of the string.
matchVar	String	Fetch the value from a variable.
negate	boolean	Invert the logic of this condition. Defaults to false.
notEqualTo	CharSequence	Value that the string must not match.
startsWith	CharSequence	Prefix for the string.
value	CharSequence	Literal value the string should match.

stringCondition.length

Property	Type	Description
equalTo	Builder	Compared variable must be equal to this value.
greaterOrEqualTo	Builder	Compared variable must be greater or equal to this value.
greaterThan	Builder	Compared variable must be greater than this value.
lessOrEqualTo	Builder	Compared variable must be lower or equal to this value.
lessThan	Builder	Compared variable must be lower than this value.
notEqualTo	Builder	Compared variable must not be equal to this value.

stringCondition.length.equalTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

stringCondition.length.greaterOrEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

stringCondition.length.greaterThan

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

stringCondition.length.lessOrEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

stringCondition.length.lessThan

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

stringCondition.length.notEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

2.11 - getIndex

Lookup index of an item in an array/collection.

Property	Type	Description
collection	String	Variable to fetch the collection from.
item	Builder	Item that should be looked up (using equality).
toVar	String	Integer variable to store the index, or -1 if the item is not found.

item

Inline definition
Verbatim value.

Property	Type	Description
fromVar	String	Fetch value from session variable.
value	String	Verbatim value.

2.12 - getItem

Retrieves n-th item from an array or collection.

Property	Type	Description
fromVar	String	Source variable with an array or list.
index	Builder	Source for index into the array/list.
toVar	String	Destination variable for the n-th element.

index

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

2.13 - getSharedCounter

Retrieves value from a counter shared by all sessions in the same executor and stores that in a session variable.

Retrieves value from a counter shared by all sessions in the same executor and stores that in a session variable.
If the value exceeds allowed integer range (-2^31 .. 2^31 - 1) it is capped.

Inline definition
Both the key and variable name.

Property	Type	Description
key	String	Identifier for the counter.
toVar	String	Session variable for storing the value.

2.14 - getSize

Calculates size of an array/collection held in variable into another variable

Property	Type	Description
boolFilter	Builder	Count only items matching the condition.
fromVar	String	Variable holding the collection.
intFilter	Builder	Count only items matching the condition.
stringFilter	Builder	Count only items matching the condition.
toVar	String	Variable storing the size.
undefinedValue	int	Value to use when `fromVar` is unset or it does not contain any array/collection.

boolFilter

Property	Type	Description
value	boolean	Expected value.

intFilter

Property	Type	Description
equalTo	Builder	Compared variable must be equal to this value.
greaterOrEqualTo	Builder	Compared variable must be greater or equal to this value.
greaterThan	Builder	Compared variable must be greater than this value.
lessOrEqualTo	Builder	Compared variable must be lower or equal to this value.
lessThan	Builder	Compared variable must be lower than this value.
notEqualTo	Builder	Compared variable must not be equal to this value.

intFilter.equalTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

intFilter.greaterOrEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

intFilter.greaterThan

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

intFilter.lessOrEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

intFilter.lessThan

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

intFilter.notEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

stringFilter

Property	Type	Description
caseSensitive	boolean	True if the case must match, false if the check is case-insensitive.
endsWith	CharSequence	Suffix for the string.
equalTo	CharSequence	Literal value the string should match (the same as {@link #value}).
length	int	Check the length of the string.
length (alternative)	Builder	Check the length of the string.
matchVar	String	Fetch the value from a variable.
negate	boolean	Invert the logic of this condition. Defaults to false.
notEqualTo	CharSequence	Value that the string must not match.
startsWith	CharSequence	Prefix for the string.
value	CharSequence	Literal value the string should match.

stringFilter.length

Property	Type	Description
equalTo	Builder	Compared variable must be equal to this value.
greaterOrEqualTo	Builder	Compared variable must be greater or equal to this value.
greaterThan	Builder	Compared variable must be greater than this value.
lessOrEqualTo	Builder	Compared variable must be lower or equal to this value.
lessThan	Builder	Compared variable must be lower than this value.
notEqualTo	Builder	Compared variable must not be equal to this value.

stringFilter.length.equalTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

stringFilter.length.greaterOrEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

stringFilter.length.greaterThan

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

stringFilter.length.lessOrEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

stringFilter.length.lessThan

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

stringFilter.length.notEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

2.15 - gzipInflator

Decompresses a GZIP data and pipes the output to delegated processors.

Decompresses a GZIP data and pipes the output to delegated processors.
If the data contains multiple concatenated GZIP streams it will pipe multiple decompressed objects with isLastPart set to true at the end of each stream.

Property	Type	Description
encodingVar	Object	Variable used to pass header value from header handlers.
processor	Processor.Builder	Add one or more processors.

2.16 - json

Parses JSON responses using simple queries.

Property	Type	Description
delete	boolean	If this is set to true, the selected key will be deleted from the JSON and the modified JSON will be passed to the `processor`.
format	enum	Conversion to apply on the matching parts with ’toVar’ or ’toArray’ shortcuts. Options: `BYTEBUF`Store the buffer directly. Beware that this may cause memory leaks! `BYTES`Store data as byte array. `STRING`Interprets the bytes as UTF-8 string.
processor	Processor.Builder	Add one or more processors.
processor (alternative)	Processor.Builder	If neither `delete` or `replace` was set this processor will be called with the selected parts. In the other case the processor will be called with chunks of full (modified) JSON. Note that the `processor.before()` and `processor.after()` methods are called only once for each request, not for the individual filtered items.
query	String	Query selecting the part of JSON.
replace	Transformer.Builder	Custom transformation executed on the value of the selected item. Note that the output value must contain quotes (if applicable) and be correctly escaped.
replace (alternative)	String	Replace value of selected item with value generated through a pattern. Note that the result must contain quotes and be correctly escaped.
toArray	String	Shortcut to store selected parts in an array in the session. Must follow the pattern `variable[maxSize]`
toVar	String	Shortcut to store first match in given variable. Further matches are ignored.
unquote	boolean	Automatically unquote and unescape the input values. By default true.

replace

Custom transformation executed on the value of the selected item. Note that the output value must contain quotes (if applicable) and be correctly escaped.

Property	Type	Description
actions	ActionsTransformer.Builder	This transformer stores the (defragmented) input into a variable, using requested format. After that it executes all the actions and fetches transformed value using the pattern.
pattern	Pattern.TransformerBuilder	Use pattern replacing session variables.

replace.actions

This transformer stores the (defragmented) input into a variable, using requested format. After that it executes all the actions and fetches transformed value using the pattern.

Property	Type	Description
actions	Action.Builder	Actions to be executed.
format	enum	Format into which should this transformer convert the buffers before storing. Default is `STRING`. Options: `BYTEBUF`Store the buffer directly. Beware that this may cause memory leaks! `BYTES`Store data as byte array. `STRING`Interprets the bytes as UTF-8 string.
pattern	String	Pattern to use when fetching the transformed value.
var	String	Variable used as the intermediate storage for the data.

replace.pattern

Use pattern replacing session variables.

Inline definition
The pattern formatting string.

Property	Type	Description
pattern	String	Use pattern replacing session variables.

2.17 - log

Log a message and variable values.

Inline definition
A pattern for string interpolation.

Property	Type	Description
message	String	Message format pattern. Use string interpolation for variables.

2.18 - logInvalid

Logs body chunks from requests marked as invalid.

2.19 - markRequestInvalid

Unconditionally mark currently processed request as invalid.

2.20 - newSequence

Instantiates a sequence for each invocation.

Inline definition
Sequence name.

Property	Type	Description
concurrencyPolicy	enum	Options: `FAIL` `WARN`
forceSameIndex	boolean	Forces that the sequence will have the same index as the currently executing sequence. This can be useful if the sequence is passing some data to the new sequence using sequence-scoped variables. Note that the new sequence must have same concurrency factor as the currently executing sequence.
sequence	String	Name of the instantiated sequence.

2.21 - parseHtml

Parses HTML tags and invokes handlers based on criteria.

Property	Type	Description
onEmbeddedResource	Builder	Handler firing upon reference to other resource, e.g. image, stylesheet…
onTagAttribute	Builder	<no description>

onEmbeddedResource

Handles <img src="…">, <link href="…">, <embed src="…">, <frame src="…">, <iframe src="…">, <object data="…"> and <script src="…">.

Does not handle <source src="…"> or <track src="…"> because browser would choose only one of the options.

Property	Type	Description
fetchResource	Builder	Automatically download referenced resource.
ignoreExternal	boolean	Ignore resources hosted on servers that are not covered in the `http` section.
processor	Processor.Builder	Add one or more processors.
processor (alternative)	Processor.Builder	Custom processor invoked pointing to attribute data - e.g. in case of `<img>` tag the processor gets contents of the `src` attribute.

onEmbeddedResource.fetchResource

Automates download of embedded resources.

Property	Type	Description
concurrency	int	Maximum number of resources fetched concurrently. Default is 8.
maxResources	int	Maximum number of resources that can be fetched.
metric	<list of strings>	Metrics selector for downloaded resources.
onCompletion	Action.Builder	Action performed when the download of all resources completes.

onEmbeddedResource.fetchResource.metric

Metrics selector for downloaded resources.

Property	Type	Description
<list of strings>	<list of strings>	Allows categorizing request statistics into metrics based on the request path. The expressions are evaluated in the order as provided in the list. Use one of: `regexp -> replacement`, e.g. `([^?])(?.)? -> $1` to drop the query part. `regexp` (don’t do any replaces and use the full path), e.g. `.*.jpg` `-> name` (metric applied if none of the previous expressions match).

onTagAttribute

Property	Type	Description
attribute	String	Name of the attribute in this element you want to process, e.g. `action`
format	enum	Conversion to apply on the matching parts with ’toVar’ or ’toArray’ shortcuts. Options: `BYTEBUF`Store the buffer directly. Beware that this may cause memory leaks! `BYTES`Store data as byte array. `STRING`Interprets the bytes as UTF-8 string.
processor	Processor.Builder	Add one or more processors.
tag	String	Name of the tag this handler should look for, e.g. `form`
toArray	String	Shortcut to store selected parts in an array in the session. Must follow the pattern `variable[maxSize]`
toVar	String	Shortcut to store first match in given variable. Further matches are ignored.

2.22 - publishAgentData

Makes the data available to all sessions in the same agent, including those using different executors.

Inline definition
Both name of source variable and the key used to read the data.

Property	Type	Description
fromVar	String	Source session variable name.
name	String	Arbitrary unique identifier for the data.

2.23 - publishGlobalCounters

Gathers values from session variables and publishes them globally (to all agents).

Gathers values from session variables and publishes them globally (to all agents).
You can name the counters individually (example 1) or use the variable names (example 2):

# Example 1:
- publishGlobalCounters:
    key: myKey
    vars: [ foo, bar ]
# Example 2:
- publishGlobalCounters:
    key: someOtherKey
    vars:
    - foo: myFoo
    - bar: bbb
</code>```


| Property | Type | Description |
| ------- | ------- | -------- |
| key | String | Identifier of the global record. |
| vars | [Builder](#vars) | List of names and session variables. |

### vars

| Property | Type | Description |
| ------- | ------- | ------- |
| &lt;any&gt; | &lt;unknown&gt; | <font color="#606060">&lt;no description&gt;</font> |
| &lt;list of strings&gt; | &lt;unknown&gt; | <font color="#606060">&lt;no description&gt;</font> |

2.24 - queue

Stores defragmented data in a queue.

Stores defragmented data in a queue.
For each item in the queue a new sequence instance will be started (subject the concurrency constraints) with sequence index that allows it to read an object from an array using sequence-scoped access.

Property	Type	Description
concurrency	int	Maximum number of started sequences that can be running at one moment.
format	enum	Conversion format from byte buffers. Default format is STRING. Options: `BYTEBUF`Store the buffer directly. Beware that this may cause memory leaks! `BYTES`Store data as byte array. `STRING`Interprets the bytes as UTF-8 string.
maxSize	int	Maximum number of elements that can be stored in the queue.
onCompletion	Action.Builder	Custom action that should be performed when the last consuming sequence reports that it has processed the last element from the queue. Note that the sequence is NOT automatically augmented to report completion.
sequence	String	Name of the started sequence.
var	String	Variable storing the array that it used as a output object from the queue.

2.25 - readAgentData

Reads data from agent-wide scope into session variable.

Inline definition
Both the identifier and destination session variable.

Property	Type	Description
name	String	Unique identifier for the data.
toVar	String	Destination session variable name.

2.26 - removeItem

Removes element from an array of variables.

Property	Type	Description
fromVar	String	Variable containing an existing array of object variables.
index	Builder	Set index at which the item should be removed. Elements to the right of this are moved to the left.

index

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

2.27 - restartSequence

Schedules a restart of this sequence.

2.28 - set

Set variable in session to certain value.

Inline definition
Use `var <- value`.

Property	Type	Description
intArray	Builder	Set variable to an (unset) integer array.
objectArray	Builder	Set variable to an (unset) object array.
value	String	String value.
var	String	Variable name.

intArray

Creates integer arrays to be stored in the session.

Property	Type	Description
fromVar	String	Contents of the new array. If the variable contains an array or a list, items will be copied to the elements with the same index up to the size of this array. If the variable contains a different value all elements will be initialized to this value.
size	int	Size of the array.

objectArray

Creates object arrays to be stored in the session.

Property	Type	Description
fromVar	String	Contents of the new array. If the variable contains an array or a list, items will be copied to the elements with the same index up to the size of this array. If the variable contains a different value all elements will be initialized to this value.
size	int	Size of the array.

2.29 - setInt

Set session variable to an integral value.

Inline definition
Use `var <- value`.

Property	Type	Description
fromVar	String	Input variable name.
intCondition	Builder	Set variable only if the current value satisfies certain condition.
max	Builder	Set to value that is the maximum of this list of values.
min	Builder	Set to value that is the minimum of this list of values.
onlyIfNotSet	boolean	Set variable to the value only if it is not already set.
value	int	Value (integer).
var	String	Variable name.

intCondition

Property	Type	Description
equalTo	Builder	Compared variable must be equal to this value.
greaterOrEqualTo	Builder	Compared variable must be greater or equal to this value.
greaterThan	Builder	Compared variable must be greater than this value.
lessOrEqualTo	Builder	Compared variable must be lower or equal to this value.
lessThan	Builder	Compared variable must be lower than this value.
notEqualTo	Builder	Compared variable must not be equal to this value.

intCondition.equalTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

intCondition.greaterOrEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

intCondition.greaterThan

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

intCondition.lessOrEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

intCondition.lessThan

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

intCondition.notEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

max

Property	Type	Description
<list of mappings>	<list of builders>	<no description>

max.<list of mappings>

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

min

Property	Type	Description
<list of mappings>	<list of builders>	<no description>

2.30 - setItem

Set element in a collection on given position.

Property	Type	Description
fromVar	String	Fetch value from session variable.
index	Builder	Integer session variable with an index into the collection.
toVar	String	Session variable with the collection.
value	String	Verbatim value.

index

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

2.31 - setSharedCounter

Sets value in a counter shared by all sessions in the same executor.

Inline definition
Both the name of the counter and variable name.

Property	Type	Description
fromVar	String	Input variable name.
key	String	Identifier for the counter.
value	int	Value (integer).

2.32 - store

Stores data in a session variable (overwriting on multiple occurences).

Inline definition
Variable name.

Property	Type	Description
format	enum	Format into which should this processor convert the buffers before storing. Default is `STRING`. Options: `BYTEBUF`Store the buffer directly. Beware that this may cause memory leaks! `BYTES`Store data as byte array. `STRING`Interprets the bytes as UTF-8 string.
toVar	Object	Variable name.

2.33 - storeInt

Converts buffers into integral value and stores it in a variable.

Inline definition
Name of integer variable where to store the value.

Property	Type	Description
override	boolean	Allow the value to be set multiple times (last write wins). Defaults to false.
toVar	String	Name of variable where to store the integral value.

2.34 - stringToInt

Parse string into integer and store it in a variable.

If the parsing fails the target variable is not modified.

Inline definition
Use `fromVar -> toVar`

Property	Type	Description
fromVar	String	Source variable name.
toVar	String	Target variable name.

2.35 - unset

Undefine variable name.

Inline definition
Variable name.

Property	Type	Description
var	Object	Variable name.

3 - Actions

Actions are non-blocking handlers for various events.

3.1 - addItem

Appends value to an array stored in another variable.

Property	Type	Description
fromVar	String	Fetch value from session variable.
toVar	String	Destination variable with the array.
value	String	Verbatim value.

3.2 - addToInt

Add value to integer variable in the session.

Inline definition
Accepting one of: `var++`, `var–`, `var += value`, `var -= value`.

Property	Type	Description
orElseSetTo	int	If the variable is currently not set, set it to this value instead of addition.
value	int	Value added (can be negative).
var	String	Variable name.

3.3 - addToSharedCounter

Adds value to a counter shared by all sessions in the same executor.

Inline definition
Use on of: `counter++`, `counter–`, `counter += <value>`,
`counter -= <value>`

Property	Type	Description
fromVar	String	Input variable name.
key	String	Identifier for the counter.
operator	enum	Operation to perform on the counter. Default is `ADD`. Options: `ADD` `SUBTRACT`
value	int	Value (integer).

3.4 - clearHttpCache

Drops all entries from HTTP cache in the session.

3.5 - conditional

Perform an action or sequence of actions conditionally.

Property	Type	Description
actions	Action.Builder	Actions that should be executed should the condition hold.
allConditions	Builder	Condition combining multiple other conditions with ‘AND’ logic.
boolCondition	Builder	Condition comparing boolean variables.
intCondition	Builder	Condition comparing integer variables.
stringCondition	Builder	Condition comparing string variables.

allConditions

Test more conditions and combine the results using AND logic.

Property	Type	Description
<list of mappings>	<list of builders>	List of conditions.

allConditions.<list of mappings>

Selector for condition type.

Property	Type	Description
allConditions	Builder	Condition combining multiple other conditions with ‘AND’ logic.
boolCondition	Builder	Condition comparing boolean variables.
intCondition	Builder	Condition comparing integer variables.
stringCondition	Builder	Condition comparing string variables.

allConditions.<list of mappings>.allConditions

Test more conditions and combine the results using AND logic.

Property	Type	Description
<list of mappings>	<list of builders>	List of conditions.

allConditions.<list of mappings>.boolCondition

Tests session variable containing boolean value.

Property	Type	Description
fromVar	String	Variable name.
value	boolean	Expected value.

allConditions.<list of mappings>.intCondition

Condition comparing integer in session variable.

Inline definition
Parses condition in the form <variable> <operator> <value>
where operator is one of: `==`, `!=`,
`<>` (the same as `!=`),
`>=`, `>`, `<=`, `<`.

Property	Type	Description
equalTo	Builder	Compared variable must be equal to this value.
fromVar	Object	Variable name.
greaterOrEqualTo	Builder	Compared variable must be greater or equal to this value.
greaterThan	Builder	Compared variable must be greater than this value.
isSet	boolean	Check if the value is set or unset. By default the variable must be set.
lessOrEqualTo	Builder	Compared variable must be lower or equal to this value.
lessThan	Builder	Compared variable must be lower than this value.
notEqualTo	Builder	Compared variable must not be equal to this value.

allConditions.<list of mappings>.stringCondition

Condition comparing string in session variable.

Property	Type	Description
caseSensitive	boolean	True if the case must match, false if the check is case-insensitive.
endsWith	CharSequence	Suffix for the string.
equalTo	CharSequence	Literal value the string should match (the same as {@link #value}).
fromVar	Object	Variable name.
isSet	boolean	Check if the value is set or unset. By default the variable must be set.
length	int	Check the length of the string.
length (alternative)	Builder	Check the length of the string.
matchVar	String	Fetch the value from a variable.
negate	boolean	Invert the logic of this condition. Defaults to false.
notEqualTo	CharSequence	Value that the string must not match.
startsWith	CharSequence	Prefix for the string.
value	CharSequence	Literal value the string should match.

boolCondition

Tests session variable containing boolean value.

Property	Type	Description
fromVar	String	Variable name.
value	boolean	Expected value.

intCondition

Condition comparing integer in session variable.

Inline definition
Parses condition in the form <variable> <operator> <value>
where operator is one of: `==`, `!=`,
`<>` (the same as `!=`),
`>=`, `>`, `<=`, `<`.

Property	Type	Description
equalTo	Builder	Compared variable must be equal to this value.
fromVar	Object	Variable name.
greaterOrEqualTo	Builder	Compared variable must be greater or equal to this value.
greaterThan	Builder	Compared variable must be greater than this value.
isSet	boolean	Check if the value is set or unset. By default the variable must be set.
lessOrEqualTo	Builder	Compared variable must be lower or equal to this value.
lessThan	Builder	Compared variable must be lower than this value.
notEqualTo	Builder	Compared variable must not be equal to this value.

intCondition.equalTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

intCondition.greaterOrEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

intCondition.greaterThan

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

intCondition.lessOrEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

intCondition.lessThan

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

intCondition.notEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

stringCondition

Condition comparing string in session variable.

Property	Type	Description
caseSensitive	boolean	True if the case must match, false if the check is case-insensitive.
endsWith	CharSequence	Suffix for the string.
equalTo	CharSequence	Literal value the string should match (the same as {@link #value}).
fromVar	Object	Variable name.
isSet	boolean	Check if the value is set or unset. By default the variable must be set.
length	int	Check the length of the string.
length (alternative)	Builder	Check the length of the string.
matchVar	String	Fetch the value from a variable.
negate	boolean	Invert the logic of this condition. Defaults to false.
notEqualTo	CharSequence	Value that the string must not match.
startsWith	CharSequence	Prefix for the string.
value	CharSequence	Literal value the string should match.

stringCondition.length

Property	Type	Description
equalTo	Builder	Compared variable must be equal to this value.
greaterOrEqualTo	Builder	Compared variable must be greater or equal to this value.
greaterThan	Builder	Compared variable must be greater than this value.
lessOrEqualTo	Builder	Compared variable must be lower or equal to this value.
lessThan	Builder	Compared variable must be lower than this value.
notEqualTo	Builder	Compared variable must not be equal to this value.

stringCondition.length.equalTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

stringCondition.length.greaterOrEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

stringCondition.length.greaterThan

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

stringCondition.length.lessOrEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

stringCondition.length.lessThan

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

stringCondition.length.notEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

3.6 - fail

Fail the phase with given message. Used mostly for testing/debugging.

Inline definition
Message to fail with (unconditionally).

Property	Type	Description
allConditions	Builder	Condition combining multiple other conditions with ‘AND’ logic.
boolCondition	Builder	Condition comparing boolean variables.
intCondition	Builder	Condition comparing integer variables.
message	String	Message attached to the failure exception.
stringCondition	Builder	Condition comparing string variables.

allConditions

Test more conditions and combine the results using AND logic.

Property	Type	Description
<list of mappings>	<list of builders>	List of conditions.

allConditions.<list of mappings>

Selector for condition type.

Property	Type	Description
allConditions	Builder	Condition combining multiple other conditions with ‘AND’ logic.
boolCondition	Builder	Condition comparing boolean variables.
intCondition	Builder	Condition comparing integer variables.
stringCondition	Builder	Condition comparing string variables.

allConditions.<list of mappings>.allConditions

Test more conditions and combine the results using AND logic.

Property	Type	Description
<list of mappings>	<list of builders>	List of conditions.

allConditions.<list of mappings>.boolCondition

Tests session variable containing boolean value.

Property	Type	Description
fromVar	String	Variable name.
value	boolean	Expected value.

allConditions.<list of mappings>.intCondition

Condition comparing integer in session variable.

Inline definition
Parses condition in the form <variable> <operator> <value>
where operator is one of: `==`, `!=`,
`<>` (the same as `!=`),
`>=`, `>`, `<=`, `<`.

Property	Type	Description
equalTo	Builder	Compared variable must be equal to this value.
fromVar	Object	Variable name.
greaterOrEqualTo	Builder	Compared variable must be greater or equal to this value.
greaterThan	Builder	Compared variable must be greater than this value.
isSet	boolean	Check if the value is set or unset. By default the variable must be set.
lessOrEqualTo	Builder	Compared variable must be lower or equal to this value.
lessThan	Builder	Compared variable must be lower than this value.
notEqualTo	Builder	Compared variable must not be equal to this value.

allConditions.<list of mappings>.stringCondition

Condition comparing string in session variable.

Property	Type	Description
caseSensitive	boolean	True if the case must match, false if the check is case-insensitive.
endsWith	CharSequence	Suffix for the string.
equalTo	CharSequence	Literal value the string should match (the same as {@link #value}).
fromVar	Object	Variable name.
isSet	boolean	Check if the value is set or unset. By default the variable must be set.
length	int	Check the length of the string.
length (alternative)	Builder	Check the length of the string.
matchVar	String	Fetch the value from a variable.
negate	boolean	Invert the logic of this condition. Defaults to false.
notEqualTo	CharSequence	Value that the string must not match.
startsWith	CharSequence	Prefix for the string.
value	CharSequence	Literal value the string should match.

boolCondition

Tests session variable containing boolean value.

Property	Type	Description
fromVar	String	Variable name.
value	boolean	Expected value.

intCondition

Condition comparing integer in session variable.

Inline definition
Parses condition in the form <variable> <operator> <value>
where operator is one of: `==`, `!=`,
`<>` (the same as `!=`),
`>=`, `>`, `<=`, `<`.

Property	Type	Description
equalTo	Builder	Compared variable must be equal to this value.
fromVar	Object	Variable name.
greaterOrEqualTo	Builder	Compared variable must be greater or equal to this value.
greaterThan	Builder	Compared variable must be greater than this value.
isSet	boolean	Check if the value is set or unset. By default the variable must be set.
lessOrEqualTo	Builder	Compared variable must be lower or equal to this value.
lessThan	Builder	Compared variable must be lower than this value.
notEqualTo	Builder	Compared variable must not be equal to this value.

intCondition.equalTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

intCondition.greaterOrEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

intCondition.greaterThan

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

intCondition.lessOrEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

intCondition.lessThan

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

intCondition.notEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

stringCondition

Condition comparing string in session variable.

Property	Type	Description
caseSensitive	boolean	True if the case must match, false if the check is case-insensitive.
endsWith	CharSequence	Suffix for the string.
equalTo	CharSequence	Literal value the string should match (the same as {@link #value}).
fromVar	Object	Variable name.
isSet	boolean	Check if the value is set or unset. By default the variable must be set.
length	int	Check the length of the string.
length (alternative)	Builder	Check the length of the string.
matchVar	String	Fetch the value from a variable.
negate	boolean	Invert the logic of this condition. Defaults to false.
notEqualTo	CharSequence	Value that the string must not match.
startsWith	CharSequence	Prefix for the string.
value	CharSequence	Literal value the string should match.

stringCondition.length

Property	Type	Description
equalTo	Builder	Compared variable must be equal to this value.
greaterOrEqualTo	Builder	Compared variable must be greater or equal to this value.
greaterThan	Builder	Compared variable must be greater than this value.
lessOrEqualTo	Builder	Compared variable must be lower or equal to this value.
lessThan	Builder	Compared variable must be lower than this value.
notEqualTo	Builder	Compared variable must not be equal to this value.

stringCondition.length.equalTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

stringCondition.length.greaterOrEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

stringCondition.length.greaterThan

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

stringCondition.length.lessOrEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

stringCondition.length.lessThan

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

stringCondition.length.notEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

3.7 - getIndex

Lookup index of an item in an array/collection.

Property	Type	Description
collection	String	Variable to fetch the collection from.
item	Builder	Item that should be looked up (using equality).
toVar	String	Integer variable to store the index, or -1 if the item is not found.

item

Inline definition
Verbatim value.

Property	Type	Description
fromVar	String	Fetch value from session variable.
value	String	Verbatim value.

3.8 - getItem

Retrieves n-th item from an array or collection.

Property	Type	Description
fromVar	String	Source variable with an array or list.
index	Builder	Source for index into the array/list.
toVar	String	Destination variable for the n-th element.

index

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

3.9 - getSharedCounter

Retrieves value from a counter shared by all sessions in the same executor and stores that in a session variable.

Retrieves value from a counter shared by all sessions in the same executor and stores that in a session variable.
If the value exceeds allowed integer range (-2^31 .. 2^31 - 1) it is capped.

Inline definition
Both the key and variable name.

Property	Type	Description
key	String	Identifier for the counter.
toVar	String	Session variable for storing the value.

3.10 - getSize

Calculates size of an array/collection held in variable into another variable

Property	Type	Description
boolFilter	Builder	Count only items matching the condition.
fromVar	String	Variable holding the collection.
intFilter	Builder	Count only items matching the condition.
stringFilter	Builder	Count only items matching the condition.
toVar	String	Variable storing the size.
undefinedValue	int	Value to use when `fromVar` is unset or it does not contain any array/collection.

boolFilter

Property	Type	Description
value	boolean	Expected value.

intFilter

Property	Type	Description
equalTo	Builder	Compared variable must be equal to this value.
greaterOrEqualTo	Builder	Compared variable must be greater or equal to this value.
greaterThan	Builder	Compared variable must be greater than this value.
lessOrEqualTo	Builder	Compared variable must be lower or equal to this value.
lessThan	Builder	Compared variable must be lower than this value.
notEqualTo	Builder	Compared variable must not be equal to this value.

intFilter.equalTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

intFilter.greaterOrEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

intFilter.greaterThan

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

intFilter.lessOrEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

intFilter.lessThan

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

intFilter.notEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

stringFilter

Property	Type	Description
caseSensitive	boolean	True if the case must match, false if the check is case-insensitive.
endsWith	CharSequence	Suffix for the string.
equalTo	CharSequence	Literal value the string should match (the same as {@link #value}).
length	int	Check the length of the string.
length (alternative)	Builder	Check the length of the string.
matchVar	String	Fetch the value from a variable.
negate	boolean	Invert the logic of this condition. Defaults to false.
notEqualTo	CharSequence	Value that the string must not match.
startsWith	CharSequence	Prefix for the string.
value	CharSequence	Literal value the string should match.

stringFilter.length

Property	Type	Description
equalTo	Builder	Compared variable must be equal to this value.
greaterOrEqualTo	Builder	Compared variable must be greater or equal to this value.
greaterThan	Builder	Compared variable must be greater than this value.
lessOrEqualTo	Builder	Compared variable must be lower or equal to this value.
lessThan	Builder	Compared variable must be lower than this value.
notEqualTo	Builder	Compared variable must not be equal to this value.

stringFilter.length.equalTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

stringFilter.length.greaterOrEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

stringFilter.length.greaterThan

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

stringFilter.length.lessOrEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

stringFilter.length.lessThan

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

stringFilter.length.notEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

3.11 - log

Log a message and variable values.

Inline definition
A pattern for string interpolation.

Property	Type	Description
message	String	Message format pattern. Use string interpolation for variables.

3.12 - markRequestInvalid

Unconditionally mark currently processed request as invalid.

3.13 - newSequence

Instantiates a sequence for each invocation.

Inline definition
Sequence name.

Property	Type	Description
concurrencyPolicy	enum	Options: `FAIL` `WARN`
forceSameIndex	boolean	Forces that the sequence will have the same index as the currently executing sequence. This can be useful if the sequence is passing some data to the new sequence using sequence-scoped variables. Note that the new sequence must have same concurrency factor as the currently executing sequence.
sequence	String	Name of the instantiated sequence.

3.14 - publishAgentData

Makes the data available to all sessions in the same agent, including those using different executors.

Inline definition
Both name of source variable and the key used to read the data.

Property	Type	Description
fromVar	String	Source session variable name.
name	String	Arbitrary unique identifier for the data.

3.15 - publishGlobalCounters

Gathers values from session variables and publishes them globally (to all agents).

Gathers values from session variables and publishes them globally (to all agents).
You can name the counters individually (example 1) or use the variable names (example 2):

# Example 1:
- publishGlobalCounters:
    key: myKey
    vars: [ foo, bar ]
# Example 2:
- publishGlobalCounters:
    key: someOtherKey
    vars:
    - foo: myFoo
    - bar: bbb
</code>```


| Property | Type | Description |
| ------- | ------- | -------- |
| key | String | Identifier of the global record. |
| vars | [Builder](#vars) | List of names and session variables. |

### vars

| Property | Type | Description |
| ------- | ------- | ------- |
| &lt;any&gt; | &lt;unknown&gt; | <font color="#606060">&lt;no description&gt;</font> |
| &lt;list of strings&gt; | &lt;unknown&gt; | <font color="#606060">&lt;no description&gt;</font> |

3.16 - readAgentData

Reads data from agent-wide scope into session variable.

Inline definition
Both the identifier and destination session variable.

Property	Type	Description
name	String	Unique identifier for the data.
toVar	String	Destination session variable name.

3.17 - removeItem

Removes element from an array of variables.

Property	Type	Description
fromVar	String	Variable containing an existing array of object variables.
index	Builder	Set index at which the item should be removed. Elements to the right of this are moved to the left.

index

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

3.18 - restartSequence

Schedules a restart of this sequence.

3.19 - set

Set variable in session to certain value.

Inline definition
Use `var <- value`.

Property	Type	Description
intArray	Builder	Set variable to an (unset) integer array.
objectArray	Builder	Set variable to an (unset) object array.
value	String	String value.
var	String	Variable name.

intArray

Creates integer arrays to be stored in the session.

Property	Type	Description
fromVar	String	Contents of the new array. If the variable contains an array or a list, items will be copied to the elements with the same index up to the size of this array. If the variable contains a different value all elements will be initialized to this value.
size	int	Size of the array.

objectArray

Creates object arrays to be stored in the session.

Property	Type	Description
fromVar	String	Contents of the new array. If the variable contains an array or a list, items will be copied to the elements with the same index up to the size of this array. If the variable contains a different value all elements will be initialized to this value.
size	int	Size of the array.

3.20 - setInt

Set session variable to an integral value.

Inline definition
Use `var <- value`.

Property	Type	Description
fromVar	String	Input variable name.
intCondition	Builder	Set variable only if the current value satisfies certain condition.
max	Builder	Set to value that is the maximum of this list of values.
min	Builder	Set to value that is the minimum of this list of values.
onlyIfNotSet	boolean	Set variable to the value only if it is not already set.
value	int	Value (integer).
var	String	Variable name.

intCondition

Property	Type	Description
equalTo	Builder	Compared variable must be equal to this value.
greaterOrEqualTo	Builder	Compared variable must be greater or equal to this value.
greaterThan	Builder	Compared variable must be greater than this value.
lessOrEqualTo	Builder	Compared variable must be lower or equal to this value.
lessThan	Builder	Compared variable must be lower than this value.
notEqualTo	Builder	Compared variable must not be equal to this value.

intCondition.equalTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

intCondition.greaterOrEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

intCondition.greaterThan

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

intCondition.lessOrEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

intCondition.lessThan

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

intCondition.notEqualTo

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

max

Property	Type	Description
<list of mappings>	<list of builders>	<no description>

max.<list of mappings>

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

min

Property	Type	Description
<list of mappings>	<list of builders>	<no description>

3.21 - setItem

Set element in a collection on given position.

Property	Type	Description
fromVar	String	Fetch value from session variable.
index	Builder	Integer session variable with an index into the collection.
toVar	String	Session variable with the collection.
value	String	Verbatim value.

index

Inline definition
Uses the argument as a constant value.

Property	Type	Description
fromVar	String	Input variable name.
value	int	Value (integer).

3.22 - setSharedCounter

Sets value in a counter shared by all sessions in the same executor.

Inline definition
Both the name of the counter and variable name.

Property	Type	Description
fromVar	String	Input variable name.
key	String	Identifier for the counter.
value	int	Value (integer).

3.23 - stringToInt

Parse string into integer and store it in a variable.

If the parsing fails the target variable is not modified.

Inline definition
Use `fromVar -> toVar`

Property	Type	Description
fromVar	String	Source variable name.
toVar	String	Target variable name.

3.24 - unset

Undefine variable name.

Inline definition
Variable name.

Property	Type	Description
var	Object	Variable name.