/
monitor.go
395 lines (331 loc) · 11.4 KB
/
monitor.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
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
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
// The MIT License
//
// Copyright (c) 2020 Temporal Technologies Inc. All rights reserved.
//
// Copyright (c) 2020 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 ringpop
import (
"context"
"fmt"
"math"
"math/rand"
"net"
"strconv"
"strings"
"sync/atomic"
"time"
"go.temporal.io/server/common/convert"
"go.temporal.io/server/common/future"
"go.temporal.io/server/common/headers"
"go.temporal.io/server/common/membership"
"go.temporal.io/server/common/primitives"
"github.com/pborman/uuid"
"go.temporal.io/server/common/persistence"
"go.temporal.io/server/common"
"go.temporal.io/server/common/log"
"go.temporal.io/server/common/log/tag"
)
const (
upsertMembershipRecordExpiryDefault = time.Hour * 48
// 10 second base reporting frequency + 5 second jitter + 5 second acceptable time skew
healthyHostLastHeartbeatCutoff = time.Second * 20
)
type monitor struct {
status int32
lifecycleCtx context.Context
lifecycleCancel context.CancelFunc
serviceName primitives.ServiceName
services map[primitives.ServiceName]int
rp *service
rings map[primitives.ServiceName]*serviceResolver
logger log.Logger
metadataManager persistence.ClusterMetadataManager
broadcastHostPortResolver func() (string, error)
hostID uuid.UUID
initialized *future.FutureImpl[struct{}]
}
var _ membership.Monitor = (*monitor)(nil)
// newMonitor returns a ringpop-based membership monitor
func newMonitor(
serviceName primitives.ServiceName,
services map[primitives.ServiceName]int,
rp *service,
logger log.Logger,
metadataManager persistence.ClusterMetadataManager,
broadcastHostPortResolver func() (string, error),
) membership.Monitor {
lifecycleCtx, lifecycleCancel := context.WithCancel(context.Background())
lifecycleCtx = headers.SetCallerInfo(
lifecycleCtx,
headers.SystemBackgroundCallerInfo,
)
rpo := &monitor{
status: common.DaemonStatusInitialized,
lifecycleCtx: lifecycleCtx,
lifecycleCancel: lifecycleCancel,
serviceName: serviceName,
services: services,
rp: rp,
rings: make(map[primitives.ServiceName]*serviceResolver),
logger: logger,
metadataManager: metadataManager,
broadcastHostPortResolver: broadcastHostPortResolver,
hostID: uuid.NewUUID(),
initialized: future.NewFuture[struct{}](),
}
for service, port := range services {
rpo.rings[service] = newServiceResolver(service, port, rp, logger)
}
return rpo
}
func (rpo *monitor) Start() {
if !atomic.CompareAndSwapInt32(
&rpo.status,
common.DaemonStatusInitialized,
common.DaemonStatusStarted,
) {
return
}
broadcastAddress, err := rpo.broadcastHostPortResolver()
if err != nil {
rpo.logger.Fatal("unable to resolve broadcast address", tag.Error(err))
}
// TODO - Note this presents a small race condition as we write our identity before we bootstrap ringpop.
// This is a current limitation of the current structure of the ringpop library as
// we must know our seed nodes before bootstrapping
err = rpo.startHeartbeat(broadcastAddress)
if err != nil {
rpo.logger.Fatal("unable to initialize membership heartbeats", tag.Error(err))
}
rpo.rp.start(
func() ([]string, error) { return rpo.fetchCurrentBootstrapHostports() },
healthyHostLastHeartbeatCutoff/2)
labels, err := rpo.rp.Labels()
if err != nil {
rpo.logger.Fatal("unable to get ring pop labels", tag.Error(err))
}
if err = labels.Set(rolePort, strconv.Itoa(rpo.services[rpo.serviceName])); err != nil {
rpo.logger.Fatal("unable to set ring pop ServicePort label", tag.Error(err))
}
if err = labels.Set(roleKey, string(rpo.serviceName)); err != nil {
rpo.logger.Fatal("unable to set ring pop ServiceRole label", tag.Error(err))
}
for _, ring := range rpo.rings {
ring.Start()
}
rpo.initialized.Set(struct{}{}, nil)
}
func (rpo *monitor) WaitUntilInitialized(ctx context.Context) error {
_, err := rpo.initialized.Get(ctx)
return err
}
func serviceNameToServiceTypeEnum(name primitives.ServiceName) (persistence.ServiceType, error) {
switch name {
case primitives.AllServices:
return persistence.All, nil
case primitives.FrontendService:
return persistence.Frontend, nil
case primitives.InternalFrontendService:
return persistence.InternalFrontend, nil
case primitives.HistoryService:
return persistence.History, nil
case primitives.MatchingService:
return persistence.Matching, nil
case primitives.WorkerService:
return persistence.Worker, nil
default:
return persistence.All, fmt.Errorf("unable to parse servicename '%s'", name)
}
}
func (rpo *monitor) upsertMyMembership(
ctx context.Context,
request *persistence.UpsertClusterMembershipRequest,
) error {
err := rpo.metadataManager.UpsertClusterMembership(ctx, request)
if err == nil {
rpo.logger.Debug("Membership heartbeat upserted successfully",
tag.Address(request.RPCAddress.String()),
tag.Port(int(request.RPCPort)),
tag.HostID(request.HostID.String()))
}
return err
}
// splitHostPortTyped expands upon net.SplitHostPort by providing type parsing.
func splitHostPortTyped(hostPort string) (net.IP, uint16, error) {
ipstr, portstr, err := net.SplitHostPort(hostPort)
if err != nil {
return nil, 0, err
}
broadcastAddress := net.ParseIP(ipstr)
broadcastPort, err := strconv.ParseUint(portstr, 10, 16)
if err != nil {
return nil, 0, err
}
return broadcastAddress, uint16(broadcastPort), nil
}
func (rpo *monitor) startHeartbeat(broadcastHostport string) error {
// Start by cleaning up expired records to avoid growth
err := rpo.metadataManager.PruneClusterMembership(rpo.lifecycleCtx, &persistence.PruneClusterMembershipRequest{MaxRecordsPruned: 10})
if err != nil {
return err
}
sessionStarted := time.Now().UTC()
// Parse and validate broadcast hostport
broadcastAddress, broadcastPort, err := splitHostPortTyped(broadcastHostport)
if err != nil {
return err
}
// Parse and validate existing service name
role, err := serviceNameToServiceTypeEnum(rpo.serviceName)
if err != nil {
return err
}
req := &persistence.UpsertClusterMembershipRequest{
Role: role,
RPCAddress: broadcastAddress,
RPCPort: broadcastPort,
SessionStart: sessionStarted,
RecordExpiry: upsertMembershipRecordExpiryDefault,
HostID: rpo.hostID,
}
// Upsert before fetching bootstrap hosts.
// This makes us discoverable by other Temporal cluster members
// Expire in 48 hours to allow for inspection of table by humans for debug scenarios.
// For bootstrapping, we filter to a much shorter duration on the
// read side by filtering on the last time a heartbeat was seen.
err = rpo.upsertMyMembership(rpo.lifecycleCtx, req)
if err == nil {
rpo.logger.Info("Membership heartbeat upserted successfully",
tag.Address(broadcastAddress.String()),
tag.Port(int(broadcastPort)),
tag.HostID(rpo.hostID.String()))
rpo.startHeartbeatUpsertLoop(req)
}
return err
}
func (rpo *monitor) fetchCurrentBootstrapHostports() ([]string, error) {
pageSize := 1000
set := make(map[string]struct{})
var nextPageToken []byte
for {
resp, err := rpo.metadataManager.GetClusterMembers(
rpo.lifecycleCtx,
&persistence.GetClusterMembersRequest{
LastHeartbeatWithin: healthyHostLastHeartbeatCutoff,
PageSize: pageSize,
NextPageToken: nextPageToken,
})
if err != nil {
return nil, err
}
// Dedupe on hostport
for _, host := range resp.ActiveMembers {
set[net.JoinHostPort(host.RPCAddress.String(), convert.Uint16ToString(host.RPCPort))] = struct{}{}
}
// Stop iterating once we have either 500 unique ip:port combos or there is no more results.
if nextPageToken == nil || len(set) >= 500 {
bootstrapHostPorts := make([]string, 0, len(set))
for k := range set {
bootstrapHostPorts = append(bootstrapHostPorts, k)
}
rpo.logger.Info("bootstrap hosts fetched", tag.BootstrapHostPorts(strings.Join(bootstrapHostPorts, ",")))
return bootstrapHostPorts, nil
}
}
}
func (rpo *monitor) startHeartbeatUpsertLoop(request *persistence.UpsertClusterMembershipRequest) {
loopUpsertMembership := func() {
for {
err := rpo.upsertMyMembership(rpo.lifecycleCtx, request)
if err != nil {
rpo.logger.Error("Membership upsert failed.", tag.Error(err))
}
jitter := math.Round(rand.Float64() * 5)
time.Sleep(time.Second * time.Duration(10+jitter))
}
}
go loopUpsertMembership()
}
func (rpo *monitor) Stop() {
if !atomic.CompareAndSwapInt32(
&rpo.status,
common.DaemonStatusStarted,
common.DaemonStatusStopped,
) {
return
}
rpo.lifecycleCancel()
for _, ring := range rpo.rings {
ring.Stop()
}
rpo.rp.stop()
}
// WhoAmI returns the address (host:port) and labels for a service
// Ringpop implementation of WhoAmI return the address used by ringpop listener.
// This is different from service address as we register ringpop handlers on a separate port.
// For this reason we need to lookup the port for the service and replace ringpop port with service port before
// returning HostInfo back.
func (rpo *monitor) WhoAmI() (membership.HostInfo, error) {
address, err := rpo.rp.WhoAmI()
if err != nil {
return nil, err
}
labels, err := rpo.rp.Labels()
if err != nil {
return nil, err
}
servicePort, ok := rpo.services[rpo.serviceName]
if !ok {
return nil, membership.ErrUnknownService
}
serviceAddress, err := replaceServicePort(address, servicePort)
if err != nil {
return nil, err
}
return newHostInfo(serviceAddress, labels.AsMap()), nil
}
func (rpo *monitor) EvictSelf() error {
return rpo.rp.SelfEvict()
}
func (rpo *monitor) GetResolver(service primitives.ServiceName) (membership.ServiceResolver, error) {
ring, found := rpo.rings[service]
if !found {
return nil, membership.ErrUnknownService
}
return ring, nil
}
func (rpo *monitor) Lookup(service primitives.ServiceName, key string) (membership.HostInfo, error) {
ring, err := rpo.GetResolver(service)
if err != nil {
return nil, err
}
return ring.Lookup(key)
}
func (rpo *monitor) GetReachableMembers() ([]string, error) {
return rpo.rp.GetReachableMembers()
}
func replaceServicePort(address string, servicePort int) (string, error) {
host, _, err := net.SplitHostPort(address)
if err != nil {
return "", membership.ErrIncorrectAddressFormat
}
return net.JoinHostPort(host, convert.IntToString(servicePort)), nil
}