[BEAM-5302] Improve performance test documentation

• Type: Improvement
• Status: Open
• Priority: P3
• Resolution: Unresolved
• Component/s: testing
• Labels: beam-fixit
• Assignee: Unassigned
• Reporter: Mark Liu
• Created: 04/Sep/18 21:03
• Updated: 03/Jun/22 21:55

Description

Current documentation for performance testing and benchmarks missing following areas:

How to write / use benchmark on Perfkit
How to run benchmark locally or on Jenkins
Benchmark summary / definition
How to use performance metrics data and where to find

Those documents can help new contributors to start and people who interested in performance result to understand framework and look up results.