grafana/k6

k6 Docker镜像文档

镜像概述和主要用途

k6是一款现代负载测试工具，基于性能和测试行业多年经验构建。该Docker镜像提供便捷部署方式，支持通过ES6 JavaScript编写测试脚本，可在本地或云环境执行，具备灵活配置选项，并可通过CLI或REST API进行控制，适用于开发、测试及CI/CD流程中的性能测试。

!https://github.com/grafana/k6/raw/master/assets/k6-demo.gif

可用标签 (Available Tags)

• latest：k6的最新https://github.com/grafana/k6/releases/latest%E3%80%82
• latest-with-browser：带Browser API支持的k6最新发布版本。
• master：k6 https://github.com/grafana/k6/tree/master%E7%9A%84%E5%BD%93%E5%89%8D%E6%9E%84%E5%BB%BA%E7%89%88%E6%9C%AC%E3%80%82
• master-with-browser：k6 https://github.com/grafana/k6/tree/master%E7%9A%84%E5%BD%93%E5%89%8D%E6%9E%84%E5%BB%BA%E7%89%88%E6%9C%AC%EF%BC%8C%E5%B8%A6Browser API支持。
• X.Y.Z：每个https://github.com/grafana/k6/releases%E5%9D%87%E4%BB%A5%60X.Y.Z%60%E6%A0%87%E7%AD%BE%E6%8F%90%E4%BE%9B%EF%BC%8C%E4%BE%8B%E5%A6%82%E4%BD%BF%E7%94%A8%60k6@0.46.0%60%E5%8F%AF%E6%8C%87%E5%AE%9A%60grafana/k6:0.46.0%60%E3%80%82
• X.Y.Z-with-browser：从0.46.0版本开始，包含Chromium浏览器并启用Browser API的版本，因体积和权限要求（见下文“运行浏览器测试注意事项”），以-with-browser为后缀，如grafana/k6:0.46.0-with-browser。

核心功能和特性

• ES6 JS脚本支持：支持模块，便于组织内代码复用。
• 一切皆代码：测试逻辑和配置选项均通过JS实现，便于版本控制。
• 自动化友好：提供检查（类似断言）和阈值，支持灵活的CI配置。
• 多协议支持：支持HTTP/1.1、HTTP/2和WebSocket协议。
• TLS功能：支持客户端证书、可配置SSL/TLS版本和密码套件。
• 内置丰富功能：包括Cookie、加密、自定义指标、编码、环境变量、JSON处理、HTML表单、文件操作及灵活的执行控制等。
• 内置HAR转换器：可将浏览器会话记录为.har文件，并直接转换为k6脚本。
• 灵活的指标存储和可视化：支持Grafana仪表板（InfluxDB、TimescaleDB、Prometheus Remote Write或AWS Timestream）、JSON输出或Grafana Cloud。
• 云执行和分布式测试：支持云执行，分布式测试目前可在Grafana Cloud管理的基础设施上运行，原生分布式执行功能计划在近期推出。

使用场景和适用范围

• API性能测试：验证REST、GraphQL等API在不同负载下的响应时间和稳定性。
• 前端性能测试：通过带浏览器的镜像测试Web页面加载性能和用户交互响应。
• CI/CD集成：在持续集成流程中自动运行性能测试，通过阈值判断构建是否通过。
• 容量规划：模拟高并发用户场景，确定系统最大承载能力。
• 回归测试：确保代码变更不会引入性能退化。

使用方法和配置说明

基本使用

有关使用grafana/k6镜像运行测试的详细示例，请参考k6官方运行指南中的Docker示例。

运行浏览器测试注意事项

使用*-with-browser镜像运行浏览器测试时，由于k6以沙箱模式运行Chrome，需为容器提供额外权限：

方法一：使用Chrome的seccomp配置文件

下载Jessie Frazelle的Chrome seccomp配置文件：

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

启动容器：

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

方法二：添加SYS_ADMIN权限

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