-
Notifications
You must be signed in to change notification settings - Fork 787
/
failover_watcher.go
228 lines (200 loc) · 7.07 KB
/
failover_watcher.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
// Copyright (c) 2017-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.
//go:generate mockgen -package $GOPACKAGE -source $GOFILE -destination failover_watcher_mock.go
package domain
import (
"context"
"fmt"
"sync/atomic"
"time"
"github.com/uber/cadence/common"
"github.com/uber/cadence/common/backoff"
"github.com/uber/cadence/common/cache"
"github.com/uber/cadence/common/clock"
"github.com/uber/cadence/common/dynamicconfig"
"github.com/uber/cadence/common/log"
"github.com/uber/cadence/common/log/tag"
"github.com/uber/cadence/common/metrics"
"github.com/uber/cadence/common/persistence"
)
const (
updateDomainRetryInitialInterval = 50 * time.Millisecond
updateDomainRetryCoefficient = 2.0
updateDomainMaxRetry = 3
)
type (
// FailoverWatcher handles failover operation on domain entities
FailoverWatcher interface {
common.Daemon
}
failoverWatcherImpl struct {
status int32
shutdownChan chan struct{}
refreshInterval dynamicconfig.DurationPropertyFn
refreshJitter dynamicconfig.FloatPropertyFn
retryPolicy backoff.RetryPolicy
domainManager persistence.DomainManager
domainCache cache.DomainCache
timeSource clock.TimeSource
scope metrics.Scope
logger log.Logger
}
)
var _ FailoverWatcher = (*failoverWatcherImpl)(nil)
// NewFailoverWatcher initializes domain failover processor
func NewFailoverWatcher(
domainCache cache.DomainCache,
domainManager persistence.DomainManager,
timeSource clock.TimeSource,
refreshInterval dynamicconfig.DurationPropertyFn,
refreshJitter dynamicconfig.FloatPropertyFn,
metricsClient metrics.Client,
logger log.Logger,
) FailoverWatcher {
retryPolicy := &backoff.ExponentialRetryPolicy{}
retryPolicy.SetInitialInterval(updateDomainRetryInitialInterval)
retryPolicy.SetBackoffCoefficient(updateDomainRetryCoefficient)
retryPolicy.SetMaximumAttempts(updateDomainMaxRetry)
return &failoverWatcherImpl{
status: common.DaemonStatusInitialized,
shutdownChan: make(chan struct{}),
refreshInterval: refreshInterval,
refreshJitter: refreshJitter,
retryPolicy: retryPolicy,
domainCache: domainCache,
domainManager: domainManager,
timeSource: timeSource,
scope: metricsClient.Scope(metrics.DomainFailoverScope),
logger: logger,
}
}
func (p *failoverWatcherImpl) Start() {
if !atomic.CompareAndSwapInt32(&p.status, common.DaemonStatusInitialized, common.DaemonStatusStarted) {
return
}
go p.refreshDomainLoop()
p.logger.Info("Domain failover processor started.")
}
func (p *failoverWatcherImpl) Stop() {
if !atomic.CompareAndSwapInt32(&p.status, common.DaemonStatusStarted, common.DaemonStatusStopped) {
return
}
close(p.shutdownChan)
p.logger.Info("Domain failover processor stop.")
}
func (p *failoverWatcherImpl) refreshDomainLoop() {
timer := p.timeSource.NewTimer(backoff.JitDuration(
p.refreshInterval(),
p.refreshJitter(),
))
defer timer.Stop()
for {
select {
case <-p.shutdownChan:
return
case <-timer.Chan():
domains := p.domainCache.GetAllDomain()
for _, domain := range domains {
p.handleFailoverTimeout(domain)
select {
case <-p.shutdownChan:
p.logger.Debug("Stop refresh domain as the processing is stopping.")
return
default:
}
}
timer.Reset(backoff.JitDuration(
p.refreshInterval(),
p.refreshJitter(),
))
}
}
}
func (p *failoverWatcherImpl) handleFailoverTimeout(
domain *cache.DomainCacheEntry,
) {
failoverEndTime := domain.GetFailoverEndTime()
if domain.IsDomainPendingActive() && p.timeSource.Now().After(time.Unix(0, *failoverEndTime)) {
domainID := domain.GetInfo().ID
// force failover the domain without setting the failover timeout
if err := CleanPendingActiveState(
p.domainManager,
domainID,
domain.GetFailoverVersion(),
p.retryPolicy,
); err != nil {
p.logger.Error("Failed to update pending-active domain to active", tag.WorkflowDomainID(domainID), tag.Error(err))
return
}
p.scope.Tagged(metrics.DomainTag(domain.GetInfo().Name)).IncCounter(metrics.GracefulFailoverFailure)
}
}
// CleanPendingActiveState removes the pending active state from the domain
func CleanPendingActiveState(
domainManager persistence.DomainManager,
domainID string,
failoverVersion int64,
policy backoff.RetryPolicy,
) error {
// must get the metadata (notificationVersion) first
// this version can be regarded as the lock on the v2 domain table
// and since we do not know which table will return the domain afterwards
// this call has to be made
metadata, err := domainManager.GetMetadata(context.Background())
if err != nil {
return fmt.Errorf("getting metadata: %w", err)
}
getResponse, err := domainManager.GetDomain(context.Background(), &persistence.GetDomainRequest{ID: domainID})
if err != nil {
return fmt.Errorf("getting domain: %w", err)
}
localFailoverVersion := getResponse.FailoverVersion
isGlobalDomain := getResponse.IsGlobalDomain
gracefulFailoverEndTime := getResponse.FailoverEndTime
if isGlobalDomain && gracefulFailoverEndTime != nil && failoverVersion == localFailoverVersion {
// if the domain is still pending active and the failover versions are the same, clean the state
updateReq := &persistence.UpdateDomainRequest{
Info: getResponse.Info,
Config: getResponse.Config,
ReplicationConfig: getResponse.ReplicationConfig,
ConfigVersion: getResponse.ConfigVersion,
FailoverVersion: localFailoverVersion,
FailoverNotificationVersion: getResponse.FailoverNotificationVersion,
FailoverEndTime: nil,
NotificationVersion: metadata.NotificationVersion,
}
op := func() error {
return domainManager.UpdateDomain(context.Background(), updateReq)
}
throttleRetry := backoff.NewThrottleRetry(
backoff.WithRetryPolicy(policy),
backoff.WithRetryableError(isUpdateDomainRetryable),
)
if err := throttleRetry.Do(context.Background(), op); err != nil {
return err
}
}
return nil
}
func isUpdateDomainRetryable(
err error,
) bool {
return true
}