Skip to content

Document the new machine-readable end-of-test summary #2152

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
heitortsergent merged 3 commits into from
Jan 5, 2026
Merged

Document the new machine-readable end-of-test summary #2152

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
58bceeb
Document the new machine-readable end-of-test summary
joanlopez Jan 5, 2026
30a57fb
Apply suggestions from code review
heitortsergent Jan 5, 2026
ea465dc
Update docs/sources/k6/next/results-output/end-of-test/custom-summary.md
heitortsergent Jan 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions docs/sources/k6/next/results-output/end-of-test/custom-summary.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -303,6 +303,20 @@ Of course, we always welcome [PRs to the jslib](https://github.com/grafana/jslib

## Summary data reference

{{< admonition type="caution" >}}

k6 v1.5.0 introduced a new format available for the end-of-test aggregated statistics object, designed for easier integration
with external systems and analytics pipelines.

You can use the new format via the `--new-machine-readable-summary` flag or the `K6_NEW_MACHINE_READABLE_SUMMARY`
environment variable.

The JSON Schema definition for this object can be found in the [grafana/k6-summary](https://github.com/grafana/k6-summary)
GitHub repository. You can also use these definitions to generate types for the programming language of your preference. For example, [k6 uses it](https://github.com/grafana/k6/blob/master/internal/lib/summary/machinereadable/generate.sh) for Go with [cog](https://github.com/grafana/cog).

This new format will become the default in k6 v2.

{{< /admonition >}}
Summary data includes information about your test run time and all built-in and custom metrics (including checks).

All metrics are in a top-level `metrics` object.
Expand Down
7 changes: 7 additions & 0 deletions docs/sources/k6/next/using-k6/k6-options/reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1165,6 +1165,13 @@ $env:K6_STAGES="5s:10,5m:20,10s:5"; k6 run script.js

## Summary export

{{< admonition type="note" >}}

k6 v1.5.0 introduced a new opt-in format available for summary exports, designed for easier integration with external systems and analytics pipelines. You can learn more details about it in the
[`handleSummary()` function](https://grafana.com/docs/k6/<K6_VERSION>/results-output/end-of-test/custom-summary/#summary-data-reference) page.

{{< /admonition >}}

Save the end-of-test summary report to a JSON file that includes data for all test metrics, checks and thresholds.
This is useful to get the aggregated test results in a machine-readable format, for integration with dashboards, external alerts, CI pipelines, etc.

Expand Down
Loading