Releases: grafana/xk6-dashboard
v0.7.5
xk6-dashboard v0.7.5 is here 🎉! This is an internal maintenance release.
(no bug fixes, no new features)
Breaking changes
Configuration customization from JavaScript code has been removed
Until now, the dashboard configuration could be customized with a JavaScript code. Supporting this feature after switching the JavaScript interpreter (goja to sobek) causes serious difficulties. Since this feature is rarely used, it is easier to drop it than to support it.
v0.7.4
v0.7.3
xk6-dashboard v0.7.3 is here 🎉! This release includes:
- Breaking Changes
- Bug Fixes
- Enablers
Breaking Changes
As of v0.49.0, k6 includes xk6-dashboard as a built-in output extension. The name of the built-in module is the same as was the output name (web-dashboard) registered by the extension. Therefore, if you try to use it as an extension (for example, a newer version), you will get the following error:
$ ./k6 run -o web-dashboard script.js
.
.
.
ERRO[0000] invalid output extension web-dashboard, built-in output with the same type already exists
From now on, the registered name of the extension is again the previously used dashboard. Thus, it is possible (for example, built with xk6) to use a version of the xk6-dashboard that is newer than the one integrated in k6. In this case, the dashboard name must be used as the output name.
$ ./k6 run -o dashboard script.js
Related issue
Bug Fixes
- xk6-dashboard no longer works as an extension
- Report charts remain empty with short test
- Increase tooltip text size
- Selected timeframe resets on next data refresh
Enablers
The following enhancements enable various future dashboard UI feature developments.
SSE Stream Optimization
Previously on the SSE stream, the snapshot and cumulative events are sent as JSON objects, where the metric names are the property names. The property values are also JSON objects, in which the property names are the names of the aggregation function (avg, min, max, etc.). This two-level object hierarchy has not caused any problems so far, the amount of data has been acceptable.
Until now, aggregate counting per tag is still supported, but by default it is only allowed for the group tag. It would be necessary to turn on the aggregate calculation for the url and name tags as well (per URL graphs, summary, etc.). With the previous SSE stream format, this would significantly increase the amount of data. This would have a direct impact on the k6 memory requirement, so it is a problem.
Based on measurements, it can be concluded that using a two-level array structure instead of the two-level object structure used in snapshot and cumulative events significantly reduces the size of the events and thus also the memory requirement.
Therefore, instead of the two-level object structure, a two-level array structure implemented in the snapshot and cumulative events. The packages/model package also updated so it hides SSE stream changes from the rest of the dashboard UI.
Related issues
- Adding a URL table panel to the timings tab
- Dashboards representing individual transactions' metrics rather than TOTALs
Thresholds Evaluation
The display of threshold values on the dashboard UI is greatly simplified if the SSE stream includes threshold expression evaluation results. If the evaluation of a threshold expression belonging to a metric fails, it is included in the new threshold event.
Related issue
Custom Metrics
In the various metrics tables, it is advisable to display the custom metrics before the built-in metrics, because the reader is likely to be more interested. This requires marking individual metrics on the event stream. The true value of the custom property indicates the custom metric.
Test Script Name
It is advisable to display the name of the currently running test script on the dashboard. Therefore, the scriptPath (script name) parameter has been added to the param event.
v0.7.3-alpha.1
Pre-release for v0.7.3 release
xk6-dashboard v0.7.3 is here 🎉! This release includes:
- Breaking Changes
- Bug Fixes
- Enablers
Breaking Changes
As of v0.49.0, k6 includes xk6-dashboard as a built-in output extension. The name of the built-in module is the same as was the output name (web-dashboard) registered by the extension. Therefore, if you try to use it as an extension (for example, a newer version), you will get the following error:
$ ./k6 run -o web-dashboard script.js
.
.
.
ERRO[0000] invalid output extension web-dashboard, built-in output with the same type already exists
From now on, the registered name of the extension is again the previously used dashboard. Thus, it is possible (for example, built with xk6) to use a version of the xk6-dashboard that is newer than the one integrated in k6. In this case, the dashboard name must be used as the output name.
$ ./k6 run -o dashboard script.js
Related issue
Bug Fixes
- xk6-dashboard no longer works as an extension
- Report charts remain empty with short test
- Increase tooltip text size
Enablers
The following enhancements enable various future dashboard UI feature developments.
SSE Stream Optimization
Previously on the SSE stream, the snapshot and cumulative events are sent as JSON objects, where the metric names are the property names. The property values are also JSON objects, in which the property names are the names of the aggregation function (avg, min, max, etc.). This two-level object hierarchy has not caused any problems so far, the amount of data has been acceptable.
Until now, aggregate counting per tag is still supported, but by default it is only allowed for the group tag. It would be necessary to turn on the aggregate calculation for the url and name tags as well (per URL graphs, summary, etc.). With the previous SSE stream format, this would significantly increase the amount of data. This would have a direct impact on the k6 memory requirement, so it is a problem.
Based on measurements, it can be concluded that using a two-level array structure instead of the two-level object structure used in snapshot and cumulative events significantly reduces the size of the events and thus also the memory requirement.
Therefore, instead of the two-level object structure, a two-level array structure implemented in the snapshot and cumulative events. The packages/model package also updated so it hides SSE stream changes from the rest of the dashboard UI.
Related issues
- Adding a URL table panel to the timings tab
- Dashboards representing individual transactions' metrics rather than TOTALs
Thresholds Evaluation
The display of threshold values on the dashboard UI is greatly simplified if the SSE stream includes threshold expression evaluation results. If the evaluation of a threshold expression belonging to a metric fails, it is included in the new threshold event.
Related issue
Custom Metrics
In the various metrics tables, it is advisable to display the custom metrics before the built-in metrics, because the reader is likely to be more interested. This requires marking individual metrics on the event stream. The true value of the custom property indicates the custom metric.
Test Script Name
It is advisable to display the name of the currently running test script on the dashboard. Therefore, the scriptPath (script name) parameter has been added to the param event.
v0.7.2
xk6-dashboard v0.7.2 is here 🎉! This release includes:
- sync'd the dependencies with k6, this fix: grafana/k6#3556
v0.7.1
v0.7.0
xk6-dashboard v0.7.0 is here 🎉! This release includes:
- New design
- New CLI tool
- Preparation for k6 experimental module
New design
The new user interface design fits better with the k6 cloud user interface. The implementation of the UI has also changed, its size has decreased a bit, the code has become more structured and maintainable.
New CLI tool
Subcommands that do not require running k6 have been added to a dedicated CLI tool (k6-web-dashboard). The main reason for this is that soon the xk6-dashboard will be included in k6 as an experimental module and it will no longer be possible to use subcommands. The aggregate, replay and report commands will still be available with the help of the dedicated CLI.
Preparation for k6 experimental module
The xk6-dashboard will soon be integrated into k6 as an experimental module. Therefore, certain changes in the configuration management were necessary. For example, the names of the configuration environment variables were given the K6_WEB_DASHBOARD_ prefix. The name of the output extension also changed from dashboard to web-dashboard.
v0.7.0-alpha.5
Pre-release to prepare for integration into k6.
v0.7.0-alpha.4
Pre-release to prepare for integration into k6.
v0.7.0-alpha.2
Pre-release to prepare for integration into k6.