The Skia Perf format is a JSON file that contains measurements. For example:
{
"version": 1,
"git_hash": "cd5...663",
"key": {
"config": "8888",
"arch": "x86"
},
"results": [
{
"key": {
"test": "a_test_with_just_a_single_measurement",
"units": "s"
},
"measurement": 123.4
},
{
"key": {
"test": "draw_a_circle",
"units": "ms"
},
"measurements": {
"stat": [
{
"value": "min",
"measurement": 1.2
},
{
"value": "max",
"measurement": 2.4
},
{
"value": "median",
"measurement": 1.5
}
]
}
},
{
"key": {
"test": "draw_my_animation",
"units": "Hz"
},
"measurements": {
"stat": [
{
"value": "min",
"measurement": 20
},
{
"value": "max",
"measurement": 30
},
{
"value": "median",
"measurement": 22
}
]
}
}
],
"links": {
"details": "https://example.com/a-link-to-details-about-this-test-run"
}
}
When ingested it will produce the following information:
Hash: cd5...663 Measurements: ,arch=x86,config=8888,test=a_test_with_just_a_single_measurement,units=s, = 123.4 ,arch=x86,config=8888,stat=min,test=draw_a_circle,units=ms, = 1.2 ,arch=x86,config=8888,stat=max,test=draw_a_circle,units=ms, = 2.4 ,arch=x86,config=8888,stat=median,test=draw_a_circle,units=ms, = 1.5 ,arch=x86,config=8888,stat=min,test=draw_my_animation,units=Hz, = 20 ,arch=x86,config=8888,stat=max,test=draw_my_animation,units=Hz, = 30 ,arch=x86,config=8888,stat=median,test=draw_my_animation,units=Hz, = 22 Links: details: https://example.com/a-link-to-details-about-this-test-run
You can run the perf-tool as described below to parse a file and emit a description like the one above.
The format is documented here.
Each Perf data file should be stored in Google Cloud Storage in a location of the following format:
gs://<bucket>/<one or more dir names>/YYYY/MM/DD/HH/<zero or more dir names><some unique name>.json
Where:
YYYY - Year MM - Month, e.g. 02 for February. DD - Day, e.g. 01, 02, etc. HH - Hour in 24 hour format, e.g. 00, 01, 02, ..., 22, 23
in UTC.
gs://skia-perf/nano-json-v1/2018/08/23/22/Android-Clang/7989dad6c3b2efc10defb8f280f7a8a1a731d5d0.json
The Perf ingester will attempt to ingest all files below /HH/ that end in .json. Nothing about the file location or the file name is ingested as data.
You can validate your files conform to the expected schema by installing perf-tool:
go install go.skia.org/infra/perf/go/perf-tool@latest
And then use it to validate an ingestion file:
perf-tool ingest validate --in=my-ingestion-file.json
If the format is invalid the tool will print out validation errors, for example
$ perf-tool ingest validate --in=$HOME/invalid.json 0 - 0: (root): results is required Error: Validation Failed: schema violation
If the format is valid then all the found trace ids and their values will be printed out, for example:
Hash: cd5...663 Measurements: ,arch=x86,config=8888,test=a_test_with_just_a_single_measurement,units=s, = 123.4 ,arch=x86,config=8888,stat=min,test=draw_a_circle,units=ms, = 1.2 ,arch=x86,config=8888,stat=max,test=draw_a_circle,units=ms, = 2.4 ,arch=x86,config=8888,stat=median,test=draw_a_circle,units=ms, = 1.5 ,arch=x86,config=8888,stat=min,test=draw_my_animation,units=Hz, = 20 ,arch=x86,config=8888,stat=max,test=draw_my_animation,units=Hz, = 30 ,arch=x86,config=8888,stat=median,test=draw_my_animation,units=Hz, = 22 Links: details: https://example.com/a-link-to-details-about-this-test-run
You can run perf-tool over ./go/ingest/parser/testdata/version_1/success.json to see how it converts all the keys and values in that file into trace identifiers.