-
Notifications
You must be signed in to change notification settings - Fork 823
/
workflow.go
217 lines (194 loc) · 7.37 KB
/
workflow.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
// 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 scanner
import (
"context"
"time"
enumspb "go.temporal.io/api/enums/v1"
"go.temporal.io/sdk/activity"
"go.temporal.io/sdk/client"
"go.temporal.io/sdk/temporal"
"go.temporal.io/sdk/workflow"
"go.temporal.io/server/common/log/tag"
"go.temporal.io/server/service/worker/scanner/executions"
"go.temporal.io/server/service/worker/scanner/history"
"go.temporal.io/server/service/worker/scanner/taskqueue"
)
const (
infiniteDuration = 20 * 365 * 24 * time.Hour
tqScannerWFID = "temporal-sys-tq-scanner"
tqScannerWFTypeName = "temporal-sys-tq-scanner-workflow"
tqScannerTaskQueueName = "temporal-sys-tq-scanner-taskqueue-0"
taskQueueScavengerActivityName = "temporal-sys-tq-scanner-scvg-activity"
historyScannerWFID = "temporal-sys-history-scanner"
historyScannerWFTypeName = "temporal-sys-history-scanner-workflow"
historyScannerTaskQueueName = "temporal-sys-history-scanner-taskqueue-0"
historyScavengerActivityName = "temporal-sys-history-scanner-scvg-activity"
executionsScannerWFID = "temporal-sys-executions-scanner"
executionsScannerWFTypeName = "temporal-sys-executions-scanner-workflow"
executionsScannerTaskQueueName = "temporal-sys-executions-scanner-taskqueue-0"
executionsScavengerActivityName = "temporal-sys-executions-scanner-scvg-activity"
)
type (
scannerContextKeyType struct{}
)
var (
scannerContextKey = scannerContextKeyType{}
tlScavengerHBInterval = 10 * time.Second
executionsScavengerHBInterval = 10 * time.Second
activityRetryPolicy = temporal.RetryPolicy{
InitialInterval: 10 * time.Second,
BackoffCoefficient: 1.7,
MaximumInterval: 5 * time.Minute,
}
activityOptions = workflow.ActivityOptions{
ScheduleToStartTimeout: 5 * time.Minute,
StartToCloseTimeout: infiniteDuration,
HeartbeatTimeout: 5 * time.Minute,
RetryPolicy: &activityRetryPolicy,
}
tlScannerWFStartOptions = client.StartWorkflowOptions{
ID: tqScannerWFID,
TaskQueue: tqScannerTaskQueueName,
WorkflowRunTimeout: 5 * 24 * time.Hour,
WorkflowIDReusePolicy: enumspb.WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE,
CronSchedule: "0 */12 * * *",
}
historyScannerWFStartOptions = client.StartWorkflowOptions{
ID: historyScannerWFID,
TaskQueue: historyScannerTaskQueueName,
WorkflowIDReusePolicy: enumspb.WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE,
CronSchedule: "0 */12 * * *",
}
executionsScannerWFStartOptions = client.StartWorkflowOptions{
ID: executionsScannerWFID,
TaskQueue: executionsScannerTaskQueueName,
WorkflowIDReusePolicy: enumspb.WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE,
CronSchedule: "0 */12 * * *",
}
)
// TaskQueueScannerWorkflow is the workflow that runs the task queue scanner background daemon
func TaskQueueScannerWorkflow(
ctx workflow.Context,
) error {
future := workflow.ExecuteActivity(workflow.WithActivityOptions(ctx, activityOptions), taskQueueScavengerActivityName)
return future.Get(ctx, nil)
}
// HistoryScannerWorkflow is the workflow that runs the history scanner background daemon
func HistoryScannerWorkflow(
ctx workflow.Context,
) error {
future := workflow.ExecuteActivity(
workflow.WithActivityOptions(ctx, activityOptions),
historyScavengerActivityName,
)
return future.Get(ctx, nil)
}
// ExecutionsScannerWorkflow is the workflow that runs the executions scanner background daemon
func ExecutionsScannerWorkflow(
ctx workflow.Context,
) error {
future := workflow.ExecuteActivity(workflow.WithActivityOptions(ctx, activityOptions), executionsScavengerActivityName)
return future.Get(ctx, nil)
}
// HistoryScavengerActivity is the activity that runs history scavenger
func HistoryScavengerActivity(
activityCtx context.Context,
) (history.ScavengerHeartbeatDetails, error) {
ctx := activityCtx.Value(scannerContextKey).(scannerContext)
rps := ctx.cfg.PersistenceMaxQPS()
numShards := ctx.cfg.Persistence.NumHistoryShards
hbd := history.ScavengerHeartbeatDetails{}
if activity.HasHeartbeatDetails(activityCtx) {
if err := activity.GetHeartbeatDetails(activityCtx, &hbd); err != nil {
ctx.logger.Error("Failed to recover from last heartbeat, start over from beginning", tag.Error(err))
}
}
scavenger := history.NewScavenger(
numShards,
ctx.executionManager,
rps,
ctx.historyClient,
ctx.adminClient,
ctx.namespaceRegistry,
hbd,
ctx.cfg.HistoryScannerDataMinAge,
ctx.cfg.ExecutionDataDurationBuffer,
ctx.cfg.HistoryScannerVerifyRetention,
ctx.metricsHandler,
ctx.logger,
)
return scavenger.Run(activityCtx)
}
// TaskQueueScavengerActivity is the activity that runs task queue scavenger
func TaskQueueScavengerActivity(
activityCtx context.Context,
) error {
ctx := activityCtx.Value(scannerContextKey).(scannerContext)
scavenger := taskqueue.NewScavenger(ctx.taskManager, ctx.metricsHandler, ctx.logger)
ctx.logger.Info("Starting task queue scavenger")
scavenger.Start()
for scavenger.Alive() {
activity.RecordHeartbeat(activityCtx)
if activityCtx.Err() != nil {
ctx.logger.Info("activity context error, stopping scavenger", tag.Error(activityCtx.Err()))
scavenger.Stop()
return activityCtx.Err()
}
time.Sleep(tlScavengerHBInterval)
}
return nil
}
// ExecutionsScavengerActivity is the activity that runs executions scavenger
func ExecutionsScavengerActivity(
activityCtx context.Context,
) error {
ctx := activityCtx.Value(scannerContextKey).(scannerContext)
metricsHandler := ctx.metricsHandler
scavenger := executions.NewScavenger(
activityCtx,
ctx.cfg.Persistence.NumHistoryShards,
ctx.cfg.ExecutionScannerPerHostQPS,
ctx.cfg.ExecutionScannerPerShardQPS,
ctx.cfg.ExecutionDataDurationBuffer,
ctx.cfg.ExecutionScannerWorkerCount,
ctx.executionManager,
ctx.namespaceRegistry,
ctx.historyClient,
ctx.adminClient,
metricsHandler,
ctx.logger,
)
scavenger.Start()
for scavenger.Alive() {
activity.RecordHeartbeat(activityCtx)
if activityCtx.Err() != nil {
ctx.logger.Info("activity context error, stopping scavenger", tag.Error(activityCtx.Err()))
scavenger.Stop()
return activityCtx.Err()
}
time.Sleep(executionsScavengerHBInterval)
}
return nil
}