Repository navigation
Expand file tree
/
Copy pathbenchmark.go
More file actions
370 lines (312 loc) · 11.6 KB
/
Copy pathbenchmark.go
File metadata and controls
370 lines (312 loc) · 11.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
// Copyright (c) 2016 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
package main
import (
"encoding/json"
"errors"
"fmt"
"math"
"os"
"os/signal"
"runtime"
"strings"
"sync"
"time"
"github.com/yarpc/yab/encoding"
"github.com/yarpc/yab/limiter"
"github.com/yarpc/yab/sorted"
"github.com/yarpc/yab/statsd"
"github.com/yarpc/yab/transport"
"go.uber.org/zap"
)
var (
errNegativeDuration = errors.New("duration cannot be negative")
errNegativeMaxReqs = errors.New("max requests cannot be negative")
// using a global _quantiles slice mainly for ease of testing, and not passing
// the same array around to multiple functions
_quantiles = []float64{0.5000, 0.9000, 0.9500, 0.9900, 0.9990, 0.9995, 1.0000}
)
// Parameters holds values of all benchmark parameters
type Parameters struct {
CPUs int `json:"cpus"`
Connections int `json:"connections"`
Concurrency int `json:"concurrency"`
MaxRequests int `json:"maxRequests"`
MaxDuration string `json:"maxDuration"`
MaxRPS int `json:"maxRPS"`
}
// Summary stores the benchmarking summary
type Summary struct {
ElapsedTimeSeconds float64 `json:"elapsedTimeSeconds"`
TotalRequests int `json:"totalRequests"`
RPS float64 `json:"rps"`
}
// ErrorSummary stores the summary of the errors encountered
type ErrorSummary struct {
TotalErrors int `json:"totalErrors"`
ErrorRate float64 `json:"errorRate"`
ErrorsCount map[string]int `json:"errorsCount"`
}
// StreamSummary stores summary of stream messages sent and received
type StreamSummary struct {
TotalStreamMessagesSent int `json:"totalStreamMessagesSent"`
TotalStreamMessagesReceived int `json:"totalStreamMessagesReceived"`
}
// BenchmarkOutput stores benchmark settings and results for JSON output
type BenchmarkOutput struct {
Parameters Parameters `json:"benchmarkParameters"`
Latencies map[string]string `json:"latencies"`
Summary Summary `json:"summary"`
// ErrorSummary sums up the errors encountered (if any). Is nil if no errors have been encountered
ErrorSummary *ErrorSummary `json:"errorSummary,omitempty"`
// StreamSummary is available only for streaming benchmark. It is nil and
// omitted in unary benchmark.
StreamSummary *StreamSummary `json:"streamSummary,omitempty"`
}
// setGoMaxProcs sets runtime.GOMAXPROCS if the option is set
// and returns the number of GOMAXPROCS configured.
func (o BenchmarkOptions) setGoMaxProcs() int {
if o.NumCPUs > 0 {
runtime.GOMAXPROCS(o.NumCPUs)
}
return runtime.GOMAXPROCS(-1)
}
func (o BenchmarkOptions) getNumConnections(goMaxProcs int) int {
if o.Connections > 0 {
return o.Connections
}
// If the user doesn't specify a number of connections, choose a sane default.
return goMaxProcs * 2
}
func (o BenchmarkOptions) validate() error {
if o.MaxDuration < 0 {
return errNegativeDuration
}
if o.MaxRequests < 0 {
return errNegativeMaxReqs
}
return nil
}
func (o BenchmarkOptions) enabled() bool {
// By default, benchmarks are disabled. At least MaxDuration or MaxRequests
// should not be 0 for the benchmark to start.
// We guard for negative values in the options validate() method, called
// after entering the benchmark case.
return o.MaxDuration != 0 || o.MaxRequests != 0
}
func runWorker(t transport.Transport, b benchmarkCaller, s *benchmarkState, run *limiter.Run, logger *zap.Logger) {
for cur := run; cur.More(); {
callReport, err := b.Call(t)
if err != nil {
s.recordError(err)
// TODO: Add information about which peer specifically failed.
logger.Info("Failed while making call.", zap.Error(err))
continue
}
s.recordLatency(callReport.Latency())
if streamCallReport, ok := callReport.(benchmarkStreamCallReporter); ok {
s.recordStreamMessages(streamCallReport.StreamMessagesSent(), streamCallReport.StreamMessagesReceived())
}
}
}
func runBenchmark(out output, logger *zap.Logger, allOpts Options, resolved resolvedProtocolEncoding, methodName string, b benchmarkCaller) {
opts := allOpts.BOpts
if err := opts.validate(); err != nil {
out.Fatalf("Invalid benchmarking options: %v", err)
}
if !opts.enabled() {
return
}
if opts.RPS > 0 && opts.MaxDuration > 0 {
// The RPS * duration in seconds may cap opts.MaxRequests.
rpsMax := int(float64(opts.RPS) * opts.MaxDuration.Seconds())
if rpsMax < opts.MaxRequests || opts.MaxRequests == 0 {
opts.MaxRequests = rpsMax
}
}
goMaxProcs := opts.setGoMaxProcs()
numConns := opts.getNumConnections(goMaxProcs)
parameters := Parameters{
CPUs: goMaxProcs,
Connections: numConns,
Concurrency: opts.Concurrency,
MaxRequests: opts.MaxRequests,
MaxDuration: opts.MaxDuration.String(),
MaxRPS: opts.RPS,
}
// If format is JSON, benchmark parameters are printed after benchmark is run to maintain a single JSON blob
formatAsJSON := false
switch format := strings.ToLower(opts.Format); format {
case "text", "":
printParameters(out, parameters)
case "json":
formatAsJSON = true
default:
out.Warnf("Unrecognized format option %q, please specify 'json' for JSON output. Printing plaintext output as default.\n\n", opts.Format)
printParameters(out, parameters)
}
// Warm up number of connections.
logger.Debug("Warming up connections.", zap.Int("numConns", numConns))
connections, err := warmTransports(b, numConns, allOpts.TOpts, resolved, opts.WarmupRequests)
if err != nil {
out.Fatalf("Failed to warmup connections for benchmark: %v", err)
}
globalStatter, err := statsd.NewClient(logger, opts.StatsdHostPort, allOpts.TOpts.ServiceName, methodName)
if err != nil {
out.Fatalf("Failed to create statsd client for benchmark: %v", err)
}
var wg sync.WaitGroup
states := make([]*benchmarkState, len(connections)*opts.Concurrency)
for i, c := range connections {
statter := globalStatter
if opts.PerPeerStats {
// If per-peer stats are enabled, dual emit metrics to the original value
// and the per-peer value.
prefix := fmt.Sprintf("peer.%v.", c.peerID)
statter = statsd.MultiClient(
statter,
statsd.NewPrefixedClient(statter, prefix),
)
}
for j := 0; j < opts.Concurrency; j++ {
states[i*opts.Concurrency+j] = newBenchmarkState(statter)
}
}
run := limiter.New(opts.MaxRequests, opts.RPS, opts.MaxDuration)
stopOnInterrupt(out, run)
logger.Info("Benchmark starting.", zap.Any("options", opts))
start := time.Now()
for i, c := range connections {
for j := 0; j < opts.Concurrency; j++ {
state := states[i*opts.Concurrency+j]
wg.Add(1)
go func(t transport.Transport) {
defer wg.Done()
runWorker(t, b, state, run, logger)
}(c.Transport)
}
}
// Wait for all the worker goroutines to end.
wg.Wait()
total := time.Since(start)
// Merge all the states into 0
overall := states[0]
for _, s := range states[1:] {
overall.merge(s)
}
logger.Info("Benchmark complete.",
zap.Duration("totalDuration", total),
zap.Int("totalRequests", overall.totalRequests),
zap.Time("startTime", start),
)
errors := overall.getErrorSummary()
latencyValues := overall.getLatencies()
// Rounding RPS value to the hundredths place
rps := float64(overall.totalRequests) / total.Seconds()
rps = (math.Round(rps * 100)) / 100
summary := Summary{
ElapsedTimeSeconds: (total / time.Millisecond * time.Millisecond).Seconds(),
TotalRequests: overall.totalRequests,
RPS: rps,
}
var streamSummary *StreamSummary
// create stream summary for streaming calls only.
if b.CallMethodType() != encoding.Unary {
streamSummary = &StreamSummary{
TotalStreamMessagesSent: overall.totalStreamMessagesSent,
TotalStreamMessagesReceived: overall.totalStreamMessagesReceived,
}
}
if formatAsJSON {
outputJSON(out, parameters, latencyValues, summary, streamSummary, errors)
} else {
outputPlaintext(out, latencyValues, summary, streamSummary, errors)
}
}
func outputJSON(out output, parameters Parameters, latencyValues map[float64]time.Duration, summary Summary, streamSummary *StreamSummary, errorSummary *ErrorSummary) {
latencies := make(map[string]string, len(_quantiles))
for _, quantile := range _quantiles {
latencies[fmt.Sprintf("%.4f", quantile)] = latencyValues[quantile].String()
}
benchmarkOutput := BenchmarkOutput{
Parameters: parameters,
Latencies: latencies,
Summary: summary,
ErrorSummary: errorSummary,
StreamSummary: streamSummary,
}
jsonOutput, err := json.MarshalIndent(&benchmarkOutput, "" /* prefix */, " " /* indent */)
if err != nil {
out.Fatalf("Failed to marshal benchmark output: %v\n", err)
}
out.Printf("%s\n", jsonOutput)
}
func outputPlaintext(out output, latencyValues map[float64]time.Duration, summary Summary, streamSummary *StreamSummary, errorSummary *ErrorSummary) {
// Print errors
printErrors(out, errorSummary)
// Print out latencies
printLatencies(out, latencyValues)
// Print out summary
out.Printf("Elapsed time (seconds): %.2f\n", summary.ElapsedTimeSeconds)
out.Printf("Total requests: %v\n", summary.TotalRequests)
out.Printf("RPS: %.2f\n", summary.RPS)
if streamSummary != nil {
out.Printf("Total stream messages sent: %v\n", streamSummary.TotalStreamMessagesSent)
out.Printf("Total stream messages received: %v\n", streamSummary.TotalStreamMessagesReceived)
}
}
func printParameters(out output, parameters Parameters) {
out.Printf("Benchmark parameters:\n")
out.Printf(" CPUs: %v\n", parameters.CPUs)
out.Printf(" Connections: %v\n", parameters.Connections)
out.Printf(" Concurrency: %v\n", parameters.Concurrency)
out.Printf(" Max requests: %v\n", parameters.MaxRequests)
out.Printf(" Max duration: %v\n", parameters.MaxDuration)
out.Printf(" Max RPS: %v\n", parameters.MaxRPS)
}
func printLatencies(out output, latencyValues map[float64]time.Duration) {
out.Printf("Latencies:\n")
for _, quantile := range _quantiles {
out.Printf(" %.4f: %v\n", quantile, latencyValues[quantile])
}
}
func printErrors(out output, errorSum *ErrorSummary) {
if errorSum == nil {
return
}
out.Printf("Errors:\n")
for _, k := range sorted.MapKeys(errorSum.ErrorsCount) {
v := errorSum.ErrorsCount[k]
out.Printf(" %4d: %v\n", v, k)
}
out.Printf("Total errors: %v\n", errorSum.TotalErrors)
out.Printf("Error rate: %.4f%%\n", errorSum.ErrorRate)
}
// stopOnInterrupt sets up a signal that will trigger the run to stop.
func stopOnInterrupt(out output, r *limiter.Run) {
c := make(chan os.Signal, 1)
signal.Notify(c, os.Interrupt)
go func() {
<-c
// Preceding newline since Ctrl-C will be printed inline.
out.Printf("\n!!Benchmark interrupted!!\n")
r.Stop()
}()
}