This repository has been archived by the owner on Oct 9, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 62
/
task_execution_manager.go
380 lines (335 loc) · 15.3 KB
/
task_execution_manager.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
package impl
import (
"context"
"fmt"
"strconv"
cloudeventInterfaces "github.com/flyteorg/flyteadmin/pkg/async/cloudevent/interfaces"
"github.com/flyteorg/flytestdlib/promutils/labeled"
notificationInterfaces "github.com/flyteorg/flyteadmin/pkg/async/notifications/interfaces"
"github.com/golang/protobuf/proto"
"github.com/flyteorg/flytestdlib/storage"
"github.com/flyteorg/flytestdlib/contextutils"
"github.com/flyteorg/flytestdlib/promutils"
"github.com/prometheus/client_golang/prometheus"
"github.com/flyteorg/flyteadmin/pkg/common"
dataInterfaces "github.com/flyteorg/flyteadmin/pkg/data/interfaces"
"github.com/flyteorg/flyteadmin/pkg/errors"
"github.com/flyteorg/flyteadmin/pkg/manager/impl/util"
"github.com/flyteorg/flyteadmin/pkg/manager/impl/validation"
"github.com/flyteorg/flyteadmin/pkg/manager/interfaces"
repoInterfaces "github.com/flyteorg/flyteadmin/pkg/repositories/interfaces"
"github.com/flyteorg/flyteadmin/pkg/repositories/models"
"github.com/flyteorg/flyteadmin/pkg/repositories/transformers"
runtimeInterfaces "github.com/flyteorg/flyteadmin/pkg/runtime/interfaces"
"github.com/flyteorg/flyteidl/gen/pb-go/flyteidl/admin"
"github.com/flyteorg/flyteidl/gen/pb-go/flyteidl/core"
"github.com/flyteorg/flytestdlib/logger"
"google.golang.org/grpc/codes"
)
type taskExecutionMetrics struct {
Scope promutils.Scope
ActiveTaskExecutions prometheus.Gauge
TaskExecutionsCreated prometheus.Counter
TaskExecutionsTerminated labeled.Counter
TaskExecutionEventsCreated prometheus.Counter
MissingTaskExecution prometheus.Counter
MissingTaskDefinition prometheus.Counter
ClosureSizeBytes prometheus.Summary
TaskExecutionInputBytes prometheus.Summary
TaskExecutionOutputBytes prometheus.Summary
PublishEventError prometheus.Counter
}
type TaskExecutionManager struct {
db repoInterfaces.Repository
config runtimeInterfaces.Configuration
storageClient *storage.DataStore
metrics taskExecutionMetrics
urlData dataInterfaces.RemoteURLInterface
notificationClient notificationInterfaces.Publisher
cloudEventsPublisher cloudeventInterfaces.Publisher
}
func getTaskExecutionContext(ctx context.Context, identifier *core.TaskExecutionIdentifier) context.Context {
ctx = getNodeExecutionContext(ctx, identifier.NodeExecutionId)
return contextutils.WithTaskID(ctx, fmt.Sprintf("%s-%v", identifier.TaskId.Name, identifier.RetryAttempt))
}
func (m *TaskExecutionManager) createTaskExecution(
ctx context.Context, request *admin.TaskExecutionEventRequest) (
models.TaskExecution, error) {
nodeExecutionID := request.Event.ParentNodeExecutionId
nodeExecutionExists, err := m.db.NodeExecutionRepo().Exists(ctx, repoInterfaces.NodeExecutionResource{
NodeExecutionIdentifier: *nodeExecutionID,
})
if err != nil || !nodeExecutionExists {
m.metrics.MissingTaskExecution.Inc()
logger.Debugf(ctx, "Failed to get existing node execution [%+v] with err %v", nodeExecutionID, err)
if err != nil {
if ferr, ok := err.(errors.FlyteAdminError); ok {
return models.TaskExecution{}, errors.NewFlyteAdminErrorf(ferr.Code(),
"Failed to get existing node execution id: [%+v] with err: %v", nodeExecutionID, err)
}
}
return models.TaskExecution{}, fmt.Errorf("failed to get existing node execution id: [%+v]", nodeExecutionID)
}
taskExecutionModel, err := transformers.CreateTaskExecutionModel(
ctx,
transformers.CreateTaskExecutionModelInput{
Request: request,
InlineEventDataPolicy: m.config.ApplicationConfiguration().GetRemoteDataConfig().InlineEventDataPolicy,
StorageClient: m.storageClient,
})
if err != nil {
logger.Debugf(ctx, "failed to transform task execution %+v into database model: %v", request.Event.TaskId, err)
return models.TaskExecution{}, err
}
if err := m.db.TaskExecutionRepo().Create(ctx, *taskExecutionModel); err != nil {
logger.Debugf(ctx, "Failed to create task execution with task id [%+v] with err %v",
request.Event.TaskId, err)
return models.TaskExecution{}, err
}
m.metrics.TaskExecutionsCreated.Inc()
m.metrics.ClosureSizeBytes.Observe(float64(len(taskExecutionModel.Closure)))
logger.Debugf(ctx, "created task execution: %+v", request.Event.TaskId)
return *taskExecutionModel, nil
}
func (m *TaskExecutionManager) updateTaskExecutionModelState(
ctx context.Context, request *admin.TaskExecutionEventRequest, existingTaskExecution *models.TaskExecution) (
models.TaskExecution, error) {
err := transformers.UpdateTaskExecutionModel(ctx, request, existingTaskExecution,
m.config.ApplicationConfiguration().GetRemoteDataConfig().InlineEventDataPolicy, m.storageClient)
if err != nil {
logger.Debugf(ctx, "failed to update task execution model [%+v] with err: %v", request.Event.TaskId, err)
return models.TaskExecution{}, err
}
err = m.db.TaskExecutionRepo().Update(ctx, *existingTaskExecution)
if err != nil {
logger.Debugf(ctx, "Failed to update task execution with task id [%+v] and task execution model [%+v] with err %v",
request.Event.TaskId, existingTaskExecution, err)
return models.TaskExecution{}, err
}
return *existingTaskExecution, nil
}
func (m *TaskExecutionManager) CreateTaskExecutionEvent(ctx context.Context, request admin.TaskExecutionEventRequest) (
*admin.TaskExecutionEventResponse, error) {
if err := validation.ValidateTaskExecutionRequest(request, m.config.ApplicationConfiguration().GetRemoteDataConfig().MaxSizeInBytes); err != nil {
return nil, err
}
if err := validation.ValidateClusterForExecutionID(ctx, m.db, request.Event.ParentNodeExecutionId.ExecutionId, request.Event.ProducerId); err != nil {
return nil, err
}
// Get the parent node execution, if none found a MissingEntityError will be returned
nodeExecutionID := request.Event.ParentNodeExecutionId
taskExecutionID := core.TaskExecutionIdentifier{
TaskId: request.Event.TaskId,
NodeExecutionId: nodeExecutionID,
RetryAttempt: request.Event.RetryAttempt,
}
ctx = getTaskExecutionContext(ctx, &taskExecutionID)
logger.Debugf(ctx, "Received task execution event for [%+v] transitioning to phase [%v]",
taskExecutionID, request.Event.Phase)
// See if the task execution exists
// - if it does check if the new phase is applicable and then update
// - if it doesn't, create a task execution
taskExecutionModel, err := m.db.TaskExecutionRepo().Get(ctx, repoInterfaces.GetTaskExecutionInput{
TaskExecutionID: taskExecutionID,
})
if err != nil {
if err.(errors.FlyteAdminError).Code() != codes.NotFound {
logger.Debugf(ctx, "Failed to find existing task execution [%+v] with err %v", taskExecutionID, err)
return nil, err
}
_, err := m.createTaskExecution(ctx, &request)
if err != nil {
return nil, err
}
return &admin.TaskExecutionEventResponse{}, nil
}
if taskExecutionModel.Phase == request.Event.Phase.String() &&
taskExecutionModel.PhaseVersion >= request.Event.PhaseVersion {
logger.Debugf(ctx, "have already recorded task execution phase %s (version: %d) for %v",
request.Event.Phase.String(), request.Event.PhaseVersion, taskExecutionID)
return nil, errors.NewFlyteAdminErrorf(codes.AlreadyExists,
"have already recorded task execution phase %s (version: %d) for %v",
request.Event.Phase.String(), request.Event.PhaseVersion, taskExecutionID)
}
currentPhase := core.TaskExecution_Phase(core.TaskExecution_Phase_value[taskExecutionModel.Phase])
if common.IsTaskExecutionTerminal(currentPhase) {
// Cannot update a terminal execution.
curPhase := request.Event.Phase.String()
errorMsg := fmt.Sprintf("invalid phase change from %v to %v for task execution %v", taskExecutionModel.Phase, request.Event.Phase, taskExecutionID)
logger.Warnf(ctx, errorMsg)
return nil, errors.NewAlreadyInTerminalStateError(ctx, errorMsg, curPhase)
}
taskExecutionModel, err = m.updateTaskExecutionModelState(ctx, &request, &taskExecutionModel)
if err != nil {
logger.Debugf(ctx, "Failed to update task execution with id [%+v] with err %v",
taskExecutionID, err)
return nil, err
}
if request.Event.Phase == core.TaskExecution_RUNNING && request.Event.PhaseVersion == 0 {
m.metrics.ActiveTaskExecutions.Inc()
} else if common.IsTaskExecutionTerminal(request.Event.Phase) && request.Event.PhaseVersion == 0 {
m.metrics.ActiveTaskExecutions.Dec()
m.metrics.TaskExecutionsTerminated.Inc(contextutils.WithPhase(ctx, request.Event.Phase.String()))
if request.Event.GetOutputData() != nil {
m.metrics.TaskExecutionOutputBytes.Observe(float64(proto.Size(request.Event.GetOutputData())))
}
}
if err = m.notificationClient.Publish(ctx, proto.MessageName(&request), &request); err != nil {
m.metrics.PublishEventError.Inc()
logger.Infof(ctx, "error publishing event [%+v] with err: [%v]", request.RequestId, err)
}
go func() {
if err := m.cloudEventsPublisher.Publish(ctx, proto.MessageName(&request), &request); err != nil {
logger.Infof(ctx, "error publishing cloud event [%+v] with err: [%v]", request.RequestId, err)
}
}()
m.metrics.TaskExecutionEventsCreated.Inc()
logger.Debugf(ctx, "Successfully recorded task execution event [%v]", request.Event)
// TODO: we will want to return some scope information here soon!
return &admin.TaskExecutionEventResponse{}, nil
}
func (m *TaskExecutionManager) GetTaskExecution(
ctx context.Context, request admin.TaskExecutionGetRequest) (*admin.TaskExecution, error) {
err := validation.ValidateTaskExecutionIdentifier(request.Id)
if err != nil {
logger.Debugf(ctx, "Failed to validate GetTaskExecution [%+v] with err: %v", request.Id, err)
return nil, err
}
ctx = getTaskExecutionContext(ctx, request.Id)
taskExecutionModel, err := util.GetTaskExecutionModel(ctx, m.db, request.Id)
if err != nil {
return nil, err
}
taskExecution, err := transformers.FromTaskExecutionModel(*taskExecutionModel, transformers.DefaultExecutionTransformerOptions)
if err != nil {
logger.Debugf(ctx, "Failed to transform task execution model [%+v] to proto: %v", request.Id, err)
return nil, err
}
return taskExecution, nil
}
func (m *TaskExecutionManager) ListTaskExecutions(
ctx context.Context, request admin.TaskExecutionListRequest) (*admin.TaskExecutionList, error) {
if err := validation.ValidateTaskExecutionListRequest(request); err != nil {
logger.Debugf(ctx, "ListTaskExecutions request [%+v] is invalid: %v", request, err)
return nil, err
}
ctx = getNodeExecutionContext(ctx, request.NodeExecutionId)
identifierFilters, err := util.GetNodeExecutionIdentifierFilters(ctx, *request.NodeExecutionId)
if err != nil {
return nil, err
}
filters, err := util.AddRequestFilters(request.Filters, common.TaskExecution, identifierFilters)
if err != nil {
return nil, err
}
var sortParameter common.SortParameter
if request.SortBy != nil {
sortParameter, err = common.NewSortParameter(*request.SortBy)
if err != nil {
return nil, err
}
}
offset, err := validation.ValidateToken(request.Token)
if err != nil {
return nil, errors.NewFlyteAdminErrorf(codes.InvalidArgument,
"invalid pagination token %s for ListTaskExecutions", request.Token)
}
output, err := m.db.TaskExecutionRepo().List(ctx, repoInterfaces.ListResourceInput{
InlineFilters: filters,
Offset: offset,
Limit: int(request.Limit),
SortParameter: sortParameter,
})
if err != nil {
logger.Debugf(ctx, "Failed to list task executions with request [%+v] with err %v",
request, err)
return nil, err
}
taskExecutionList, err := transformers.FromTaskExecutionModels(output.TaskExecutions, transformers.ListExecutionTransformerOptions)
if err != nil {
logger.Debugf(ctx, "failed to transform task execution models for request [%+v] with err: %v", request, err)
return nil, err
}
var token string
if len(taskExecutionList) == int(request.Limit) {
token = strconv.Itoa(offset + len(taskExecutionList))
}
return &admin.TaskExecutionList{
TaskExecutions: taskExecutionList,
Token: token,
}, nil
}
func (m *TaskExecutionManager) GetTaskExecutionData(
ctx context.Context, request admin.TaskExecutionGetDataRequest) (*admin.TaskExecutionGetDataResponse, error) {
if err := validation.ValidateTaskExecutionIdentifier(request.Id); err != nil {
logger.Debugf(ctx, "Invalid identifier [%+v]: %v", request.Id, err)
}
ctx = getTaskExecutionContext(ctx, request.Id)
taskExecution, err := m.GetTaskExecution(ctx, admin.TaskExecutionGetRequest{
Id: request.Id,
})
if err != nil {
logger.Debugf(ctx, "Failed to get task execution with id [%+v] with err %v",
request.Id, err)
return nil, err
}
inputs, inputURLBlob, err := util.GetInputs(ctx, m.urlData, m.config.ApplicationConfiguration().GetRemoteDataConfig(),
m.storageClient, taskExecution.InputUri)
if err != nil {
return nil, err
}
outputs, outputURLBlob, err := util.GetOutputs(ctx, m.urlData, m.config.ApplicationConfiguration().GetRemoteDataConfig(),
m.storageClient, taskExecution.Closure)
if err != nil {
return nil, err
}
response := &admin.TaskExecutionGetDataResponse{
Inputs: inputURLBlob,
Outputs: outputURLBlob,
FullInputs: inputs,
FullOutputs: outputs,
}
m.metrics.TaskExecutionInputBytes.Observe(float64(response.Inputs.Bytes))
if response.Outputs.Bytes > 0 {
m.metrics.TaskExecutionOutputBytes.Observe(float64(response.Outputs.Bytes))
} else if response.FullOutputs != nil {
m.metrics.TaskExecutionOutputBytes.Observe(float64(proto.Size(response.FullOutputs)))
}
return response, nil
}
func NewTaskExecutionManager(db repoInterfaces.Repository, config runtimeInterfaces.Configuration,
storageClient *storage.DataStore, scope promutils.Scope, urlData dataInterfaces.RemoteURLInterface,
publisher notificationInterfaces.Publisher, cloudEventsPublisher cloudeventInterfaces.Publisher) interfaces.TaskExecutionInterface {
metrics := taskExecutionMetrics{
Scope: scope,
ActiveTaskExecutions: scope.MustNewGauge("active_executions",
"overall count of active task executions"),
MissingTaskExecution: scope.MustNewCounter("missing_node_execution",
"overall count of task execution events received that are missing a parent node execution"),
TaskExecutionsCreated: scope.MustNewCounter("task_executions_created",
"overall count of successfully completed CreateExecutionRequests"),
TaskExecutionsTerminated: labeled.NewCounter("task_executions_terminated",
"overall count of terminated workflow executions", scope),
TaskExecutionEventsCreated: scope.MustNewCounter("task_execution_events_created",
"overall count of successfully completed WorkflowExecutionEventRequest"),
MissingTaskDefinition: scope.MustNewCounter("missing_task_definition",
"overall count of task execution events received that are missing a task definition"),
ClosureSizeBytes: scope.MustNewSummary("closure_size_bytes",
"size in bytes of serialized task execution closure"),
TaskExecutionInputBytes: scope.MustNewSummary("input_size_bytes",
"size in bytes of serialized node execution inputs"),
TaskExecutionOutputBytes: scope.MustNewSummary("output_size_bytes",
"size in bytes of serialized node execution outputs"),
PublishEventError: scope.MustNewCounter("publish_event_error",
"overall count of publish event errors when invoking publish()"),
}
return &TaskExecutionManager{
db: db,
config: config,
storageClient: storageClient,
metrics: metrics,
urlData: urlData,
notificationClient: publisher,
cloudEventsPublisher: cloudEventsPublisher,
}
}