Reports
A job can keep a report: a directory with a report.toml at its
top. It can be coverage, test results, performance, or anything with a
page.
out/report/
report.toml
index.html a page (performance and custom kinds)
data/*.csv the data it draws
assets/… scripts and styles, bundled: the page has no network
kind = "performance" # coverage | tests | performance | custom
title = "Frame timing"
summary = "Worst steady frame 498 of 525 scanlines"
[metrics]
worst_frame = { value = 498, unit = "scanlines", better = "lower", fail_above = 525 }
frames_over = { value = 0, unit = "frames", better = "lower", fail_above = 0 }
[context]
budget_scanlines = 525
Declare it in the job's output:
output {
report "performance" {
path "/src/out/report"
when "always"
}
}
- Names: file names hold letters, digits,
.,_,-and+. - Links are left out, never followed.
- Limits: at most 2000 files and 512 MiB.
- Storage: the hub keeps every run's report. Files that didn't change are stored once.
- What you'll see: the Reports tab on OxygenHub, with history, a timeline to scrub, play and compare, and checks from thresholds, is being built (oxygenhub#127).