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.

• 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.

• 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)

Fix #28 sparse stats graphed incorrectly

Transfer repo to Grafana GitHub org

Export single file HTML report

Change k6 dependenty to v0.45.1

Main new features:

• replay results: the extension adds a dashboard replay subcommand to the k6 command line, which can be used to play back test run results previously saved in JSON format for the dashboard.

$ ./k6 dashboard replay --help

The replay command load the saved JSON results and replay it for the dashboard UI.
The compressed file will be automatically decompressed if the file extension is .gz

Usage:
  k6 dashboard replay file [flags]

Flags:
      --config string   UI configuration file location (default: '.dashboard.js')
      --host string     Hostname or IP address for HTTP endpoint (default: '', empty, listen on all interfaces)
      --open            Open browser window automatically
      --period 10s      Event emitting frequency (default: 10s), example: `1m` (default 10s)
      --port int        TCP port for HTTP endpoint (default: 5665), example: 8080 (default 5665)
  -h, --help            help for replay

Main new features:

• reporting: The Report tab contains a test operation report in a printable (or PDF) format.
• summary: The Summary page contains a summary of the metrics of the test run. The tables contain the aggregate values of the metrics for the entire test run.

Automatic playback of the previous events of the already running test. If the SSE connection is interrupted, the playback starts from the last delivered event (lastEvenId support).