菜单
开源 RSS

Web 控制台

k6 提供了一个内置的 Web 控制台,您可以启用它来实时可视化和监控您的测试结果。

Web dashboard screenshot

该控制台提供 k6 在测试运行时观察到的性能的实时概览,可以帮助您在问题发生时识别潜在的可靠性问题。

使用方法

Web 控制台是 k6 的内置功能。您可以通过在运行测试脚本时将 K6_WEB_DASHBOARD 环境变量设置为 true 来启用它,例如

shell
K6_WEB_DASHBOARD=true k6 run script.js
shell
K6_WEB_DASHBOARD=true ./k6 run script.js

         /\      Grafana   /‾‾/
    /\  /  \     |\  __   /  /
   /  \/    \    | |/ /  /   ‾‾\
  /          \   |   (  |  (‾)  |
 / __________ \  |_|\_\  \_____/

     execution: local
        script: ../extensions/xk6-dashboard/script.js
 web dashboard: http://127.0.0.1:5665
        output: -

默认情况下,Web 控制台在 localhost 的端口 5665 上可用。您可以使用控制台选项更改主机和端口。

注意

只要至少有一个打开的控制台扩展浏览器窗口,k6 进程就会等待退出。

在某些环境中,例如 CI/CD 流水线,k6 进程必须在测试运行完成后退出。在这种情况下,建议将 HTTP 端口设置为 -1 来禁用它。

生成 HTML 测试报告

您可以直接从 Web 控制台或命令行生成详细、可下载的 HTML 报告。这些报告是自包含的,非常适合与您的团队共享。

HTML test report screenshot

从 Web 控制台生成报告

要从 Web 控制台生成报告,请点击控制台菜单上的 报告

HTML test report generation button

从命令行生成报告

要在测试运行结束后自动从命令行生成报告,请使用 K6_WEB_DASHBOARD_EXPORT 选项。例如

shell
K6_WEB_DASHBOARD=true K6_WEB_DASHBOARD_EXPORT=html-report.html k6 run script.js

注意

仅当测试持续时间大于 K6_WEB_DASHBOARD_PERIOD 变量设置的聚合周期值的三倍时,报告才会包含图表。

控制台选项

Web 控制台可以通过环境变量进行配置

环境变量描述默认值
K6_WEB_DASHBOARD启用 Web 控制台false
K6_WEB_DASHBOARD_HOSTWeb 控制台绑定的主机localhost
K6_WEB_DASHBOARD_PORTWeb 控制台绑定的端口5665
K6_WEB_DASHBOARD_PERIOD更新 Web 控制台的周期(秒)10s
K6_WEB_DASHBOARD_OPEN在默认浏览器中打开 Web 控制台false
K6_WEB_DASHBOARD_EXPORT测试运行结束时自动导出 HTML 测试报告的文件名。默认情况下,该值为空,报告不会被导出。``