Releases: grafana/xk6-dashboard
v0.7.0-alpha.1
Pre-release to prepare for integration into k6.
v0.6.1
xk6-dashboard v0.6.1 is here 🎉! This release includes:
- #77 Add missing charts to the TIMINGS tab sections
- #78 Rename WebSockets Pong Duration to Ping Duration
- #79 Enable short descriptions of graphs
Add missing charts to the TIMINGS tab sections
HTTP
- Request Failed Rate
- Request Rate
- Request Blocked
Browser
- Request Failed Rate
WebSockets
- Transfer Rate
- Sessions Rate
gRPC
- Transfer Rate
- Streams Rate
Rename WebSockets Pong Duration to Ping Duration
The official name is "ping", so renameed it back to the official name (however the measured value is the response time)
Enable short descriptions of graphs
Added "summary" configuration property (and placeholder value) to panels configuration.
v0.6.0
xk6-dashboard v0.6.0 is here 🎉! This release includes:
- Sections
- Dark mode
- More charts (gRPC, browser, WebSockets)
- Customization format changed, which is a breaking changs.
- Internal refactors
Breaking changes
Customization format changed
The dashboard customization format has changed. The new format is currently undocumented. The main reason for this is that the xk6-dashboard extension has started the process of being integrated into k6 as an experimental module. In this process, all non-essential features (such as updating the customization documentation) are removed from the scope.
The long-term goal is to eliminate the need for customization. Many features have already been created that partially make customization unnecessary (foldable sections, gRPC, browser, WebSockets charts).
New features
Sections
Tabs are now made up of sections. Sections are displayed only if a graph in them contains data, i.e. empty graphs and empty sections are automatically hidden. The contents of the sections can be collapsed and expanded.
Dark mode
Dark mode is finally here! Depending on the browser and desktop settings, the dashboard automatically starts in dark or light mode. You can switch between the two modes at any time using the small icon in the upper right corner of the screen.
More charts
In addition to the graphs containing HTTP metrics displayed so far, graphs containing gRPC, WebSockets and browser metrics have also appeared. Of course, these graphs are only displayed if the appropriate metrics exist in the test. Graphs are displayed in collapsible sections.
Maintenance and internal improvements
This release includes significant internal UI refactors to support further development. The entire event handling and display preparation has been rewritten from JavaScript to TypeScript.
v0.5.5
xk6-dashboard v0.5.5 is here 🎉! This release includes:
- Record and replay events
- Easier reporting later
- Replay format changed, which is a breaking changs.
- Internal refactors
Breaking changes
Replay format changed
The dashboard replay command now plays back event files, which is a breaking change. Previously, the command played back a file saved in the k6 json output format. This had some disadvantages:
- relatively slow playback for large files
- only approximately the same values appeared on the dashboard and in the report as during the test run
- the json output does not contain all the data to fully reconstruct the events
However, the advantage of using the k6 json output is that it can be saved without the dashboard extension and later replay on a k6 that includes the dashboard extension.
In order to maintain this advantage, a `dashboard aggregate`` command was created. Using this, the k6 json output file can be converted into a dashboard event file.
New features
Record and replay events
With the help of the new record parameter, the dashboard events generated during the test run can be saved. The `dashboard replay`` command now plays back event files.
The file size of the event is a fraction of the previously used k6 json output format (--out json). Playback speed has also improved significantly. In addition, during playback, the exact same result can be seen on the dashboard and in the report as during the test run.
Easier reporting later
A report can also be created afterwards with the help of the dashboard replay command, but a dashboard report command has been created for the simpler subsequent report creation. To use the command, you only need to enter the names of the event file and the report file as parameters.
Maintenance and internal improvements
This release contains a refactor that affects many files but is not risky. Primarily, the folder structure has changed and only the necessary API is visible to the outside world. In addition, some internal renamings were made for more consistent naming.
v0.5.4
-
Internal refactors. Extension of SSE with new events (params, config, metric events).
-
Simple metric tag support. It becomes possible to create submetrics based on tags (a submetric is only based on one tag, but separated submetrics can be created based on any number of tags).
-
Preparing to phase out customization. The dashboard configuration will soon be phased out of the xk6-dashboard extension. Instead of the xk6-dashboard, an external extension will manage the custom configuration.
Warning
The format of the custom configuration has changed!
The stability of the configuration format is still not guaranteed, so you should check the changes before updating the version.
In addition, it is possible that the custom configuration will be limited or phased out in the future.
v0.5.3
- In addition to using the command line parameter, the report can also be viewed and downloaded from the dashboard UI using the buttons on the Report tab.
- The k6 process waits to exit as long as there is at least one open browser window for the dashboard extension. In this way, the report can be downloaded, for example, even after the test has been completed.
- The legend floating next to the cursor on the graphs helps to make the current values better visible.
- The coordinate axes and the legend contain the values in a human-readable form and with units of measurement (instead of the previous numerical display)