uzokis/docker-k6-influxdb-grafana

Sample of using k6 to load test api with docker swarm spinning up influxdb and grafana

Sample project showing how to use k6 to load test a simple api with influxdb as a time series data target and grafana for visualizations.

Dependancies:

• docker-compose -> sudo apt-get install docker-compose
• go - https://golang.org/dl/
• k6 - https://github.com/loadimpact/k6 if you have go 10+ installation is pretty simple go get github.com/loadimpact/k6

based on https://github.com/nicolargo/docker-influxdb-grafana

GO minimal API

It uses simple api in GO which binds to :8000 port and exposes /hello endpoint.

Influxdb and Grafana

Influxdb uses default configuration apart from max-body-size which was increased to accept HTTP requests sent from K6 engine running load_test.js script.

Grafana uses provisioning to spin up an instance with automatically configured data source of InfluxDB and default dashboard for K6 - https://grafana.com/dashboards/2587.

Makefile and how to run the sample

To run the sample use make demo. This automatically creates:

• ephemeral start file to keep file target for Make indicating that start step in the future is not neccessary unless there was a change in the file, to simplify subsequent k6 runs of load_test
• folders to hold data for Grafana and InfluxDB
• docker swarm with InfluxDB and Grafana instance
• load_tests database on InfluxDB
• compiles minimal go app
• starts minimal go app in paraller process keeping the PID in file for later kill
• starts k6 to generate load test data and sends it to InfluxDB

After make run you need to open browser and go to localhost:3000 log in as admin:admin and open the dashboard.

Running custom k6 file

To run custom file with grafana available on port :3000 use make run file=<your_file_path>

Cleanup

To cleanup run make clean - this command:

• removes data folder with grafana and influxdb data
• stops docker swarm and removes containers
• cleans up ephemeral start file

Enjoy :)