PR suggestions

Bit-Quill · Apr 19, 2024 · dc193aa · dc193aa
1 parent 9187797
commit dc193aa
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/go/DEVELOPER.md b/go/DEVELOPER.md
@@ -207,6 +207,18 @@ Run from the main `/go` folder
 make format
 ```
 
+### Benchmarks
+
+To run the benchmarks, execute the following:
+
+```bash
+cd go/benchmarks
+# To see a list of available options and their defaults:
+go run . -help
+# An example command setting various options:
+go run . -resultsFile gobenchmarks.json -dataSize "100 1000" -concurrentTasks "10 100" -clients all -host localhost -port 6379 -clientCount "1 5" -tls
+```
+
 ### Recommended extensions for VS Code
 
 -   [Go](https://marketplace.visualstudio.com/items?itemName=golang.Go)

diff --git a/go/benchmarks/benchmarking.go b/go/benchmarks/benchmarking.go
@@ -346,6 +346,7 @@ func getLatencyStats(actionLatencies map[string][]time.Duration) map[string]*lat
 		})
 
 		results[action] = &latencyStats{
+			// TODO: Replace with a stats library, eg https://pkg.go.dev/github.com/montanaflynn/stats
 			avgLatency:   average(latencies),
 			p50Latency:   percentile(latencies, 50),
 			p90Latency:   percentile(latencies, 90),