Installation

xk6-disruptor is a k6 extension. You have to run a k6 version built with the disruptor extension to use the disruptor APIs in your k6 tests.

The following sections explain the different options to get this custom binary.

Download a release binary

The quickest way to get started is to download a release binary from GitHub.

Build from source

You can also use xk6 to build a k6 binary.

To learn more about xk6, refer to Build a k6 binary using Go.

To build the k6 binary with the xk6-disruptor extension:

Ensure you have Go 1.19 and Git installed.
Run the following commands in a terminal:

# Install xk6
go install go.k6.io/xk6/cmd/xk6@latest

# Clone the xk6-disruptor code
git clone https://github.com/grafana/xk6-disruptor.git
cd xk6-disruptor

# Build the custom binary
xk6 build --output xk6-disruptor --with github.com/grafana/xk6-disruptor=.

xk6 will create the xk6-disruptor binary in the current working directory.