GoogleCloudPlatform / GoogleCloudPlatform/PerfKitBenchmarker
We should add a standard comment block to each Benchmark to detail exactly how it publishes data.
- Dominant language
- Python
- Stars
- 2k
- Forks
- 562
- Avg merge
- 4h 55m
- Merged PRs (30d)
- 69
Description
Today we have a schema does that is not broadly shared, and reading the code to figure of the metrics published is slow.
We should create a comment block in each benchmark file detailing how it publishes. In particular we should detail:
test - this is the name of the bechmark
owner - who is running the numbers
labels - This data is a '|' separate list of extra meta data to understand the data point. There are some common labels like 'zone' and 'machine_type'. We should detail all of them for the given benchmark.
metric - What is being reported
units - Units of the metric. There is a pretty standard list here we should not expand unless really needed.
value - the number being reported.
Contributor guide
Assessment
This issue has not been assessed yet.