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

• xk6-dashboard no longer works as an extension

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

• Displaying thresholds

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.

xk6-dashboard v0.7.2 is here 🎉! This release includes:

• sync'd the dependencies with k6, this fix: grafana/k6#3556

xk6-dashboard v0.7.1 is here 🎉! This release includes:

• fix: #142 k6 does not stop in case of an abortion

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.

Pre-release to prepare for integration into k6.

Pre-release to prepare for integration into k6.

Pre-release to prepare for integration into k6.

Pre-release to prepare for integration into k6.

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.

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.