feat: Integrating the web dashboard feature

[szkiba]

As per our product DNA, we aim, by integrating the web dashboard (xk6-dashboard) directly into k6, to enhance and streamline the user experience, making real-time and end-of-test visualizations immediately accessible as part of the k6 command-line experience.

This is not yet the final version of the integration. The goal is to integrate xk6-dashboard v0.7.0, but that release does not exist yet (waiting for dependencies).

I created the PR to ask for a review and to get feedback on whether the integration would be good this way, or if the team had something else in mind.

[CLAassistant]

All committers have signed the CLA.

[codebien]

Hey @szkiba,
thanks for your contribution. Congrats for the progress with the dashboard 👏

I've left some comments.

[szkiba]

Hey @szkiba, thanks for your contribution. Congrats for the progress with the dashboard 👏

I've left some comments.

Hi @codebien , thanks for the feedback!

[codecov-commenter]

Codecov Report

Attention: 1 lines in your changes are missing coverage. Please review.

Comparison is base (d00e4f6) 72.96% compared to head (da52b66) 72.96%.
Report is 12 commits behind head on master.

❗ Current head da52b66 differs from pull request most recent head 7f43e50. Consider uploading reports for the commit 7f43e50 to get more accurate results

Files	Patch %	Lines
cmd/ui.go	91.66%	1 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #3505   +/-   ##
=======================================
  Coverage   72.96%   72.96%           
=======================================
  Files         280      280           
  Lines       20938    20949   +11     
=======================================
+ Hits        15277    15286    +9     
- Misses       4691     4693    +2     
  Partials      970      970           

Flag	Coverage Δ
macos	72.89% <95.45%> (?)
ubuntu	72.91% <95.45%> (-0.01%)	⬇️
windows	72.81% <95.45%> (-0.01%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[oleiade]

LGTM 🚀

Will wait until the rest of the environment variables are implemented, and we resolve some of the discussions we're having internally to approve. But looks good to me, great job @szkiba 👏🏻

[szkiba]

LGTM 🚀

Will wait until the rest of the environment variables are implemented, and we resolve some of the discussions we're having internally to approve. But looks good to me, great job @szkiba 👏🏻

Thank you @oleiade

What environment variables are you referring to?
Here is the list of environment variables managed by xk6-dashboard:

• K6_WEB_DASHBOARD_HOST
• K6_WEB_DASHBOARD_PORT
• K6_WEB_DASHBOARD_PERIOD
• K6_WEB_DASHBOARD_OPEN
• K6_WEB_DASHBOARD_EXPORT
• K6_WEB_DASHBOARD_RECORD
• K6_WEB_DASHBOARD_TAG

see: https://github.com/grafana/xk6-dashboard#environment

In addition, the K6_WEB_DASHBOARD variable can be set to true to activate the dashboard in k6.
Correct me if I'm wrong, but I think all environment variables in the design document are implemented....

see: https://github.com/grafana/k6/blob/feat/3504-dashboard-integration/cmd/config.go#L45

[oleiade]

This is my bad @szkiba, I came in with the wrong assumption. You're right, they should likely remain defined in the extension itself 👍🏻

[codebien]

The current code looks good to me.

But, unfortunately, there is something in the UX that sounds unexpected.
If I send an interrupt (CTRL+c) while k6 is running and the dashboard is opened in the browser then k6 gets stuck.

@szkiba is it expected?

I tested running the following command:

K6_WEB_DASHBOARD=true go run . run -d 1m ./examples/http_get.js

[szkiba]

The current code looks good to me.

But, unfortunately, there is something in the UX that sounds unexpected. If I send an interrupt (CTRL+c) while k6 is running and the dashboard is opened in the browser then k6 gets stuck.

@szkiba is it expected?

I tested running the following command:

K6_WEB_DASHBOARD=true go run . run -d 1m ./examples/http_get.js

@codebien Actually, this is a feature (as long as the browser is open, k6 does not stop after the test run), but it really does not handle the abort situation well. I will fix it and make a patch release soon.

update: done, v0.7.1 handle the test abort situation. xk6-dashboard dependency upgraded to v0.7.1
FYI @codebien @oleiade

[codebien]

The interrupt logic it's now fixed for me.

[oleiade]

🚀