Hyperfoil reference

Steps

• addItem: Appends value to an array stored in another variable.
• addToInt: Add value to integer variable in the session.
• addToSharedCounter: Adds value to a counter shared by all sessions in the same executor.
• awaitAllResponses: Block current sequence until all requests receive the response.
• awaitDelay: Block this sequence until referenced delay point.
• awaitInt: Block current sequence until condition becomes true.
• awaitVar: Block current sequence until this variable gets set/unset.
• breakIfFinished
• breakSequence: Prematurely stops execution of this sequence if the condition is satisfied.
• clearHttpCache: Drops all entries from HTTP cache in the session.
• conditional: Perform an action or sequence of actions conditionally.
• fail: Fail the phase with given message. Used mostly for testing/debugging.
• foreach: Instantiate new sequences based on array variable content.
• getIndex: Lookup index of an item in an array/collection.
• getItem: Retrieves n-th item from an array or collection.
• getSharedCounter: 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.
• getSize: Calculates size of an array/collection held in variable into another variable
• hotrodRequest: Issues a HotRod request and registers handlers for the response.
• httpRequest: Issues a HTTP request and registers handlers for the response.
• json: Parse JSON in variable into another variable.
• log: Log a message and variable values.
• loop: Repeats a set of steps fixed number of times.
• markRequestInvalid
• newSequence: Instantiates a sequence for each invocation.
• nextSequence: Schedules a new sequence instance to be executed.
• noop: Does nothing. Only for demonstration purposes.
• publishAgentData: Makes the data available to all sessions in the same agent, including those using different executors.
• publishGlobalCounters: 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
• pullSharedMap: Move values from a map shared across all sessions using the same executor into session variables.
• pushSharedMap: Store values from session variables into a map shared across all sessions using the same executor into session variables.
• randomCsvRow: Stores random row from a CSV-formatted file to variables.
• randomFile: Reads bytes from a randomly chosen file into a variable. Two formats are supported: Example 1 - without weights:
• randomInt: Stores random (linearly distributed) integer into session variable.
• randomItem: Stores random item from a list or array into session variable.
• randomUUID: Stores random string into session variable based on the UUID generator.
• readAgentData: 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.
• removeItem: Removes element from an array of variables.
• restartSequence: Restarts current sequence from beginning.
• scheduleDelay: Define a point in future until which we should wait. Does not cause waiting.
• set: Set variable in session to certain value.
• setInt: Set session variable to an integral value.
• setItem: Set element in a collection on given position.
• setSharedCounter: Sets value in a counter shared by all sessions in the same executor.
• stop: Immediately stop the user session (break all running sequences).
• stopwatch: Run nested sequence of steps, recording execution time.
• stringToInt
• template: Format pattern into session variable.
• thinkTime: Block current sequence for specified duration.
• timestamp: Stores the current time in milliseconds as {@link String} to a session variable.
• unset: Undefine variable name.

Actions

• addItem: Appends value to an array stored in another variable.
• addToInt: Add value to integer variable in the session.
• addToSharedCounter: Adds value to a counter shared by all sessions in the same executor.
• clearHttpCache: Drops all entries from HTTP cache in the session.
• conditional: Perform an action or sequence of actions conditionally.
• fail: Fail the phase with given message. Used mostly for testing/debugging.
• getIndex: Lookup index of an item in an array/collection.
• getItem: Retrieves n-th item from an array or collection.
• getSharedCounter: 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.
• getSize: Calculates size of an array/collection held in variable into another variable
• log: Log a message and variable values.
• markRequestInvalid
• newSequence: Instantiates a sequence for each invocation.
• publishAgentData: Makes the data available to all sessions in the same agent, including those using different executors.
• publishGlobalCounters: 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
• readAgentData: 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.
• removeItem: Removes element from an array of variables.
• restartSequence: Schedules a restart of this sequence.
• set: Set variable in session to certain value.
• setInt: Set session variable to an integral value.
• setItem: Set element in a collection on given position.
• setSharedCounter: Sets value in a counter shared by all sessions in the same executor.
• stringToInt
• unset: Undefine variable name.

Processors

• addItem: Appends value to an array stored in another variable.
• addToInt: Add value to integer variable in the session.
• addToSharedCounter: Adds value to a counter shared by all sessions in the same executor.
• array: Stores data in an array stored as session variable.
• clearHttpCache: Drops all entries from HTTP cache in the session.
• closeConnection
• collection: Collects results of processor invocation into a unbounded list. WARNING: This processor should be used rarely as it allocates memory during the benchmark.
• conditional: 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.
• count: Records number of parts this processor is invoked on.
• fail: Fail the phase with given message. Used mostly for testing/debugging.
• getIndex: Lookup index of an item in an array/collection.
• getItem: Retrieves n-th item from an array or collection.
• getSharedCounter: 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.
• getSize: Calculates size of an array/collection held in variable into another variable
• gzipInflator: 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.
• json: Parses JSON responses using simple queries.
• log: Log a message and variable values.
• logInvalid: Logs body chunks from requests marked as invalid.
• markRequestInvalid
• newSequence: Instantiates a sequence for each invocation.
• parseHtml: Parses HTML tags and invokes handlers based on criteria.
• publishAgentData: Makes the data available to all sessions in the same agent, including those using different executors.
• publishGlobalCounters: 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
• 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.
• readAgentData: 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.
• removeItem: Removes element from an array of variables.
• restartSequence: Schedules a restart of this sequence.
• set: Set variable in session to certain value.
• setInt: Set session variable to an integral value.
• setItem: Set element in a collection on given position.
• setSharedCounter: Sets value in a counter shared by all sessions in the same executor.
• simple: DEPRECATED: Use store processor instead.
• store: Stores data in a session variable (overwriting on multiple occurences).
• storeInt: Converts buffers into integral value and stores it in a variable.
• stringToInt
• unset: Undefine variable name.