-
Notifications
You must be signed in to change notification settings - Fork 770
/
scavenger.go
215 lines (197 loc) · 6.88 KB
/
scavenger.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
// 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 executions
import (
"context"
"sync"
"sync/atomic"
"time"
"go.temporal.io/server/api/adminservice/v1"
"go.temporal.io/server/api/historyservice/v1"
"go.temporal.io/server/common/dynamicconfig"
"go.temporal.io/server/common/log/tag"
"go.temporal.io/server/common/namespace"
"go.temporal.io/server/common/quotas"
"go.temporal.io/server/common"
"go.temporal.io/server/common/log"
"go.temporal.io/server/common/metrics"
"go.temporal.io/server/common/persistence"
"go.temporal.io/server/service/worker/scanner/executor"
)
const (
executorPollInterval = time.Minute
executorMaxDeferredTasks = 50000
)
type (
// Scavenger is the type that holds the state for executions scavenger daemon
Scavenger struct {
status int32
numHistoryShards int32
activityContext context.Context
executionManager persistence.ExecutionManager
registry namespace.Registry
historyClient historyservice.HistoryServiceClient
adminClient adminservice.AdminServiceClient
executor executor.Executor
rateLimiter quotas.RateLimiter
perShardQPS dynamicconfig.IntPropertyFn
executionDataDurationBuffer dynamicconfig.DurationPropertyFn
enableHistoryEventIDValidator dynamicconfig.BoolPropertyFn
metricsHandler metrics.Handler
logger log.Logger
stopC chan struct{}
stopWG sync.WaitGroup
}
)
// NewScavenger returns an instance of executions scavenger daemon
// The Scavenger can be started by calling the Start() method on the
// returned object. Calling the Start() method will result in one
// complete iteration over all of the open workflow executions in the system. For
// each executions, will attempt to validate the workflow execution and emit metrics/logs on validation failures.
//
// The scavenger will retry on all persistence errors infinitely and will only stop under
// two conditions
// - either all executions are processed successfully (or)
// - Stop() method is called to stop the scavenger
func NewScavenger(
activityContext context.Context,
numHistoryShards int32,
perHostQPS dynamicconfig.IntPropertyFn,
perShardQPS dynamicconfig.IntPropertyFn,
executionDataDurationBuffer dynamicconfig.DurationPropertyFn,
executionTaskWorker dynamicconfig.IntPropertyFn,
enableHistoryEventIDValidator dynamicconfig.BoolPropertyFn,
executionManager persistence.ExecutionManager,
registry namespace.Registry,
historyClient historyservice.HistoryServiceClient,
adminClient adminservice.AdminServiceClient,
metricsHandler metrics.Handler,
logger log.Logger,
) *Scavenger {
return &Scavenger{
activityContext: activityContext,
numHistoryShards: numHistoryShards,
executionManager: executionManager,
registry: registry,
historyClient: historyClient,
adminClient: adminClient,
executor: executor.NewFixedSizePoolExecutor(
executionTaskWorker(),
executorMaxDeferredTasks,
metricsHandler,
metrics.ExecutionsScavengerScope,
),
rateLimiter: quotas.NewDefaultOutgoingRateLimiter(
func() float64 { return float64(perHostQPS()) },
),
perShardQPS: perShardQPS,
executionDataDurationBuffer: executionDataDurationBuffer,
enableHistoryEventIDValidator: enableHistoryEventIDValidator,
metricsHandler: metricsHandler.WithTags(metrics.OperationTag(metrics.ExecutionsScavengerScope)),
logger: logger,
stopC: make(chan struct{}),
}
}
// Start starts the scavenger
func (s *Scavenger) Start() {
if !atomic.CompareAndSwapInt32(
&s.status,
common.DaemonStatusInitialized,
common.DaemonStatusStarted,
) {
return
}
s.logger.Info("Executions scavenger starting")
s.stopWG.Add(1)
s.executor.Start()
go s.run()
s.metricsHandler.Counter(metrics.StartedCount.GetMetricName()).Record(1)
s.logger.Info("Executions scavenger started")
}
// Stop stops the scavenger
func (s *Scavenger) Stop() {
if !atomic.CompareAndSwapInt32(
&s.status,
common.DaemonStatusStarted,
common.DaemonStatusStopped,
) {
return
}
s.metricsHandler.Counter(metrics.StoppedCount.GetMetricName()).Record(1)
s.logger.Info("Executions scavenger stopping")
close(s.stopC)
s.executor.Stop()
s.stopWG.Wait()
s.logger.Info("Executions scavenger stopped")
}
// Alive returns true if the scavenger is still running
func (s *Scavenger) Alive() bool {
return atomic.LoadInt32(&s.status) == common.DaemonStatusStarted
}
// run does a single run over all executions and validates them
func (s *Scavenger) run() {
defer func() {
go s.Stop()
s.stopWG.Done()
}()
for shardID := int32(1); shardID <= s.numHistoryShards; shardID++ {
submitted := s.executor.Submit(newTask(
s.activityContext,
shardID,
s.executionManager,
s.registry,
s.historyClient,
s.adminClient,
s.metricsHandler,
s.logger,
s,
quotas.NewMultiRateLimiter([]quotas.RateLimiter{
quotas.NewDefaultOutgoingRateLimiter(
func() float64 { return float64(s.perShardQPS()) },
),
s.rateLimiter,
}),
s.executionDataDurationBuffer,
s.enableHistoryEventIDValidator,
))
if !submitted {
s.logger.Error("unable to submit task to executor", tag.ShardID(shardID))
}
}
s.awaitExecutor()
}
func (s *Scavenger) awaitExecutor() {
// gauge value persists, so we want to reset it to 0
defer s.metricsHandler.Gauge(metrics.ExecutionsOutstandingCount.GetMetricName()).Record(float64(0))
outstanding := s.executor.TaskCount()
for outstanding > 0 {
select {
case <-time.After(executorPollInterval):
outstanding = s.executor.TaskCount()
s.metricsHandler.Gauge(metrics.ExecutionsOutstandingCount.GetMetricName()).Record(float64(outstanding))
case <-s.stopC:
return
}
}
}