-
Notifications
You must be signed in to change notification settings - Fork 33
/
roundrobin.go
344 lines (299 loc) · 7.85 KB
/
roundrobin.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
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
// Dynamic weighted round robin load balancer
package roundrobin
import (
"fmt"
"github.com/mailgun/log"
"github.com/mailgun/timetools"
"github.com/mailgun/vulcan/endpoint"
"github.com/mailgun/vulcan/metrics"
"github.com/mailgun/vulcan/netutils"
"github.com/mailgun/vulcan/request"
"net/http"
"net/url"
"sync"
"time"
)
// Dynamic weighted round robin load balancer.
type RoundRobin struct {
mutex *sync.Mutex
// Current index (starts from -1)
index int
endpoints []*WeightedEndpoint
currentWeight int
options Options
}
type Options struct {
// Control time in tests
TimeProvider timetools.TimeProvider
// Algorithm that reacts on the failures and can adjust weights
FailureHandler FailureHandler
}
// Set additional parameters for the endpoint can be supplied when adding endpoint
type EndpointOptions struct {
// Relative weight for the enpoint to other enpoints in the load balancer
Weight int
// Meter tracks the failure count and is used to do failover
Meter metrics.FailRateMeter
}
func NewRoundRobin() (*RoundRobin, error) {
return NewRoundRobinWithOptions(Options{})
}
func NewRoundRobinWithOptions(o Options) (*RoundRobin, error) {
o, err := validateOptions(o)
if err != nil {
return nil, err
}
rr := &RoundRobin{
options: o,
index: -1,
mutex: &sync.Mutex{},
endpoints: []*WeightedEndpoint{},
}
return rr, nil
}
func (r *RoundRobin) NextEndpoint(req request.Request) (endpoint.Endpoint, error) {
r.mutex.Lock()
defer r.mutex.Unlock()
e, err := r.nextEndpoint(req)
if err != nil {
return nil, err
}
lastAttempt := req.GetLastAttempt()
// This is the first try, so just return the selected endpoint
if lastAttempt == nil {
return e, nil
}
// Try to prevent failover to the same endpoint that we've seen before,
// that reduces the probability of the scenario when failover hits same endpoint
// on the next attempt and fails, so users will see a failed request.
var endpoint endpoint.Endpoint
for _ = range r.endpoints {
endpoint, err = r.nextEndpoint(req)
if err != nil {
return nil, err
}
if !hasAttempted(req, endpoint) {
return endpoint, nil
}
}
return endpoint, nil
}
func (r *RoundRobin) nextEndpoint(req request.Request) (endpoint.Endpoint, error) {
if len(r.endpoints) == 0 {
return nil, fmt.Errorf("No endpoints")
}
// Adjust weights based on endpoints failure rates
r.adjustWeights()
// The algo below may look messy, but is actually very simple
// it calculates the GCD and subtracts it on every iteration, what interleaves endpoints
// and allows us not to build an iterator every time we readjust weights
// GCD across all enabled endpoints
gcd := r.weightGcd()
// Maximum weight across all enabled endpoints
max := r.maxWeight()
for {
r.index = (r.index + 1) % len(r.endpoints)
if r.index == 0 {
r.currentWeight = r.currentWeight - gcd
if r.currentWeight <= 0 {
r.currentWeight = max
if r.currentWeight == 0 {
return nil, fmt.Errorf("All endpoints have 0 weight")
}
}
}
e := r.endpoints[r.index]
if e.effectiveWeight >= r.currentWeight {
return e.endpoint, nil
}
}
// We did full circle and found no available endpoints
return nil, fmt.Errorf("No available endpoints!")
}
func (r *RoundRobin) adjustWeights() {
if r.options.FailureHandler == nil {
return
}
weights, err := r.options.FailureHandler.AdjustWeights()
if err != nil {
log.Errorf("%s returned error: %s", r.options.FailureHandler, err)
return
}
changed := false
for _, w := range weights {
if w.GetEndpoint().GetEffectiveWeight() != w.GetWeight() {
w.GetEndpoint().setEffectiveWeight(w.GetWeight())
changed = true
}
}
if changed {
r.resetIterator()
}
}
func (r *RoundRobin) GetEndpoints() []*WeightedEndpoint {
return r.endpoints
}
func (rr *RoundRobin) AddEndpoint(endpoint endpoint.Endpoint) error {
return rr.AddEndpointWithOptions(endpoint, EndpointOptions{})
}
// In case if endpoint is already present in the load balancer, returns error
func (r *RoundRobin) AddEndpointWithOptions(endpoint endpoint.Endpoint, options EndpointOptions) error {
r.mutex.Lock()
defer r.mutex.Unlock()
if endpoint == nil {
return fmt.Errorf("Endpoint can't be nil")
}
if e, _ := r.findEndpointByUrl(endpoint.GetUrl()); e != nil {
return fmt.Errorf("Endpoint already exists")
}
we, err := r.newWeightedEndpoint(endpoint, options)
if err != nil {
return err
}
r.endpoints = append(r.endpoints, we)
r.resetState()
return nil
}
func (r *RoundRobin) resetIterator() {
r.index = -1
r.currentWeight = 0
}
func (r *RoundRobin) resetState() {
r.resetIterator()
if r.options.FailureHandler != nil {
r.options.FailureHandler.Init(r.endpoints)
}
}
func (r *RoundRobin) findEndpointByUrl(iu *url.URL) (*WeightedEndpoint, int) {
if len(r.endpoints) == 0 {
return nil, -1
}
for i, e := range r.endpoints {
u := e.GetUrl()
if u.Path == iu.Path && u.Host == iu.Host && u.Scheme == iu.Scheme {
return e, i
}
}
return nil, -1
}
func (r *RoundRobin) FindEndpointByUrl(url string) *WeightedEndpoint {
out, err := netutils.ParseUrl(url)
if err != nil {
return nil
}
found, _ := r.findEndpointByUrl(out)
return found
}
func (r *RoundRobin) FindEndpointById(id string) *WeightedEndpoint {
if len(r.endpoints) == 0 {
return nil
}
for _, e := range r.endpoints {
if e.GetId() == id {
return e
}
}
return nil
}
func (rr *RoundRobin) newWeightedEndpoint(endpoint endpoint.Endpoint, options EndpointOptions) (*WeightedEndpoint, error) {
// Treat weight 0 as a default value passed by customer
if options.Weight == 0 {
options.Weight = 1
}
if options.Weight < 0 {
return nil, fmt.Errorf("Weight should be >=0")
}
if options.Meter == nil {
meter, err := metrics.NewRollingMeter(
endpoint, 10, time.Second, rr.options.TimeProvider, metrics.IsNetworkError)
if err != nil {
return nil, err
}
options.Meter = meter
}
return &WeightedEndpoint{
meter: options.Meter,
endpoint: endpoint,
weight: options.Weight,
effectiveWeight: options.Weight,
rr: rr,
}, nil
}
func (r *RoundRobin) RemoveEndpoint(endpoint endpoint.Endpoint) error {
r.mutex.Lock()
defer r.mutex.Unlock()
e, index := r.findEndpointByUrl(endpoint.GetUrl())
if e == nil {
return fmt.Errorf("Endpoint not found")
}
r.endpoints = append(r.endpoints[:index], r.endpoints[index+1:]...)
r.resetState()
return nil
}
func (rr *RoundRobin) ProcessRequest(request.Request) (*http.Response, error) {
return nil, nil
}
func (rr *RoundRobin) ProcessResponse(req request.Request, a request.Attempt) {
}
func (rr *RoundRobin) ObserveRequest(request.Request) {
}
func (rr *RoundRobin) ObserveResponse(req request.Request, a request.Attempt) {
rr.mutex.Lock()
defer rr.mutex.Unlock()
if a == nil || a.GetEndpoint() == nil {
return
}
we, _ := rr.findEndpointByUrl(a.GetEndpoint().GetUrl())
if we == nil {
return
}
// Update endpoint stats: failure count and request roundtrip
we.meter.ObserveResponse(req, a)
}
func (rr *RoundRobin) maxWeight() int {
max := -1
for _, e := range rr.endpoints {
if e.effectiveWeight > max {
max = e.effectiveWeight
}
}
return max
}
func (rr *RoundRobin) weightGcd() int {
divisor := -1
for _, e := range rr.endpoints {
if divisor == -1 {
divisor = e.effectiveWeight
} else {
divisor = gcd(divisor, e.effectiveWeight)
}
}
return divisor
}
func gcd(a, b int) int {
for b != 0 {
a, b = b, a%b
}
return a
}
func validateOptions(o Options) (Options, error) {
if o.TimeProvider == nil {
o.TimeProvider = &timetools.RealTime{}
}
if o.FailureHandler == nil {
failureHandler, err := NewFSMHandler()
if err != nil {
return o, err
}
o.FailureHandler = failureHandler
}
return o, nil
}
func hasAttempted(req request.Request, endpoint endpoint.Endpoint) bool {
for _, a := range req.GetAttempts() {
if a.GetEndpoint().GetId() == endpoint.GetId() {
return true
}
}
return false
}