Hyperfoil benchmark configuration

Benchmark definition format for the Hyperfoil HTTP benchmark framework

Type object
File match *.hf.yaml
Schema URL https://catalog.lintel.tools/schemas/schemastore/hyperfoil-benchmark-configuration/latest.json
Source https://hyperfoil.io/schema.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Hyperfoil benchmark configuration

Properties

name string required

Name of the benchmark.

http http[] | http required
$schema string

This should point to either http://hyperfoil.io/schema.json or local file

agents object | object[]

Agent nodes that should drive the load.

threads integer
min=1
ergonomics object

Adjust scenario to implement common functionality out-of-the-box.

5 nested properties
repeatCookies boolean

Store cookies in session and resend them on future requests. Default is true.

userAgentFromSession boolean

Append session ID and client hostname as user agent

autoRangeCheck boolean

Inject status handler that marks the request as invalid on status 4xx or 5xx. Default is true.

stopOnInvalid boolean

Inject completion handler that will stop the session if the request has been marked as invalid. Default is true.

followRedirect enum

Automatically fire requests when the server responds with redirection. Default is NEVER.

Values: "NEVER" "LOCATION_ONLY" "HTML_ONLY" "ALWAYS"
phases object[]

Benchmark execution phases.

minItems=1
staircase object
7 nested properties
initialRampUpDuration integer | string
steadyStateDuration integer | string
rampUpDuration integer | string
initialUsersPerSec number
exclusiveMin=0
incrementUsersPerSec number
exclusiveMin=0
maxIterations integer
min=1
maxSessions integer
min=1
usersPerSec positiveNumber | object
maxSessions integer
min=1
duration integer | string
maxDuration integer | string
scenario object | sequence[]

Definitions

agent string | number | boolean | object
ergonomics object

Adjust scenario to implement common functionality out-of-the-box.

repeatCookies boolean

Store cookies in session and resend them on future requests. Default is true.

userAgentFromSession boolean

Append session ID and client hostname as user agent

autoRangeCheck boolean

Inject status handler that marks the request as invalid on status 4xx or 5xx. Default is true.

stopOnInvalid boolean

Inject completion handler that will stop the session if the request has been marked as invalid. Default is true.

followRedirect enum

Automatically fire requests when the server responds with redirection. Default is NEVER.

Values: "NEVER" "LOCATION_ONLY" "HTML_ONLY" "ALWAYS"
http object

HTTP connection pool configuration.

host string required

Target hostname. For simplicity this can include scheme and port, too.

protocol enum
Values: "http" "https"
port integer

Target TCP port

min=1max=65535
addresses string[]

List of IP addresses that should be used. The connections will be randomly created to addresses in this list, or using host if it's empty.

allowHttp1x boolean

Allow using HTTP 1.0 and HTTP 1.1 connections. Default is true.

allowHttp2 boolean

Allow using HTTP 2.0 connections. Default is true.

connectionStrategy enum

Connection pooling model. Default is SHARED_POOL.

Values: "SHARED_POOL" "SESSION_POOLS" "OPEN_ON_REQUEST" "ALWAYS_NEW"
directHttp2 boolean

Start HTTP 2.0 connections without HTTP 1.x -> 2.0 upgrade. Default is false.

keyManager object

TLS key manager for setting up client certificates.

6 nested properties
storeType string
storeFile string
password string
alias string
certFile string
keyFile string
maxHttp2Streams integer
min=1
sharedConnections positiveInteger | object

Maximum number of connections to the server, shared between all phases and sessions. Default is 1.

pipeliningLimit integer
min=1
requestTimeout integer | string
rawBytesHandlers boolean

Add handlers to support parsing raw HTTP responses. Default is true.

trustManager object

TLS trust manager for setting up server certificates.

4 nested properties
storeType string
storeFile string
password string
certFile string
useHttpCache boolean

Make use of HTTP cache on client-side. If multiple authorities are involved, disable the HTTP cache for all of them to achieve the desired outcomes. The default is true except for wrk/wrk2 wrappers where it is set to false.

