This document describes the JSON schema that Fuchsia benchmark results must follow in order to be uploaded to the performance dashboard.
If you're creating a trace-based benchmark, your exported results will already have the correct schema.
If you're writing your own benchmark program, then you can use the existing Fuchsia libraries for your language for emitting the JSON data:
Note: If your benchmark is in a different language, please provide a reusable library or file a bug against IN to request one.
[ { "label": string // Name of the test case in the performance dashboard. "test_suite": string // Name of the test suite in the performance dashboard. "unit": string // One of the supported units (see below) "values": [v1, v2..] // Numeric values collected in this test case "split_first": bool // Whether to split the first element in |values| from the rest. }, { ... } ]
In order to convert benchmark results to the format required by the performance dashboard, unit
must be one of the following strings, which describe the units of the result's values
.
nanoseconds
or ns
milliseconds
or ms
bytes/second
bytes
[ { "label": "Channel/WriteRead/64bytes", "test_suite": "fuchsia.microbenchmarks", "unit": "nanoseconds", "values": [105.45, 697.916667, 672.743056], "split_first": true }, { "label":"Channel/WriteRead/1024bytes", "test_suite":"fuchsia.microbenchmarks", "unit":"nanoseconds", "values":[102.23, 1004.340278, 906.250000], "split_first": true } ]
split_first is useful when the first value in the test results is usually skewed due to external influence on the test (e.g. empty caches). When true, benchmark results will appear as two separate series in the performance dashboard:
$label/samples_0_to_0
which tracks the first element in values
, and$label/samples_1_to_N
which tracks the remaining values
.