POC dashboard in Grafana

[oleiade]

Hi folks 👋🏻

Per our recent discussion, I'm presenting a draft PR (intended for review, not for merging) that replicates the xk6-dashboard experience using Grafana.

I've added a /grafana directory at the project root. This directory houses a docker-compose file and the necessary Grafana and Prometheus configurations to simplify setup.

How-to

# Start the Prometheus and Grafana stack
cd grafana && docker-compose up --build -d && cd -

# Execute a k6 test and push results to Prometheus
K6_PROMETHEUS_RW_SERVER_URL=http://localhost:9090/api/v1/write K6_PROMETHEUS_RW_TREND_STATS="p(90),p(95),avg" k6 run script-hour.js -o experimental-prometheus-rw

Upon starting the docker-compose stack and initiating the k6 command, navigate to http://localhost:3000. You'll find a pre-configured xk6-dashboard Grafana dashboard:

Caveats & Assistance Requested

While I've managed to closely replicate the xk6-dashboard experience, I faced certain challenges. If you possess insights or potential solutions, please consider contributing directly to this branch. Here are the main challenges:

The k6 dashboard conveniently sets its range based on the test start time. However, in Grafana, you'll need to set this manually. Record the test's start time and adjust the From time range accordingly, e.g., 2023-09-06 15:19:30. Set the To field to now.
Set a refresh rate of 10s to align with the xk6 dashboard.
I've struggled to reproduce the table found in the xk6 dashboard's summary screen. Grafana's tables are, frankly, quite perplexing. Any guidance or direct adjustments would be greatly appreciated.
This branch utilizes k6's Prometheus-remote-write feature. The provided command is configured to emit Trend metrics as specific Prometheus summaries (k6_avg, k6p90, and k6*_p95). This is handy for some graphs but complicates the accurate representation of others, particularly the HTTP request rate.

[szkiba]

Thank you @oleiade ! I'll play with it soon

[szkiba]

Hi @oleiade , I think this PR is outdated. Can I close it?

[oleiade]

👍🏻