incrementableInteger positiveInteger | object
incrementableNumber positiveNumber | object
positiveInteger integer
positiveNumber number
phase object
startTime integer | string
startAfter phaseReference | phaseReference[]
startAfterStrict phaseReference | phaseReference[]
duration integer | string
maxDuration integer | string
maxIterations integer
min=1
scenario object | sequence[]
forks object[] | object

Concurrent sub-phases sharing the limits and users arrivals.

fork object
weight number
scenario object | sequence[]
phaseReferenceList phaseReference | phaseReference[]
phaseReference string | object
rampRatePhase

Add new users to the system at varying rate.

scenario object | sequence[]
sequence object
step object | enum
timeMillis integer | string
timeNanos string
io.hyperfoil.api.config.ListBuilder object
io.hyperfoil.api.config.SLABuilder object
blockedRatio number
errorRatio number
invalidRatio number
limits object | object[] | io.hyperfoil.api.config.SLABuilder$LimitsBuilder | io.hyperfoil.api.config.SLABuilder$LimitsBuilder[]
meanResponseTime string
window string
io.hyperfoil.api.config.SLABuilder$LimitsBuilder object
io.hyperfoil.api.config.SLABuilder$ListBuilder object
io.hyperfoil.api.processor.Processor$Builder object
addItem object
3 nested properties
fromVar string
toVar string
value string
addToInt io.hyperfoil.core.steps.AddToIntAction$Builder | string
addToSharedCounter io.hyperfoil.core.steps.data.AddToSharedCounterAction$Builder | string
array io.hyperfoil.core.handlers.ArrayRecorder$Builder | string
clearHttpCache object
closeConnection object
collection io.hyperfoil.core.handlers.CollectionRecorder$Builder | string
conditional object
5 nested properties
allConditions io.hyperfoil.core.builders.Condition$TypesBuilder | io.hyperfoil.core.builders.Condition$TypesBuilder[] | io.hyperfoil.core.builders.AllConditions$Builder | io.hyperfoil.core.builders.AllConditions$Builder[]
boolCondition io.hyperfoil.core.builders.BoolCondition$Builder | io.hyperfoil.core.builders.BoolCondition$Builder[]
intCondition io.hyperfoil.core.builders.IntCondition$Builder | io.hyperfoil.core.builders.IntCondition$Builder[]
processor io.hyperfoil.api.processor.Processor$Builder | io.hyperfoil.api.processor.Processor$Builder[]
stringCondition io.hyperfoil.core.builders.StringCondition$Builder | io.hyperfoil.core.builders.StringCondition$Builder[]
count io.hyperfoil.core.handlers.CountRecorder$Builder | string
fail io.hyperfoil.core.steps.FailAction$Builder | string
getIndex object
3 nested properties
collection string
item io.hyperfoil.core.builders.ObjectSourceBuilder | io.hyperfoil.core.builders.ObjectSourceBuilder[]
toVar string
getItem object
3 nested properties
fromVar string
index io.hyperfoil.core.builders.IntSourceBuilder | io.hyperfoil.core.builders.IntSourceBuilder[]
toVar string
getSharedCounter io.hyperfoil.core.steps.data.GetSharedCounterAction$Builder | string
getSize object
6 nested properties
boolFilter io.hyperfoil.core.steps.collections.BoolFilter$Builder | io.hyperfoil.core.steps.collections.BoolFilter$Builder[]
fromVar string
intFilter io.hyperfoil.core.steps.collections.IntFilter$Builder | io.hyperfoil.core.steps.collections.IntFilter$Builder[]
stringFilter io.hyperfoil.core.steps.collections.StringFilter$Builder | io.hyperfoil.core.steps.collections.StringFilter$Builder[]
toVar string
undefinedValue integer
gzipInflator object
2 nested properties
encodingVar string
processor io.hyperfoil.api.processor.Processor$Builder | io.hyperfoil.api.processor.Processor$Builder[]
json io.hyperfoil.core.handlers.json.JsonHandler$Builder | string
log io.hyperfoil.core.steps.LogAction$Builder | string
logInvalid object
markRequestInvalid object
newSequence io.hyperfoil.core.handlers.NewSequenceAction$Builder | string
parseHtml object
2 nested properties
onEmbeddedResource io.hyperfoil.http.html.EmbeddedResourceHandlerBuilder | io.hyperfoil.http.html.EmbeddedResourceHandlerBuilder[]
onTagAttribute io.hyperfoil.http.html.TagAttributeHandlerBuilder | io.hyperfoil.http.html.TagAttributeHandlerBuilder[]
publishAgentData io.hyperfoil.core.steps.data.PublishAgentDataAction$Builder | string
publishGlobalCounters object
2 nested properties
key string
vars object | object[] | string[] | io.hyperfoil.core.steps.data.PublishGlobalCountersAction$Builder$VarsBuilder | io.hyperfoil.core.steps.data.PublishGlobalCountersAction$Builder$VarsBuilder[]
queue object
6 nested properties
concurrency integer
format enum
Values: "BYTEBUF" "BYTES" "STRING"
maxSize integer
onCompletion io.hyperfoil.api.session.Action$Builder | io.hyperfoil.api.session.Action$Builder[]
sequence string
var string
readAgentData io.hyperfoil.core.steps.data.ReadAgentDataAction$Builder | string
removeItem object
2 nested properties
fromVar string
index io.hyperfoil.core.builders.IntSourceBuilder | io.hyperfoil.core.builders.IntSourceBuilder[]
restartSequence object
set io.hyperfoil.core.steps.SetAction$Builder | string
setInt io.hyperfoil.core.steps.SetIntAction$Builder | string
setItem object
4 nested properties
fromVar string
index io.hyperfoil.core.builders.IntSourceBuilder | io.hyperfoil.core.builders.IntSourceBuilder[]
toVar string
value string
setSharedCounter io.hyperfoil.core.steps.data.SetSharedCounterAction$Builder | string
simple io.hyperfoil.core.handlers.StoreProcessor$LegacyBuilder | string
store io.hyperfoil.core.handlers.StoreProcessor$Builder | string
storeInt io.hyperfoil.core.handlers.StoreIntProcessor$Builder | string
stringToInt io.hyperfoil.core.steps.StringToIntAction$Builder | string
unset io.hyperfoil.core.steps.UnsetAction$Builder | string
io.hyperfoil.api.processor.RawBytesHandler$Builder object
transferSizeRecorder object
1 nested properties
key string
io.hyperfoil.api.processor.Transformer$Builder object
actions object
4 nested properties
actions io.hyperfoil.api.session.Action$Builder | io.hyperfoil.api.session.Action$Builder[]
format enum
Values: "BYTEBUF" "BYTES" "STRING"
pattern string
var string
pattern io.hyperfoil.core.generators.Pattern$TransformerBuilder | string
io.hyperfoil.api.session.Action$Builder object
addItem object
3 nested properties
fromVar string
toVar string
value string
addToInt io.hyperfoil.core.steps.AddToIntAction$Builder | string
addToSharedCounter io.hyperfoil.core.steps.data.AddToSharedCounterAction$Builder | string
clearHttpCache object
conditional object
5 nested properties
actions io.hyperfoil.api.session.Action$Builder | io.hyperfoil.api.session.Action$Builder[]
allConditions io.hyperfoil.core.builders.Condition$TypesBuilder | io.hyperfoil.core.builders.Condition$TypesBuilder[] | io.hyperfoil.core.builders.AllConditions$Builder | io.hyperfoil.core.builders.AllConditions$Builder[]
boolCondition io.hyperfoil.core.builders.BoolCondition$Builder | io.hyperfoil.core.builders.BoolCondition$Builder[]
intCondition io.hyperfoil.core.builders.IntCondition$Builder | io.hyperfoil.core.builders.IntCondition$Builder[]
stringCondition io.hyperfoil.core.builders.StringCondition$Builder | io.hyperfoil.core.builders.StringCondition$Builder[]
fail io.hyperfoil.core.steps.FailAction$Builder | string
getIndex object
3 nested properties
collection string
item io.hyperfoil.core.builders.ObjectSourceBuilder | io.hyperfoil.core.builders.ObjectSourceBuilder[]
toVar string
getItem object
3 nested properties
fromVar string
index io.hyperfoil.core.builders.IntSourceBuilder | io.hyperfoil.core.builders.IntSourceBuilder[]
toVar string
getSharedCounter io.hyperfoil.core.steps.data.GetSharedCounterAction$Builder | string
getSize object
6 nested properties
boolFilter io.hyperfoil.core.steps.collections.BoolFilter$Builder | io.hyperfoil.core.steps.collections.BoolFilter$Builder[]
fromVar string
intFilter io.hyperfoil.core.steps.collections.IntFilter$Builder | io.hyperfoil.core.steps.collections.IntFilter$Builder[]
stringFilter io.hyperfoil.core.steps.collections.StringFilter$Builder | io.hyperfoil.core.steps.collections.StringFilter$Builder[]
toVar string
undefinedValue integer
log io.hyperfoil.core.steps.LogAction$Builder | string
markRequestInvalid object
newSequence io.hyperfoil.core.handlers.NewSequenceAction$Builder | string
publishAgentData io.hyperfoil.core.steps.data.PublishAgentDataAction$Builder | string
publishGlobalCounters object
2 nested properties
key string
vars object | object[] | string[] | io.hyperfoil.core.steps.data.PublishGlobalCountersAction$Builder$VarsBuilder | io.hyperfoil.core.steps.data.PublishGlobalCountersAction$Builder$VarsBuilder[]
readAgentData io.hyperfoil.core.steps.data.ReadAgentDataAction$Builder | string
removeItem object
2 nested properties
fromVar string
index io.hyperfoil.core.builders.IntSourceBuilder | io.hyperfoil.core.builders.IntSourceBuilder[]
restartSequence object
set io.hyperfoil.core.steps.SetAction$Builder | string
setInt io.hyperfoil.core.steps.SetIntAction$Builder | string
setItem object
4 nested properties
fromVar string
index io.hyperfoil.core.builders.IntSourceBuilder | io.hyperfoil.core.builders.IntSourceBuilder[]
toVar string
value string
setSharedCounter io.hyperfoil.core.steps.data.SetSharedCounterAction$Builder | string
stringToInt io.hyperfoil.core.steps.StringToIntAction$Builder | string
unset io.hyperfoil.core.steps.UnsetAction$Builder | string
io.hyperfoil.core.builders.AllConditions$Builder object
io.hyperfoil.core.builders.BoolCondition$Builder object
fromVar string
value boolean
io.hyperfoil.core.builders.IntSourceBuilder object
fromVar string
value integer
io.hyperfoil.core.builders.IntSourceBuilder$ListBuilder object
io.hyperfoil.core.builders.ObjectSourceBuilder object
fromVar string
value string
io.hyperfoil.core.builders.StringCondition$Builder object
caseSensitive boolean
endsWith string
equalTo string
fromVar string
isSet boolean
length io.hyperfoil.core.builders.StringConditionBuilder$LengthBuilder | io.hyperfoil.core.builders.StringConditionBuilder$LengthBuilder[] | integer
matchVar string
negate boolean
notEqualTo string
startsWith string
value string
io.hyperfoil.core.builders.StringConditionBuilder object
caseSensitive boolean
endsWith string
equalTo string
length io.hyperfoil.core.builders.StringConditionBuilder$LengthBuilder | io.hyperfoil.core.builders.StringConditionBuilder$LengthBuilder[] | integer
matchVar string
negate boolean
notEqualTo string
startsWith string
value string
io.hyperfoil.core.generators.ActionsTransformer$Builder object
actions io.hyperfoil.api.session.Action$Builder | io.hyperfoil.api.session.Action$Builder[]
format enum
Values: "BYTEBUF" "BYTES" "STRING"
pattern string
var string
io.hyperfoil.core.generators.IntValueProviderBuilder object
fromVar string
value integer
io.hyperfoil.core.generators.Pattern$TransformerBuilder object
pattern string
io.hyperfoil.core.generators.RandomCsvRowStep$Builder object
columns object | object[] | io.hyperfoil.core.generators.RandomCsvRowStep$Builder$ColumnsBuilder | io.hyperfoil.core.generators.RandomCsvRowStep$Builder$ColumnsBuilder[]
file string
separator string
skipComments boolean
io.hyperfoil.core.generators.RandomCsvRowStep$Builder$ColumnsBuilder object
io.hyperfoil.core.generators.RandomFileStep$Builder object
filenameVar string
files object | object[] | string[] | io.hyperfoil.core.generators.WeightedGenerator$Builder | io.hyperfoil.core.generators.WeightedGenerator$Builder[]
toVar string
io.hyperfoil.core.generators.RandomItemStep$Builder object
file string
fromVar string
list object | object[] | string[] | io.hyperfoil.core.generators.WeightedGenerator$Builder | io.hyperfoil.core.generators.WeightedGenerator$Builder[]
toVar string
io.hyperfoil.core.generators.RandomUUIDStep$Builder object
toVar string
io.hyperfoil.core.generators.StringGeneratorImplBuilder object
fromVar string
pattern string
value string
io.hyperfoil.core.generators.TemplateStep$Builder object
pattern string
toVar string
io.hyperfoil.core.generators.WeightedGenerator$Builder object
io.hyperfoil.core.handlers.ArrayRecorder$Builder object
format enum
Values: "BYTEBUF" "BYTES" "STRING"
maxSize integer
silent boolean
toVar string
io.hyperfoil.core.handlers.CloseConnectionHandler$Builder object
io.hyperfoil.core.handlers.CollectionRecorder$Builder object
format enum
Values: "BYTEBUF" "BYTES" "STRING"
toVar string
io.hyperfoil.core.handlers.CountRecorder$Builder object
toVar string
io.hyperfoil.core.handlers.GzipInflatorProcessor$Builder object
encodingVar string
processor io.hyperfoil.api.processor.Processor$Builder | io.hyperfoil.api.processor.Processor$Builder[]
io.hyperfoil.core.handlers.MarkRequestInvalidAction$Builder object
io.hyperfoil.core.handlers.NewSequenceAction$Builder object
concurrencyPolicy enum
Values: "FAIL" "WARN"
forceSameIndex boolean
sequence string
io.hyperfoil.core.handlers.QueueProcessor$Builder object
concurrency integer
format enum
Values: "BYTEBUF" "BYTES" "STRING"
maxSize integer
onCompletion io.hyperfoil.api.session.Action$Builder | io.hyperfoil.api.session.Action$Builder[]
sequence string
var string
io.hyperfoil.core.handlers.StoreIntProcessor$Builder object
override boolean
toVar string
io.hyperfoil.core.handlers.StoreProcessor$Builder object
format enum
Values: "BYTEBUF" "BYTES" "STRING"
toVar string
io.hyperfoil.core.handlers.StoreProcessor$LegacyBuilder object
format enum
Values: "BYTEBUF" "BYTES" "STRING"
toVar string
io.hyperfoil.core.handlers.TransferSizeRecorder$Builder object
key string
io.hyperfoil.core.handlers.json.JsonHandler$Builder object
delete boolean
format enum
Values: "BYTEBUF" "BYTES" "STRING"
processor io.hyperfoil.api.processor.Processor$Builder | io.hyperfoil.api.processor.Processor$Builder[]
query string
replace io.hyperfoil.api.processor.Transformer$Builder | io.hyperfoil.api.processor.Transformer$Builder[] | string
toArray string
toVar string
unquote boolean
io.hyperfoil.core.steps.AddToIntAction$Builder object
orElseSetTo integer
value integer
var string
io.hyperfoil.core.steps.AwaitDelayStep$Builder object
key string
io.hyperfoil.core.steps.AwaitVarStep$Builder object
var string
io.hyperfoil.core.steps.BreakIfFinishedStep$Builder object
io.hyperfoil.core.steps.ForeachStep$Builder object
counterVar string
dependency string
fromVar string
sequence string
io.hyperfoil.core.steps.JsonStep$Builder object
delete boolean
format enum
Values: "BYTEBUF" "BYTES" "STRING"
fromVar string
processor io.hyperfoil.api.processor.Processor$Builder | io.hyperfoil.api.processor.Processor$Builder[]
query string
replace io.hyperfoil.api.processor.Transformer$Builder | io.hyperfoil.api.processor.Transformer$Builder[] | string
toArray string
toVar string
unquote boolean
io.hyperfoil.core.steps.LogAction$Builder object
message string
io.hyperfoil.core.steps.LoopStep$Builder object
counterVar string
repeats integer
steps step[]
io.hyperfoil.core.steps.NextSequenceStep$Builder object
name string
io.hyperfoil.core.steps.NoopStep$Builder object
io.hyperfoil.core.steps.RestartSequenceAction$Builder object
io.hyperfoil.core.steps.RestartSequenceStep$Builder object
io.hyperfoil.core.steps.ScheduleDelayStep$Builder object
duration string
fromLast null
fromNow null
key string
max string
min string
random enum
Values: "CONSTANT" "LINEAR" "NEGATIVE_EXPONENTIAL"
type enum
Values: "FROM_LAST" "FROM_NOW"
io.hyperfoil.core.steps.ScheduleDelayStep$ThinkTimeBuilder object
duration string
fromLast null
fromNow null
key string
max string
min string
random enum
Values: "CONSTANT" "LINEAR" "NEGATIVE_EXPONENTIAL"
type enum
Values: "FROM_LAST" "FROM_NOW"
io.hyperfoil.core.steps.SetAction$IntArrayBuilder object
fromVar string
size integer
io.hyperfoil.core.steps.SetAction$ObjectArrayBuilder object
fromVar string
size integer
io.hyperfoil.core.steps.StopStep$Builder object
io.hyperfoil.core.steps.StopwatchBeginStep$Builder object
io.hyperfoil.core.steps.StringToIntAction$Builder object
fromVar string
toVar string
io.hyperfoil.core.steps.TimestampStep$Builder object
localeCountry string
pattern string
toVar string
io.hyperfoil.core.steps.UnsetAction$Builder object
var string
io.hyperfoil.core.steps.collections.AddItemAction$Builder object
fromVar string
toVar string
value string
io.hyperfoil.core.steps.collections.BoolFilter$Builder object
value boolean
io.hyperfoil.core.steps.collections.GetIndexAction$Builder object
collection string
item io.hyperfoil.core.builders.ObjectSourceBuilder | io.hyperfoil.core.builders.ObjectSourceBuilder[]
toVar string
io.hyperfoil.core.steps.collections.GetItemAction$Builder object
fromVar string
index io.hyperfoil.core.builders.IntSourceBuilder | io.hyperfoil.core.builders.IntSourceBuilder[]
toVar string
io.hyperfoil.core.steps.collections.RemoveItemAction$Builder object
fromVar string
index io.hyperfoil.core.builders.IntSourceBuilder | io.hyperfoil.core.builders.IntSourceBuilder[]
io.hyperfoil.core.steps.collections.SetItemAction$Builder object
fromVar string
index io.hyperfoil.core.builders.IntSourceBuilder | io.hyperfoil.core.builders.IntSourceBuilder[]
toVar string
value string
io.hyperfoil.core.steps.collections.StringFilter$Builder object
caseSensitive boolean
endsWith string
equalTo string
length io.hyperfoil.core.builders.StringConditionBuilder$LengthBuilder | io.hyperfoil.core.builders.StringConditionBuilder$LengthBuilder[] | integer
matchVar string
negate boolean
notEqualTo string
startsWith string
value string
io.hyperfoil.core.steps.data.AddToSharedCounterAction$Builder object
fromVar string
key string
operator enum
Values: "ADD" "SUBTRACT"
value integer
io.hyperfoil.core.steps.data.GetSharedCounterAction$Builder object
key string
toVar string
io.hyperfoil.core.steps.data.PublishAgentDataAction$Builder object
fromVar string
name string
io.hyperfoil.core.steps.data.PublishGlobalCountersAction$Builder object
key string
vars object | object[] | string[] | io.hyperfoil.core.steps.data.PublishGlobalCountersAction$Builder$VarsBuilder | io.hyperfoil.core.steps.data.PublishGlobalCountersAction$Builder$VarsBuilder[]
io.hyperfoil.core.steps.data.PublishGlobalCountersAction$Builder$VarsBuilder object
io.hyperfoil.core.steps.data.PullSharedMapStep$Builder object
key string
match string
vars string[] | io.hyperfoil.api.config.ListBuilder | io.hyperfoil.api.config.ListBuilder[]
io.hyperfoil.core.steps.data.PushSharedMapStep$Builder object
key string
vars string[] | io.hyperfoil.api.config.ListBuilder | io.hyperfoil.api.config.ListBuilder[]
io.hyperfoil.core.steps.data.ReadAgentDataAction$Builder object
name string
toVar string
io.hyperfoil.core.steps.data.SetSharedCounterAction$Builder object
fromVar string
key string
value integer
io.hyperfoil.core.util.DoubleIncrementBuilder object
base number
increment number
io.hyperfoil.example.DivideStep$Builder object
divisor integer
fromVar string
toVar string
io.hyperfoil.http.api.StatusHandler$Builder object
action object
counter object
5 nested properties
add integer
expectStatus integer
init integer
set integer
var string
multiplex object
range io.hyperfoil.http.handlers.RangeStatusValidator$Builder | string
stats object
store io.hyperfoil.http.handlers.StoreStatusHandler$Builder | string
io.hyperfoil.http.handlers.ActionStatusHandler$Builder object
io.hyperfoil.http.handlers.CountHeadersHandler$Builder object
io.hyperfoil.http.handlers.LogInvalidHandler$BodyHandlerBuilder object
io.hyperfoil.http.handlers.LogInvalidHandler$HeaderHandlerBuilder object
io.hyperfoil.http.handlers.MultiplexStatusHandler$Builder object
io.hyperfoil.http.handlers.RangeStatusValidator$Builder object
max integer
min integer
io.hyperfoil.http.handlers.RecordHeaderTimeHandler$Builder object
header string
metric string
unit string
io.hyperfoil.http.handlers.StatusToCounterHandler$Builder object
add integer
expectStatus integer
init integer
set integer
var string
io.hyperfoil.http.handlers.StatusToStatsHandler$Builder object
io.hyperfoil.http.handlers.StoreStatusHandler$Builder object
toVar string
io.hyperfoil.http.html.FetchResourceHandler$Builder object
concurrency integer
maxResources integer
metric string[]
onCompletion io.hyperfoil.api.session.Action$Builder | io.hyperfoil.api.session.Action$Builder[]
io.hyperfoil.http.html.TagAttributeHandlerBuilder object
attribute string
format enum
Values: "BYTEBUF" "BYTES" "STRING"
processor io.hyperfoil.api.processor.Processor$Builder | io.hyperfoil.api.processor.Processor$Builder[]
tag string
toArray string
toVar string
io.hyperfoil.http.steps.AwaitAllResponsesStep$Builder object
io.hyperfoil.http.steps.ClearHttpCacheAction$Builder object
io.hyperfoil.http.steps.FormGenerator$Builder object
io.hyperfoil.http.steps.FormGenerator$InputBuilder object
fromVar string
name string
pattern string
value string
io.hyperfoil.http.steps.HttpRequestStepBuilder object
CONNECT io.hyperfoil.core.generators.StringGeneratorImplBuilder | io.hyperfoil.core.generators.StringGeneratorImplBuilder[] | string
DELETE io.hyperfoil.core.generators.StringGeneratorImplBuilder | io.hyperfoil.core.generators.StringGeneratorImplBuilder[] | string
GET io.hyperfoil.core.generators.StringGeneratorImplBuilder | io.hyperfoil.core.generators.StringGeneratorImplBuilder[] | string
HEAD io.hyperfoil.core.generators.StringGeneratorImplBuilder | io.hyperfoil.core.generators.StringGeneratorImplBuilder[] | string
OPTIONS io.hyperfoil.core.generators.StringGeneratorImplBuilder | io.hyperfoil.core.generators.StringGeneratorImplBuilder[] | string
PATCH io.hyperfoil.core.generators.StringGeneratorImplBuilder | io.hyperfoil.core.generators.StringGeneratorImplBuilder[] | string
POST io.hyperfoil.core.generators.StringGeneratorImplBuilder | io.hyperfoil.core.generators.StringGeneratorImplBuilder[] | string
PUT io.hyperfoil.core.generators.StringGeneratorImplBuilder | io.hyperfoil.core.generators.StringGeneratorImplBuilder[] | string
TRACE io.hyperfoil.core.generators.StringGeneratorImplBuilder | io.hyperfoil.core.generators.StringGeneratorImplBuilder[] | string
authority io.hyperfoil.core.generators.StringGeneratorImplBuilder | io.hyperfoil.core.generators.StringGeneratorImplBuilder[] | string
body io.hyperfoil.http.steps.BodyBuilder | io.hyperfoil.http.steps.BodyBuilder[] | string
compensation io.hyperfoil.http.steps.HttpRequestStepBuilder$CompensationBuilder | io.hyperfoil.http.steps.HttpRequestStepBuilder$CompensationBuilder[]
compression io.hyperfoil.http.steps.HttpRequestStepBuilder$CompressionBuilder | io.hyperfoil.http.steps.HttpRequestStepBuilder$CompressionBuilder[] | string
endpoint io.hyperfoil.core.generators.StringGeneratorImplBuilder | io.hyperfoil.core.generators.StringGeneratorImplBuilder[]
handler io.hyperfoil.http.steps.HttpResponseHandlersImpl$Builder | io.hyperfoil.http.steps.HttpResponseHandlersImpl$Builder[]
headers object | object[] | io.hyperfoil.http.steps.HttpRequestStepBuilder$HeadersBuilder | io.hyperfoil.http.steps.HttpRequestStepBuilder$HeadersBuilder[]
method enum
Values: "GET" "HEAD" "POST" "PUT" "DELETE" "OPTIONS" "PATCH" "TRACE" "CONNECT"
metric string[] | string
path io.hyperfoil.core.generators.StringGeneratorImplBuilder | io.hyperfoil.core.generators.StringGeneratorImplBuilder[] | string
sla io.hyperfoil.api.config.SLABuilder | io.hyperfoil.api.config.SLABuilder[] | io.hyperfoil.api.config.SLABuilder$ListBuilder | io.hyperfoil.api.config.SLABuilder$ListBuilder[]
sync boolean
timeout string
io.hyperfoil.http.steps.HttpRequestStepBuilder$CompensationBuilder object
metric string[] | string
targetRate io.hyperfoil.core.util.DoubleIncrementBuilder | io.hyperfoil.core.util.DoubleIncrementBuilder[] | number
io.hyperfoil.http.steps.HttpRequestStepBuilder$CompressionBuilder object
encoding string
type enum
Values: "CONTENT_ENCODING" "TRANSFER_ENCODING"
io.hyperfoil.http.steps.HttpRequestStepBuilder$HeadersBuilder object
io.hyperfoil.http.steps.HttpRequestStepBuilder$PartialHeadersBuilder object
fromVar string
pattern string