mirror of
https://github.com/sharkdp/hyperfine.git
synced 2026-10-29 00:28:57 +00:00
docs: document JSON schema v2 breaking changes
This commit is contained in:
1 parent
e262cd6ea5
commit
fc35528fc9
1 file changed
+44
@@ -2,6 +2,50 @@
|
||||
|
||||
## Breaking changes
|
||||
|
||||
- Change `--export-json` to schema version 2, adding metadata, per-run measurements, and per-metric summaries, see #790 (@sharkdp). Consumers must update: for example, `results[i].mean` is now `results[i].summary.time_wall_clock.mean`, and `results[i].times` is replaced by `results[i].measurements[j].time_wall_clock.value`. The separate `exit_codes` and `memory_usage_byte` arrays also move into each measurement as `exit_code` and `memory_peak_resident`. An abbreviated example (using Python comments for explanation):
|
||||
|
||||
```python
|
||||
{
|
||||
"schema_version": 2,
|
||||
"metadata": {
|
||||
"hyperfine_version": "1.21.0",
|
||||
"start_time": "2026-10-06T12:00:00Z",
|
||||
"platform": {"os": "Linux", "architecture": "x86_64"}
|
||||
},
|
||||
"results": [
|
||||
{
|
||||
"command": "sleep 1", # Actual command after parameter substitution
|
||||
"name": "wait 1s", # Optional custom name, separate from the command
|
||||
"parameters": {"duration": {"value": "1"}}, # Values are now objects
|
||||
"measurements": [ # One entry per run, excluding warmups
|
||||
{
|
||||
"time_wall_clock": {"value": 1.0, "unit": "second"},
|
||||
"time_user": {"value": 0.0, "unit": "second"},
|
||||
"time_system": {"value": 0.0, "unit": "second"},
|
||||
"memory_peak_resident": {"value": 1048576.0, "unit": "byte"},
|
||||
"exit_code": 0
|
||||
},
|
||||
... # Further runs omitted
|
||||
],
|
||||
"summary": {
|
||||
"time_wall_clock": {
|
||||
"unit": "second",
|
||||
"count": 2,
|
||||
"mean": 1.0,
|
||||
"stddev": 0.0,
|
||||
"median": 1.0,
|
||||
"min": 1.0,
|
||||
"max": 1.0
|
||||
}
|
||||
# Other metrics have the same summary structure.
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
Times are exported in seconds and memory in bytes, regardless of `--time-unit`. Unavailable memory metrics are omitted; `stddev` is `null` for a single measurement. Reference benchmarks additionally include `"is_reference": true`.
|
||||
|
||||
- Execute commands directly by default (`--shell=none`). Use `-S` (an alias for `--shell=default`) to restore the previous behavior (`sh` on Unix, `cmd.exe` on Windows), or select a shell with `--shell <SHELL>`.
|
||||
- Repurpose `-S` as an alias for `--shell=default`. It no longer accepts a shell argument; replace `-S <SHELL>` with `--shell <SHELL>`.
|
||||
|
||||
|
||||
Reference in new issue
Block a user