docs

Get started

Welcome
Installation
Running k6
Results output
k6 resources

Using k6

HTTP Requests
Metrics
Checks
Thresholds
Options
Test lifecycle
Modules
Tags and Groups
Cookies
Protocols
Environment variables
Execution context variables
Scenarios

Results output

Overview
End of test
Real time

Test authoring

Test builder
Recording a session

Test Types

Introduction
Smoke testing
Load testing
Stress testing
Soak testing

Testing Guides

API load testing
Automated performance testing
Load testing websites
Running large tests

Misc

Usage collection
IntelliSense
Fine tuning OS
Archive Command
Release notes
Glossary
k6.ioapp.k6.io

No results for “”

Powered byAlgolia

Test builder

suggest edits

Requires free k6 Cloud account

To use the test builder, you need a k6 Cloud. However, it is free to use.

The k6 Test Builder provides a graphical interface to create a k6 test.

Based on your input, the test builder automatically generates the k6 script for you. You can copy this script and run the test from the CLI.

Though we strongly believe that scriptable, code-based tools will help you get the most out of your performance-testing efforts, a GUI-based tool like the test builder could help you:

  • Speed up the test creation.
  • Learn the k6 API quickly.
  • Collaborate with non-coders to build tests.

k6 Test Builder

Getting started

  1. Login into the k6 Cloud.

  2. On the sidebar menu, select the Create New Test button.

  3. Select Test builder.

    k6 Test Builder

  4. Use the graphical interface to build your test.

Load zones

Configure the geographical zones that the load test will run from.

  • To distribute load equally across all zones select Even.
  • To set a percentage of load for each chosen zone, select manual.

Test Builder - Load Zones UI

Check out the list of supported load zones.

Thresholds

Set pass/fail criteria to specify the performance expectations of the system under test. You can set thresholds on any result metrics.

Test Builder - Thresholds UI

Read the thresholds documentation.

Cloud APM

Select where you want to export metrics from a running test in real-time.

Test Builder - Cloud APM UI

Read the Cloud APM.

Scenarios

Scenarios can schedule VUs and iterations to model diverse traffic patterns.

You can create multiple scenarios in a test. For each scenario, configure its options:

  • The scenario executor and its particular configuration.
  • The scenario name.
  • When the scenario begins its execution. The time offset since the start of the test.
  • The scenario graceful stop option.

k6 Test Builder - Edit Scenario

Read the scenarios documentation.

Requests

Configure the requests that each scenario executes. The test builder lets you:

  • Add a request and name it for better description.
  • Change the URL/Endpoint and HTTP method.
  • Specify Headers and Query Parameters.
  • Specify a request body (JSON, Text, or File Content).
  • Reorganize requests by clicking and dragging.
  • Duplicate or delete requests.

k6 Test Builder - Build Requests

Read the HTTP Requests documentation.

View k6 script

At any moment, you can toggle the View button (top-right corner) to Script mode and see the auto-generated k6 script.

Check out the script to get familiar with the k6 API or to copy the script and edit it on your IDE of preference.

k6 Test Builder - Script view

More features

  • Add a check on a request response.
  • Add sleep time between requests.
  • Add a group to the test.
  • Import recorded requests using the browser recorder.
  • Import requests included in a HAR file.
  • Capture a variable when dealing with dynamic data, such as authentication tokens.
  • Show relevant examples.
  • Run the test on the k6 Cloud.
previousTimescaleDB