-
Notifications
You must be signed in to change notification settings - Fork 771
/
ringpop.go
344 lines (300 loc) · 9.17 KB
/
ringpop.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
// Copyright (c) 2017 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 config
import (
"context"
"errors"
"fmt"
"net"
"reflect"
"strings"
"sync"
"time"
"github.com/uber/ringpop-go"
"github.com/uber/ringpop-go/discovery"
"github.com/uber/ringpop-go/discovery/jsonfile"
"github.com/uber/ringpop-go/discovery/statichosts"
"github.com/uber/ringpop-go/swim"
tcg "github.com/uber/tchannel-go"
"go.uber.org/yarpc"
"go.uber.org/yarpc/transport/tchannel"
"github.com/uber/cadence/common"
"github.com/uber/cadence/common/log"
"github.com/uber/cadence/common/log/tag"
"github.com/uber/cadence/common/membership"
)
const (
// BootstrapModeNone represents a bootstrap mode set to nothing or invalid
BootstrapModeNone BootstrapMode = iota
// BootstrapModeFile represents a file-based bootstrap mode
BootstrapModeFile
// BootstrapModeHosts represents a list of hosts passed in the configuration
BootstrapModeHosts
// BootstrapModeCustom represents a custom bootstrap mode
BootstrapModeCustom
// BootstrapModeDNS represents a list of hosts passed in the configuration
// to be resolved, and the resulting addresses are used for bootstrap
BootstrapModeDNS
)
const (
defaultMaxJoinDuration = 10 * time.Second
)
// CadenceServices indicate the list of cadence services
var CadenceServices = []string{
common.FrontendServiceName,
common.HistoryServiceName,
common.MatchingServiceName,
common.WorkerServiceName,
}
// RingpopFactory implements the RingpopFactory interface
type RingpopFactory struct {
config *Ringpop
dispatcher *yarpc.Dispatcher
serviceName string
logger log.Logger
sync.Mutex
ringPop *membership.RingPop
membershipMonitor membership.Monitor
}
// NewFactory builds a ringpop factory conforming
// to the underlying configuration
func (rpConfig *Ringpop) NewFactory(
dispatcher *yarpc.Dispatcher,
serviceName string,
logger log.Logger,
) (*RingpopFactory, error) {
return newRingpopFactory(rpConfig, dispatcher, serviceName, logger)
}
func (rpConfig *Ringpop) validate() error {
if len(rpConfig.Name) == 0 {
return fmt.Errorf("ringpop config missing `name` param")
}
return validateBootstrapMode(rpConfig)
}
// UnmarshalYAML is called by the yaml package to convert
// the config YAML into a BootstrapMode.
func (m *BootstrapMode) UnmarshalYAML(
unmarshal func(interface{}) error,
) error {
var s string
if err := unmarshal(&s); err != nil {
return err
}
var err error
*m, err = parseBootstrapMode(s)
return err
}
// parseBootstrapMode reads a string value and returns a bootstrap mode.
func parseBootstrapMode(
mode string,
) (BootstrapMode, error) {
switch strings.ToLower(mode) {
case "hosts":
return BootstrapModeHosts, nil
case "file":
return BootstrapModeFile, nil
case "custom":
return BootstrapModeCustom, nil
case "dns":
return BootstrapModeDNS, nil
}
return BootstrapModeNone, errors.New("invalid or no ringpop bootstrap mode")
}
func validateBootstrapMode(
rpConfig *Ringpop,
) error {
switch rpConfig.BootstrapMode {
case BootstrapModeFile:
if len(rpConfig.BootstrapFile) == 0 {
return fmt.Errorf("ringpop config missing bootstrap file param")
}
case BootstrapModeHosts, BootstrapModeDNS:
if len(rpConfig.BootstrapHosts) == 0 {
return fmt.Errorf("ringpop config missing boostrap hosts param")
}
case BootstrapModeCustom:
if rpConfig.DiscoveryProvider == nil {
return fmt.Errorf("ringpop bootstrapMode is set to custom but discoveryProvider is nil")
}
default:
return fmt.Errorf("ringpop config with unknown boostrap mode")
}
return nil
}
func newRingpopFactory(
rpConfig *Ringpop,
dispatcher *yarpc.Dispatcher,
serviceName string,
logger log.Logger,
) (*RingpopFactory, error) {
if err := rpConfig.validate(); err != nil {
return nil, err
}
if rpConfig.MaxJoinDuration == 0 {
rpConfig.MaxJoinDuration = defaultMaxJoinDuration
}
return &RingpopFactory{
config: rpConfig,
dispatcher: dispatcher,
serviceName: serviceName,
logger: logger,
}, nil
}
// GetMembershipMonitor return a membership monitor
func (factory *RingpopFactory) GetMembershipMonitor() (membership.Monitor, error) {
factory.Lock()
defer factory.Unlock()
return factory.getMembership()
}
func (factory *RingpopFactory) getMembership() (membership.Monitor, error) {
if factory.membershipMonitor != nil {
return factory.membershipMonitor, nil
}
membershipMonitor, err := factory.createMembership()
if err != nil {
return nil, err
}
factory.membershipMonitor = membershipMonitor
return membershipMonitor, nil
}
func (factory *RingpopFactory) createMembership() (membership.Monitor, error) {
// use actual listen port (in case service is bound to :0 or 0.0.0.0:0)
rp, err := factory.getRingpop()
if err != nil {
return nil, fmt.Errorf("ringpop creation failed: %v", err)
}
membershipMonitor := membership.NewRingpopMonitor(factory.serviceName, CadenceServices, rp, factory.logger)
return membershipMonitor, nil
}
func (factory *RingpopFactory) getRingpop() (*membership.RingPop, error) {
if factory.ringPop != nil {
return factory.ringPop, nil
}
ringPop, err := factory.createRingpop()
if err != nil {
return nil, err
}
factory.ringPop = ringPop
return ringPop, nil
}
func (factory *RingpopFactory) createRingpop() (*membership.RingPop, error) {
var ch *tcg.Channel
var err error
if ch, err = factory.getChannel(factory.dispatcher); err != nil {
return nil, err
}
rp, err := ringpop.New(factory.config.Name, ringpop.Channel(ch))
if err != nil {
return nil, err
}
discoveryProvider, err := newDiscoveryProvider(factory.config, factory.logger)
if err != nil {
return nil, err
}
bootstrapOpts := &swim.BootstrapOptions{
MaxJoinDuration: factory.config.MaxJoinDuration,
DiscoverProvider: discoveryProvider,
}
return membership.NewRingPop(rp, bootstrapOpts, factory.logger), nil
}
func (factory *RingpopFactory) getChannel(
dispatcher *yarpc.Dispatcher,
) (*tcg.Channel, error) {
t := dispatcher.Inbounds()[0].Transports()[0].(*tchannel.ChannelTransport)
ty := reflect.ValueOf(t.Channel())
var ch *tcg.Channel
var ok bool
if ch, ok = ty.Interface().(*tcg.Channel); !ok {
return nil, errors.New("unable to get tchannel out of the dispatcher")
}
return ch, nil
}
type dnsHostResolver interface {
LookupHost(ctx context.Context, host string) (addrs []string, err error)
}
type dnsProvider struct {
UnresolvedHosts []string
Resolver dnsHostResolver
Logger log.Logger
}
func newDNSProvider(
hosts []string,
resolver dnsHostResolver,
logger log.Logger,
) *dnsProvider {
set := map[string]struct{}{}
for _, hostport := range hosts {
set[hostport] = struct{}{}
}
var keys []string
for key := range set {
keys = append(keys, key)
}
return &dnsProvider{
UnresolvedHosts: keys,
Resolver: resolver,
Logger: logger,
}
}
func (provider *dnsProvider) Hosts() ([]string, error) {
var results []string
resolvedHosts := map[string][]string{}
for _, hostPort := range provider.UnresolvedHosts {
host, port, err := net.SplitHostPort(hostPort)
if err != nil {
provider.Logger.Warn("could not split host and port", tag.Address(hostPort), tag.Error(err))
continue
}
resolved, exists := resolvedHosts[host]
if !exists {
resolved, err = provider.Resolver.LookupHost(context.Background(), host)
if err != nil {
provider.Logger.Warn("could not resolve host", tag.Address(host), tag.Error(err))
continue
}
resolvedHosts[host] = resolved
}
for _, r := range resolved {
results = append(results, net.JoinHostPort(r, port))
}
}
if len(results) == 0 {
return nil, errors.New("no hosts found, and bootstrap requires at least one")
}
return results, nil
}
func newDiscoveryProvider(
cfg *Ringpop,
logger log.Logger,
) (discovery.DiscoverProvider, error) {
if cfg.DiscoveryProvider != nil {
// custom discovery provider takes first precedence
return cfg.DiscoveryProvider, nil
}
switch cfg.BootstrapMode {
case BootstrapModeHosts:
return statichosts.New(cfg.BootstrapHosts...), nil
case BootstrapModeFile:
return jsonfile.New(cfg.BootstrapFile), nil
case BootstrapModeDNS:
return newDNSProvider(cfg.BootstrapHosts, net.DefaultResolver, logger), nil
}
return nil, fmt.Errorf("unknown bootstrap mode")
}