[perf] Add more docs on perf-tool validation.
Now that 'require' and 'exclude' sections have been
removed from `go.mod` we can finally use
`go install` to install `perf-tool`.
Also update the docs to reflect that `perf-tool` now
defaults to verbose output.
Change-Id: Ica0ba0a554bfe1d98011e536a38374b48c3dc26e
Reviewed-on: https://skia-review.googlesource.com/c/buildbot/+/540079
Reviewed-by: Leandro Lovisolo <lovisolo@google.com>
diff --git a/perf/FORMAT.md b/perf/FORMAT.md
index 4051432..16373e8 100644
--- a/perf/FORMAT.md
+++ b/perf/FORMAT.md
@@ -67,12 +67,32 @@
You can validate your files conform to the expected schema by installing
`perf-tool`:
- go get go.skia.org/infra/perf/go/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:
+
+ $ perf-tool ingest validate --in=$HOME/valid.json
+ hash: def820637c3674a2bcecd6992a207fa3b9bed737
+ ,arch=arm64,radius=10,test=drawCircle,units=ms, = 1.4800247
+ ,arch=arm64,radius=50,test=drawCircle,units=ms, = 261.58847
+ ,arch=arm64,radius=90,test=drawCircle,units=ms, = 377.3585
+
+You can run `perf-tool` over
+[`./go/ingest/parser/testdata/version_1/success.json`](//perf/go/ingest/parser/testdata/version_1/success.json)
+to see how it converts all the keys and values in that file into trace identifiers.
+
# Notes
- Perf only uses the data in the file, and does not parse the GCS file location
