-
Notifications
You must be signed in to change notification settings - Fork 793
/
scanner.go
235 lines (213 loc) · 9.22 KB
/
scanner.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
// 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 scanner
import (
"context"
"time"
"github.com/uber-go/tally"
"go.uber.org/cadence/.gen/go/shared"
cclient "go.uber.org/cadence/client"
"go.uber.org/cadence/worker"
"go.uber.org/zap"
"github.com/uber/cadence/common"
"github.com/uber/cadence/common/backoff"
"github.com/uber/cadence/common/cluster"
"github.com/uber/cadence/common/log/tag"
"github.com/uber/cadence/common/metrics"
c "github.com/uber/cadence/common/reconciliation/common"
"github.com/uber/cadence/common/resource"
"github.com/uber/cadence/common/service/config"
"github.com/uber/cadence/common/service/dynamicconfig"
"github.com/uber/cadence/service/worker/scanner/executions"
)
const (
// scannerStartUpDelay is to let services warm up
scannerStartUpDelay = time.Second * 4
)
type (
// Config defines the configuration for scanner
Config struct {
// PersistenceMaxQPS the max rate of calls to persistence
PersistenceMaxQPS dynamicconfig.IntPropertyFn
// Persistence contains the persistence configuration
Persistence *config.Persistence
// ClusterMetadata contains the metadata for this cluster
ClusterMetadata cluster.Metadata
// TaskListScannerEnabled indicates if taskList scanner should be started as part of scanner
TaskListScannerEnabled dynamicconfig.BoolPropertyFn
// HistoryScannerEnabled indicates if history scanner should be started as part of scanner
HistoryScannerEnabled dynamicconfig.BoolPropertyFn
// ConcreteExecutionScannerConfig is the config for concrete execution scanner
ConcreteExecutionScannerConfig *executions.ScannerWorkflowDynamicConfig
// CurrentExecutionScannerConfig is the config for current execution scanner
CurrentExecutionScannerConfig *executions.ScannerWorkflowDynamicConfig
}
// BootstrapParams contains the set of params needed to bootstrap
// the scanner sub-system
BootstrapParams struct {
// Config contains the configuration for scanner
Config Config
// TallyScope is an instance of tally metrics scope
TallyScope tally.Scope
}
// scannerContext is the context object that get's
// passed around within the scanner workflows / activities
scannerContext struct {
resource.Resource
cfg Config
tallyScope tally.Scope
zapLogger *zap.Logger
}
// Scanner is the background sub-system that does full scans
// of database tables to cleanup resources, monitor anamolies
// and emit stats for analytics
Scanner struct {
context scannerContext
}
)
// New returns a new instance of scanner daemon
// Scanner is the background sub-system that does full
// scans of database tables in an attempt to cleanup
// resources, monitor system anamolies and emit stats
// for analysis and alerting
func New(
resource resource.Resource,
params *BootstrapParams,
) *Scanner {
cfg := params.Config
zapLogger, err := zap.NewProduction()
if err != nil {
resource.GetLogger().Fatal("failed to initialize zap logger", tag.Error(err))
}
return &Scanner{
context: scannerContext{
Resource: resource,
cfg: cfg,
tallyScope: params.TallyScope,
zapLogger: zapLogger,
},
}
}
// Start starts the scanner
func (s *Scanner) Start() error {
backgroundActivityContext, taskListNames :=
s.startExecutionWorkflowWithRetry(context.Background(), executions.ConcreteScannerContextKey, executions.ConcreteFixerContextKey,
s.context.cfg.ConcreteExecutionScannerConfig, concreteExecutionsScannerTaskListName, concreteExecutionsFixerTaskListName,
concreteExecutionsScannerWFTypeName, concreteExecutionsScannerWFStartOptions, c.ConcreteExecutionType)
backgroundActivityContext, workerTaskListNames :=
s.startExecutionWorkflowWithRetry(backgroundActivityContext, executions.CurrentScannerContextKey, executions.CurrentFixerContextKey,
s.context.cfg.CurrentExecutionScannerConfig, currentExecutionsScannerTaskListName, currentExecutionsFixerTaskListName,
currentExecutionsScannerWFTypeName, currentExecutionsScannerWFStartOptions, c.CurrentExecutionType)
workerTaskListNames = append(workerTaskListNames, taskListNames...)
workerOpts := worker.Options{
Logger: s.context.zapLogger,
MetricsScope: s.context.tallyScope,
MaxConcurrentActivityExecutionSize: maxConcurrentActivityExecutionSize,
MaxConcurrentDecisionTaskExecutionSize: maxConcurrentDecisionTaskExecutionSize,
BackgroundActivityContext: backgroundActivityContext,
}
if s.context.cfg.Persistence.DefaultStoreType() == config.StoreTypeSQL && s.context.cfg.TaskListScannerEnabled() {
go s.startWorkflowWithRetry(tlScannerWFStartOptions, tlScannerWFTypeName, nil)
workerTaskListNames = append(workerTaskListNames, tlScannerTaskListName)
} else if s.context.cfg.Persistence.DefaultStoreType() == config.StoreTypeCassandra && s.context.cfg.HistoryScannerEnabled() {
go s.startWorkflowWithRetry(historyScannerWFStartOptions, historyScannerWFTypeName, nil)
workerTaskListNames = append(workerTaskListNames, historyScannerTaskListName)
}
for _, tl := range workerTaskListNames {
if err := worker.New(s.context.GetSDKClient(), common.SystemLocalDomainName, tl, workerOpts).Start(); err != nil {
return err
}
}
return nil
}
func (s *Scanner) startExecutionWorkflowWithRetry(parentContext context.Context, scannerContextKey interface{}, fixerContextKey interface{},
executionScannerConfig *executions.ScannerWorkflowDynamicConfig, scannerTaskListName string, fixerTaskListName string,
executionScannerWFTypeName string, startWorkflowOptions cclient.StartWorkflowOptions, scanType c.ScanType) (context.Context, []string) {
backgroundActivityContext := context.WithValue(parentContext, scannerContextKey, s.context)
if executionScannerConfig.Enabled() {
backgroundActivityContext = context.WithValue(backgroundActivityContext, scannerContextKey, executions.ScannerContext{
Resource: s.context.Resource,
Scope: s.context.Resource.GetMetricsClient().Scope(metrics.ExecutionsScannerScope),
ScannerWorkflowDynamicConfig: executionScannerConfig,
})
}
backgroundActivityContext = context.WithValue(backgroundActivityContext, fixerContextKey, executions.FixerContext{
Resource: s.context.Resource,
Scope: s.context.Resource.GetMetricsClient().Scope(metrics.ExecutionsFixerScope),
})
workerTaskListNames := []string{fixerTaskListName}
if executionScannerConfig.Enabled() {
workerTaskListNames = append(workerTaskListNames, scannerTaskListName)
go s.startWorkflowWithRetry(startWorkflowOptions, executionScannerWFTypeName, executions.ScannerWorkflowParams{
Shards: executions.Shards{
Range: &executions.ShardRange{
Min: 0,
Max: s.context.cfg.Persistence.NumHistoryShards,
},
},
ScanType: scanType,
})
}
return backgroundActivityContext, workerTaskListNames
}
func (s *Scanner) startWorkflowWithRetry(
options cclient.StartWorkflowOptions,
workflowType string,
workflowArg interface{},
) {
// let history / matching service warm up
time.Sleep(scannerStartUpDelay)
sdkClient := cclient.NewClient(s.context.GetSDKClient(), common.SystemLocalDomainName, &cclient.Options{})
policy := backoff.NewExponentialRetryPolicy(time.Second)
policy.SetMaximumInterval(time.Minute)
policy.SetExpirationInterval(backoff.NoInterval)
err := backoff.Retry(func() error {
return s.startWorkflow(sdkClient, options, workflowType, workflowArg)
}, policy, func(err error) bool {
return true
})
if err != nil {
s.context.GetLogger().Fatal("unable to start scanner", tag.WorkflowType(workflowType), tag.Error(err))
}
}
func (s *Scanner) startWorkflow(
client cclient.Client,
options cclient.StartWorkflowOptions,
workflowType string,
workflowArg interface{},
) error {
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Minute)
var err error
if workflowArg != nil {
_, err = client.StartWorkflow(ctx, options, workflowType, workflowArg)
} else {
_, err = client.StartWorkflow(ctx, options, workflowType)
}
cancel()
if err != nil {
if _, ok := err.(*shared.WorkflowExecutionAlreadyStartedError); ok {
return nil
}
s.context.GetLogger().Error("error starting "+workflowType+" workflow", tag.Error(err))
return err
}
s.context.GetLogger().Info(workflowType + " workflow successfully started")
return nil
}