forked from uber/tchannel-go
/
options.go
126 lines (108 loc) · 3.66 KB
/
options.go
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
// Copyright (c) 2015 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 benchmark
import "time"
type options struct {
external bool
svcName string
noLibrary bool
// Following options only make sense for clients.
noChecking bool
timeout time.Duration
reqSize int
numClients int
// noDurations disables printing of durations to stdout.
// This only applies to clients running out-of-process.
noDurations bool
// Following options only make sense for servers.
advertiseHosts []string
}
// Option represents a Benchmark option.
type Option func(*options)
// WithTimeout sets the timeout to use for each call.
func WithTimeout(timeout time.Duration) Option {
return func(opts *options) {
opts.timeout = timeout
}
}
// WithRequestSize sets the request size for each call.
func WithRequestSize(reqSize int) Option {
return func(opts *options) {
opts.reqSize = reqSize
}
}
// WithServiceName sets the service name of the benchmark server.
func WithServiceName(svcName string) Option {
return func(opts *options) {
opts.svcName = svcName
}
}
// WithExternalProcess creates a separate process to host the server/client.
func WithExternalProcess() Option {
return func(opts *options) {
opts.external = true
}
}
// WithNoLibrary uses the fast TCP-template based approach for generating
// TChannel frames rather than the TChannel client library.
func WithNoLibrary() Option {
return func(opts *options) {
opts.noLibrary = true
}
}
// WithNoChecking disables result verification on the client side, which
// may slow down the client (as it compares all request bytes against the
// response bytes).
func WithNoChecking() Option {
return func(opts *options) {
opts.noChecking = true
}
}
// WithNumClients sets the number of concurrent TChannel clients to use
// internally under a single benchmark.Client. This is used to generate
// generate a large amount of traffic, as a single TChannel client will
// not saturate a CPU since it will spend most of the time blocking and
// waiting for the remote side to respond.
func WithNumClients(numClients int) Option {
return func(opts *options) {
opts.numClients = numClients
}
}
// WithNoDurations disables printing of latencies to standard out.
func WithNoDurations() Option {
return func(opts *options) {
opts.noDurations = true
}
}
// WithAdvertiseHosts sets the hosts to advertise with on startup.
func WithAdvertiseHosts(hosts []string) Option {
return func(opts *options) {
opts.advertiseHosts = hosts
}
}
func getOptions(optFns []Option) *options {
opts := &options{
timeout: time.Second,
svcName: "bench-server",
}
for _, opt := range optFns {
opt(opts)
}
return opts
}