This project aims to provide k6 with the ability to produce an HTML report at the end of the test run, offering a visual overview of the performance insights observed during the test run.
This project starts as a feature of the xk6-dashboard project but is meant to become a core feature of k6 eventually.
### Next steps
- [x] Moving the project into the Grafana organization
- [x] [#37](https://github.com/szkiba/xk6-dashboard/issues/37)
- [ ] Put together a Proof of Concept of the HTML Report generation feature
- [ ] Implement and Stabilize the feature into the dashboard project
- [ ] Sync with internal teams to align the look & feel as well as tech stack with k6
Design
In its first proof of concept iteration, the project works as follows:
During the k6 test run, the extension collects the metrics data periodically.
As data is collected, they are accumulated in a JSON data file.
The HTML report is a single HTML file that interactively loads and transforms this data to fill the charts.
Eventually, we expect the final version to generate an output HTML file with the data already embedded in it instead of fetching it from a file.
Implementation considerations
The report will consist of a single file holding the compressed data and graphs displaying those data.
The sample size will be 10s, which will lead to a bigger data set. Later we could increase it to reduce the size. The optimization might not be worth it, considering the alternative PDF export would be much bigger anyway.
Starting size of the report is expected to be ~80Kb + data for the report itself. We expect
Question & TODOS
[ ] @oleiade What's the average test run duration?
[ ] @oleiade What's the maximum test run duration?
szkiba
commented
12 months ago
This project aims to provide k6 with the ability to produce an HTML report at the end of the test run, offering a visual overview of the performance insights observed during the test run.
This project starts as a feature of the xk6-dashboard project but is meant to become a core feature of k6 eventually.
Design
In its first proof of concept iteration, the project works as follows:
Eventually, we expect the final version to generate an output HTML file with the data already embedded in it instead of fetching it from a file.
Implementation considerations
The report will consist of a single file holding the compressed data and graphs displaying those data.
The sample size will be 10s, which will lead to a bigger data set. Later we could increase it to reduce the size. The optimization might not be worth it, considering the alternative PDF export would be much bigger anyway.
Starting size of the report is expected to be ~80Kb + data for the report itself. We expect
Question & TODOS