mqtt

README

xk6-mqtt

This is a k6 extension using the xk6 system.

❗ This is a proof of concept, isn't supported by the k6 team, and may break in the future. USE AT YOUR OWN RISK!

This project is a k6 extension that can be used to load test Mqtt. Per each connection to Mqtt, many messages can be sent. These messages are an array of strings. There is also a consumer for testing purposes, i.e. to make sure you send the correct data to Mqtt. The consumer is not meant to be used for testing Mqtt under load.

k6 version

This extension is tested with k6 version v0.43.1 last release is v0.39.2.

Build & Run

If you want to contribute and improve this extension (you are welcome !) see Build for development section.

If your are only interrested to use this extension and write your own js tests this section is for you. It only requieres docker.

Run the following commands.

# 1. Create path for k6 (here my_k6_path)
mkdir my_k6_path
# 2. Build the k6 binary including the extension in the current path with
docker run --rm -it -u "$(id -u):$(id -g)" -v "${PWD}:/xk6" grafana/xk6 build v0.43.1 --with github.com/amuslija/xk6-mqtt@v0.39.2
# 3. Run a sample mqtt server
docker run --rm --name mosquitto -d -p 1883:1883 eclipse-mosquitto mosquitto -c /mosquitto-no-auth.conf
# 4. Get a test sample test.js file
wget -O test.js https://raw.githubusercontent.com/amuslija/xk6-mqtt/main/examples/test.js
# 5. Run the test for 10s
./k6 run --vus 50 --duration 10s test.js

Your extension is working.

You are ready to customize

• replace the mqtt server you want to test (step 3)
• write the specifics things you want to test in your my_test.js file (step 4)

sample output:

