grafana/k6 repository overview

k6 is a modern load-testing tool, built on our years of experience⁠ in the performance and testing industries. It provides a clean, approachable scripting API, local⁠ and cloud execution⁠, flexible configuration, with command & control through CLI or a REST API⁠.

This is how load testing should look in the 21st century.

⁠Available Tags

• latest: the latest released⁠ version of k6.
• latest-with-browser: the latest released⁠ version of k6 with Browser API⁠ enabled.
• master: current build of k6 master branch⁠.
• master-with-browser: current build of k6 master branch⁠ with Browser API⁠ enabled.
• X.Y.Z: every released version⁠ of k6 is is available via a X.Y.Z tag, e.g. to use [email protected] use grafana/k6:0.46.0.
• X.Y.Z-with-browser: starting from 0.46.0 every k6 image is accompanied by an image that includes Chromium⁠ browser and has Browser API⁠ enabled. Due to their size and privileges requirement (see "A note on running browser tests" below), they are provided as separate tags with -with-browser suffix. That is, to run your browser-based test with [email protected] use the grafana/k6:0.46.0-with-browser image.

⁠Features

• Scripting in ES6 JS: support for modules⁠ to aid code reusability across an organization
• Everything as code: test logic and configuration options⁠ are both in JS for version control friendliness
• Automation-friendly: checks⁠ (like asserts) and thresholds⁠ for easy and flexible CI configuration!
• HTTP/1.1⁠, HTTP/2⁠ and WebSocket⁠ protocol support
• TLS features: client certificates⁠, configurable SSL/TLS versions and ciphers⁠
• Batteries included: Cookies⁠, Crypto⁠, Custom metrics⁠, Encodings⁠, Environment variables⁠, JSON, HTML forms⁠, files⁠, flexible execution control⁠, and more.
• Built-in HAR converter: record browser sessions as .har files⁠ and directly convert them to k6 scripts⁠
• Flexible metrics storage and visualization: Grafana dashboards⁠ (InfluxDB, TimescaleDB, Prometheus Remote Write or AWS Timestream), JSON⁠ or Grafana Cloud⁠
• Cloud execution⁠ and distributed tests (currently only on infrastructure managed by Grafana Cloud⁠, with native distributed execution in k6 planned⁠ for the near future!)

There's even more! See all features available in k6 docs⁠

⁠Usage

See the Docker examples in the Running k6 guide⁠ to learn how to run tests using the grafana/k6 images.

⁠A note on running browser tests

When running browser tests using the *-with-browser images, you'd need to provide additional capabilities to the container due to k6 running Chrome in a sandbox mode:

• Via Jessie Frazelle's seccomp profile⁠ for Chrome: Download:

  curl -o chrome.json https://raw.githubusercontent.com/jfrazelle/dotfiles/master/etc/docker/seccomp/chrome.json
  

  Copy
  Launch the container using:

  docker run --rm -i --security-opt seccomp=$(pwd)/chrome.json grafana/k6:latest-with-browser - <script.js
  

  Copy
• Provice SYS_ADMIN capability when running a container:

  docker run --rm -i --cap-add=SYS_ADMIN grafana/k6:latest-with-browser - <script.js
  

  Copy