-
Notifications
You must be signed in to change notification settings - Fork 19
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
doc: Include basic usage file for testing tools
- Loading branch information
Showing
1 changed file
with
42 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
|
||
# QED benchmarking tools | ||
|
||
## Requirements: | ||
* Dialog | ||
* Gnuplot | ||
* Vegeta | ||
* Wrk | ||
|
||
## Latency test | ||
``` | ||
./stress-latency-60s | ||
``` | ||
This will run an latency benchmark with Vegeta for 60s by default and output plot.html. | ||
|
||
## Throughput test | ||
``` | ||
./stress-throughput-60s | ||
``` | ||
This script run an throughtput benchmark using Wrk for 60 by default and outputs the results in your terminal. | ||
|
||
## Endurance test | ||
``` | ||
PROFILING=true ./stress -add -n 1000000 | ||
``` | ||
It will bring up the server and execute and insert 1M events with default concurrency of 10 connections. Also will start a go profiling tool to collect all internal data of QED server an save it in 'results' directory. | ||
The througput will be also displayed every second. | ||
The graph is saved in 'results/graph-Add-$number_events.png (results/graph-Add-1000000.png)'. | ||
|
||
This script use 'riot.go'. It's a tool we've develop to stress QED. It's also capable of generating charts, start with specific offset or even run Membership|Incremental Proofs for the events into QED. | ||
|
||
If you install Dialog and Gnuplot you can generate usage graphs for each function collected by Golang pprof tool. ei: | ||
``` | ||
./make_graph results | ||
``` | ||
|
||
|
||
|
||
|
||
|
||
|
||
|