Skip to main content

Supported protocols

vegaload protocols prints this list. vegaload protocols NAME prints one protocol, including its options. vegaload protocols -output json prints the same data as JSON. Example paths are relative to a checkout of this repository. A released binary does not include the examples folder.

  • Scenarios. vegaload new my-scenario scaffolds my-scenario.vl.js (JavaScript by default; -python for a .py scenario shelling out to a local python3).
  • Check a scenario. validate runs the scenario once, with one user and one iteration, and says whether it works.
  • Data files. A scenario can read rows from a file and settings from the environment, so each virtual user can act on different data.
  • Start from a browser recording. Record a real session in your browser (the network tab can save it as a HAR file), then turn it into a scenario:
  • Thresholds. Add -threshold to make a run pass or fail on its own numbers, for example in CI:
  • Compare runs. After another run with -out candidate.json:
  • Explain a run. Keep a run's JSON summary alongside its HTML report with -out:
ProtocolSinceURL schemesExample
http10.1.0http, httpscrud-flow.vl.js
http20.1.0httpscrud-flow.vl.js
grpc0.1.0grpc, grpcs(none yet)
websocket0.1.0ws, wsshttp-ws-chain.vl.js
mqtt0.6.0mqtt, mqttsmqtt-tcp.vl.js
kafka0.6.0kafka, kafkaskafka-orders.vl.js
postgres0.7.0postgres, postgresqlpostgres-orders.vl.js
mysql0.7.0mariadb, mysqlmysql-orders.vl.js
redis0.7.0redis, redissredis-cache.vl.js
rabbitmq0.7.0amqp, amqpsrabbitmq-orders.vl.js
ftp0.7.0ftp, ftpsftp-transfer.vl.js
sftp0.9.0sftpsftp-transfer.vl.js
tcp0.6.0tcp(none yet)
udp0.6.0udp(none yet)