./k6 run --vus 50 --duration 10s test.js

          /\      |‾‾| /‾‾/   /‾‾/
     /\  /  \     |  |/  /   /  /
    /  \/    \    |     (   /   ‾‾\
   /          \   |  |\  \ |  (‾)  |
  / __________ \  |__| \__\ \_____/ .io

  execution: local
     script: test.js
     output: -

  scenarios: (100.00%) 1 scenario, 50 max VUs, 40s max duration (incl. graceful stop):
           * default: 50 looping VUs for 10s (gracefulStop: 30s)


     ✓ is publisher connected
     ✓ is subcriber connected
     ✓ is sent
     ✓ message received
     ✓ is content correct

     █ teardown

     checks.........................: 100.00% ✓ 447007        ✗ 0
     data_received..................: 0 B     0 B/s
     data_sent......................: 0 B     0 B/s
     iteration_duration.............: avg=12.31ms min=514.49µs med=3.36ms max=79.2ms p(90)=44.25ms p(95)=46.17ms
     iterations.....................: 40637   4044.417556/s
     mqtt.received.bytes............: 5253945 522901.478829/s
     mqtt.received.messages.count...: 121911  12133.252667/s
     mqtt.sent.bytes................: 5253945 522901.478829/s
     mqtt.sent.messages.count.......: 121911  12133.252667/s
     vus............................: 50      min=50          max=50
     vus_max........................: 50      min=50          max=50


running (10.0s), 00/50 VUs, 40637 complete and 0 interrupted iterations
default ✓ [======================================] 50 VUs  10s

Build for development

If you need to edit the code of this extension.

You should have the latest version of Go (go1.20) installed. I recommend you to have gvm installed.

To build a k6 binary with this extension, first ensure you have the prerequisites:

• gvm
• Git

Then, install xk6 and build your custom k6 binary with the Mqtt extension:

1. Install xk6:

$ go install go.k6.io/xk6/cmd/xk6@latest

Build the binary: from source code

git clone github.com/amuslija/xk6-mqtt
cd xk6-mqtt
$ xk6 build --with github.com/amuslija/xk6-mqtt=.

Run & Test

First, you need to have your Mqtt development environment setup.

For example you can use vernemq

docker run --rm -p 1883:1883 -e "DOCKER_VERNEMQ_ACCEPT_EULA=yes" -e DOCKER_VERNEMQ_ALLOW_ANONYMOUS=on --name vernemq -d vernemq/vernemq

or Mosquitto

docker run --rm --name mosquitto -d -p 1883:1883 eclipse-mosquitto mosquitto -c /mosquitto-no-auth.conf

optional use tls see: https://openest.io/en/services/mqtts-how-to-use-mqtt-with-tls/

docker run -v $PWD/docker_conf/mosquitto:/conf --rm --name mosquitto -p 8883:8883 eclipse-mosquitto mosquitto -c /conf/mosquitto-tls.conf

k6 Test

To use this extension write you test as a js file :

The sample test file does the following.

Creates per VU (concurrent clients) :

• one topic
• one subscribe connection
• one publish connection

Per iteration :

• Subscribe to topic
• Publish to topic messageCount messages
• Read and check message messageCount results

You can run the test using the following command:

# from previously built version
./k6 run --vus 50 --duration 1m examples/test.js
# from source (you need to be in this repo folder) directly for debug
xk6 run --vus 50 --duration 1m examples/test.js

Sample test result output:

          /\      |‾‾| /‾‾/   /‾‾/
     /\  /  \     |  |/  /   /  /
    /  \/    \    |     (   /   ‾‾\
   /          \   |  |\  \ |  (‾)  |
  / __________ \  |__| \__\ \_____/ .io

  execution: local
     script: examples/test.js
     output: -

  scenarios: (100.00%) 1 scenario, 50 max VUs, 1m30s max duration (incl. graceful stop):
           * default: 50 looping VUs for 1m0s (gracefulStop: 30s)


running (1m00.0s), 00/50 VUs, 236183 complete and 0 interrupted iterations
default ✓ [======================================] 50 VUs  1m0s

     ✓ is publisher connected
     ✓ is subcriber connected
     ✓ is sent
     ✓ message received
     ✓ is content correct

     █ teardown

     checks.........................: 100.00%  ✓ 2598013       ✗ 0
     data_received..................: 0 B      0 B/s
     data_sent......................: 0 B      0 B/s
     iteration_duration.............: avg=12.69ms min=104.96µs med=3.44ms max=92.4ms p(90)=44.18ms p(95)=46.17ms
     iterations.....................: 236183   3933.228118/s
     mqtt.received.bytes............: 31196010 519516.746376/s
     mqtt.received.messages.count...: 708549   11799.684355/s
     mqtt.sent.bytes................: 31196010 519516.746376/s
     mqtt.sent.messages.count.......: 708549   11799.684355/s
     vus............................: 50       min=50          max=50
     vus_max........................: 50       min=50          max=50

optional test influx

docker run --rm --name mosquitto -d -p 1883:1883 eclipse-mosquitto mosquitto -c /mosquitto-no-auth.conf
docker run --rm --name influx -d -p 8086:8086 influxdb:1.8-alpine
K6_OUT=influxdb=localhost:8086 xk6 run --vus 50 --duration 1m examples/test.js

ROADMAP

• Add examples with events for async functions (k6/events)
• Make subscribe function async
• Update the code to allow multiple event listener or at least clean the singleton
• Allow multiple subscribe calls
• Test https://github.com/goiiot/libmqtt as an alternate client (pprof shows bottleneck in paho client)
• Investigate performance there are string copy made in sync publish function that should not be done

Documentation

Overview

Package mqtt xk6 extenstion to suppor mqtt with k6

Index

• Variables
• type MqttAPI
  • func (m *MqttAPI) Exports() modules.Exports
• type RootModule
  • func (*RootModule) NewModuleInstance(vu modules.VU) modules.Instance

Variables

var (
	// ErrConnect mqtt connection error
	ErrConnect = errors.New("connection failed")
	// ErrState unexpected runtime state
	ErrState = errors.New("invalid state")
	// ErrClient given mqtt client is not connected
	ErrClient = errors.New("client is not connected")
	// ErrTimeout operation timeout
	ErrTimeout = errors.New("operation timeout")
	// ErrSubscribe failed to subscribe to mqtt topic
	ErrSubscribe = errors.New("subscribe failure")
	// ErrConsumeToken consume token is invalid
	ErrConsumeToken = errors.New("invalid consume token")
	// ErrPublish publish to mqtt failed
	ErrPublish = errors.New("publish failure")
)

Types

type MqttAPI

type MqttAPI struct {
	// contains filtered or unexported fields
}

MqttAPI is the k6 extension implementing the Mqtt api

func (*MqttAPI) Exports

func (m *MqttAPI) Exports() modules.Exports

Exports exposes the given object in ts

type RootModule

type RootModule struct{}

RootModule is the root module for the mqtt API

func (*RootModule) NewModuleInstance

func (*RootModule) NewModuleInstance(vu modules.VU) modules.Instance

NewModuleInstance implements the modules.Module interface and returns a new instance for each VU.