grafana / k6

A modern load testing tool, using Go and JavaScript - https://k6.io
GNU Affero General Public License v3.0
26.1k stars 1.27k forks source link

k6 v1: implement new end-of-test summary proposal #4052

Open oleiade opened 1 week ago

oleiade commented 1 week ago

Summary

We are revamping the end-of-test summary to enhance usability and ensure users receive relevant, structured results more easily.

This update aims to provide clearer insights by rationalising the metrics displayed, improving visual clarity, and adding commonly requested features. By focusing on structure and prioritisation, we aim to make interpreting k6’s end-of-test summary more intuitive and meaningful for users of all levels.

While we’re striving to make these changes as seamless as possible, we acknowledge that automations relying on the current summary format may need adjustment.

Objectives & Key Changes

1. Compact and Extended View Options • Default (Compact) Mode: A streamlined view to support quick interpretation of essential metrics. • Extended Mode: An in-depth view providing additional detail, accessible on demand. 2. Rationalise Metric Results Displayed (compact + extended) • Selective Metrics Display: Reduce default metrics to include only those relevant to the majority of users, minimizing noise and improving focus. • Prioritised Ordering: Arrange metrics to highlight data defined by users or generated by specific user-scripted code. 3. Enhance Visual Structure (compact + extended) • Dedicated Visual Blocks: Segment results by feature/protocol (e.g., HTTP block, Browser block, Execution block) to aid quick interpretation. • Explicit Check Handling: Refine check display to provide clearer, more explicit outputs, addressing previous feedback about implicit or unclear check results. 4. Support for Groups and Scenarios (extended only) • Nested Subsections: Introduce nested subsections for groups and scenarios, addressing one of the most common user requests. • Indentation for Clarity: Nested groups will display with clear indentation to visually distinguish hierarchy and grouping.

Impact on Users

While this update will bring significant benefits, automations and workflows that depend on the current summary format may require updates. We recognize this change may break some existing setups but believe the improvements will provide greater long-term usability.

Scripts that override the handleSummary function are expected to remain functional and will see no change to their existing behaviour.

Overview

For illustration purposes only: might differ from the end result

Image