generated from TBD54566975/tbd-project-template
-
Notifications
You must be signed in to change notification settings - Fork 7
/
events.go
425 lines (378 loc) · 12.3 KB
/
events.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
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
package dal
import (
"context"
"encoding/json"
"fmt"
"strconv"
"time"
"github.com/alecthomas/types/optional"
"github.com/jackc/pgx/v5"
"github.com/TBD54566975/ftl/backend/controller/sql"
"github.com/TBD54566975/ftl/backend/schema"
"github.com/TBD54566975/ftl/internal/log"
"github.com/TBD54566975/ftl/internal/model"
)
type EventType = sql.EventType
// Supported event types.
const (
EventTypeLog = sql.EventTypeLog
EventTypeCall = sql.EventTypeCall
EventTypeDeploymentCreated = sql.EventTypeDeploymentCreated
EventTypeDeploymentUpdated = sql.EventTypeDeploymentUpdated
)
// Event types.
//
//sumtype:decl
type Event interface {
GetID() int64
event()
}
type LogEvent struct {
ID int64
DeploymentKey model.DeploymentKey
RequestKey optional.Option[model.RequestKey]
Time time.Time
Level int32
Attributes map[string]string
Message string
Error optional.Option[string]
Stack optional.Option[string]
}
func (e *LogEvent) GetID() int64 { return e.ID }
func (e *LogEvent) event() {}
type CallEvent struct {
ID int64
DeploymentKey model.DeploymentKey
RequestKey optional.Option[model.RequestKey]
Time time.Time
SourceVerb optional.Option[schema.Ref]
DestVerb schema.Ref
Duration time.Duration
Request []byte
Response []byte
Error optional.Option[string]
Stack optional.Option[string]
}
func (e *CallEvent) GetID() int64 { return e.ID }
func (e *CallEvent) event() {}
type DeploymentCreatedEvent struct {
ID int64
DeploymentKey model.DeploymentKey
Time time.Time
Language string
ModuleName string
MinReplicas int
ReplacedDeployment optional.Option[model.DeploymentKey]
}
func (e *DeploymentCreatedEvent) GetID() int64 { return e.ID }
func (e *DeploymentCreatedEvent) event() {}
type DeploymentUpdatedEvent struct {
ID int64
DeploymentKey model.DeploymentKey
Time time.Time
MinReplicas int
PrevMinReplicas int
}
func (e *DeploymentUpdatedEvent) GetID() int64 { return e.ID }
func (e *DeploymentUpdatedEvent) event() {}
type eventFilterCall struct {
sourceModule optional.Option[string]
destModule string
destVerb optional.Option[string]
}
type eventFilter struct {
level *log.Level
calls []*eventFilterCall
types []EventType
deployments []model.DeploymentKey
requests []string
newerThan time.Time
olderThan time.Time
idHigherThan int64
idLowerThan int64
descending bool
}
type EventFilter func(query *eventFilter)
func FilterLogLevel(level log.Level) EventFilter {
return func(query *eventFilter) {
query.level = &level
}
}
// FilterCall filters call events between the given modules.
//
// May be called multiple times.
func FilterCall(sourceModule optional.Option[string], destModule string, destVerb optional.Option[string]) EventFilter {
return func(query *eventFilter) {
query.calls = append(query.calls, &eventFilterCall{sourceModule: sourceModule, destModule: destModule, destVerb: destVerb})
}
}
func FilterDeployments(deploymentKeys ...model.DeploymentKey) EventFilter {
return func(query *eventFilter) {
query.deployments = append(query.deployments, deploymentKeys...)
}
}
func FilterRequests(requestKeys ...model.RequestKey) EventFilter {
return func(query *eventFilter) {
for _, request := range requestKeys {
query.requests = append(query.requests, request.String())
}
}
}
func FilterTypes(types ...sql.EventType) EventFilter {
return func(query *eventFilter) {
query.types = append(query.types, types...)
}
}
// FilterTimeRange filters events between the given times, inclusive.
//
// Either maybe be zero to indicate no upper or lower bound.
func FilterTimeRange(olderThan, newerThan time.Time) EventFilter {
return func(query *eventFilter) {
query.newerThan = newerThan
query.olderThan = olderThan
}
}
// FilterIDRange filters events between the given IDs, inclusive.
func FilterIDRange(higherThan, lowerThan int64) EventFilter {
return func(query *eventFilter) {
query.idHigherThan = higherThan
query.idLowerThan = lowerThan
}
}
// FilterDescending returns events in descending order.
func FilterDescending() EventFilter {
return func(query *eventFilter) {
query.descending = true
}
}
// The internal JSON payload of a call event.
type eventCallJSON struct {
DurationMS int64 `json:"duration_ms"`
Request json.RawMessage `json:"request"`
Response json.RawMessage `json:"response"`
Error optional.Option[string] `json:"error,omitempty"`
Stack optional.Option[string] `json:"stack,omitempty"`
}
type eventLogJSON struct {
Message string `json:"message"`
Attributes map[string]string `json:"attributes"`
Error optional.Option[string] `json:"error,omitempty"`
Stack optional.Option[string] `json:"stack,omitempty"`
}
type eventDeploymentCreatedJSON struct {
MinReplicas int `json:"min_replicas"`
ReplacedDeployment optional.Option[model.DeploymentKey] `json:"replaced,omitempty"`
}
type eventDeploymentUpdatedJSON struct {
MinReplicas int `json:"min_replicas"`
PrevMinReplicas int `json:"prev_min_replicas"`
}
type eventRow struct {
sql.Event
DeploymentKey model.DeploymentKey
RequestKey optional.Option[model.RequestKey]
}
func (d *DAL) QueryEvents(ctx context.Context, limit int, filters ...EventFilter) ([]Event, error) {
if limit < 1 {
return nil, fmt.Errorf("limit must be >= 1, got %d", limit)
}
// Build query.
q := `SELECT e.id AS id,
e.deployment_id,
ir.key AS request_key,
e.time_stamp,
e.custom_key_1,
e.custom_key_2,
e.custom_key_3,
e.custom_key_4,
e.type,
e.payload
FROM events e
LEFT JOIN requests ir on e.request_id = ir.id
WHERE true -- The "true" is to simplify the ANDs below.
`
filter := eventFilter{}
for _, f := range filters {
f(&filter)
}
var args []any
index := 1
param := func(v any) int {
args = append(args, v)
index++
return index - 1
}
if !filter.olderThan.IsZero() {
q += fmt.Sprintf(" AND e.time_stamp <= $%d::TIMESTAMPTZ", param(filter.olderThan))
}
if !filter.newerThan.IsZero() {
q += fmt.Sprintf(" AND e.time_stamp >= $%d::TIMESTAMPTZ", param(filter.newerThan))
}
if filter.idHigherThan != 0 {
q += fmt.Sprintf(" AND e.id >= $%d::BIGINT", param(filter.idHigherThan))
}
if filter.idLowerThan != 0 {
q += fmt.Sprintf(" AND e.id <= $%d::BIGINT", param(filter.idLowerThan))
}
deploymentKeys := map[int64]model.DeploymentKey{}
// TODO: We should probably make it mandatory to provide at least one deployment.
deploymentQuery := `SELECT id, key FROM deployments`
deploymentArgs := []any{}
if len(filter.deployments) != 0 {
// Unfortunately, if we use a join here, PG will do a sequential scan on
// events and deployments, making a 7ms query into a 700ms query.
// https://www.pgexplain.dev/plan/ecd44488-6060-4ad1-a9b4-49d092c3de81
deploymentQuery += ` WHERE key = ANY($1::TEXT[])`
deploymentArgs = append(deploymentArgs, filter.deployments)
}
rows, err := d.db.Conn().Query(ctx, deploymentQuery, deploymentArgs...)
if err != nil {
return nil, translatePGError(err)
}
deploymentIDs := []int64{}
for rows.Next() {
var id int64
var key model.DeploymentKey
if err := rows.Scan(&id, &key); err != nil {
return nil, err
}
deploymentIDs = append(deploymentIDs, id)
deploymentKeys[id] = key
}
q += fmt.Sprintf(` AND e.deployment_id = ANY($%d::BIGINT[])`, param(deploymentIDs))
if filter.requests != nil {
q += fmt.Sprintf(` AND ir.key = ANY($%d::TEXT[])`, param(filter.requests))
}
if filter.types != nil {
// Why are we double casting? Because I hit "cannot find encode plan" and
// this works around it: https://github.com/jackc/pgx/issues/338#issuecomment-333399112
q += fmt.Sprintf(` AND e.type = ANY($%d::text[]::event_type[])`, param(filter.types))
}
if filter.level != nil {
q += fmt.Sprintf(" AND (e.type != 'log' OR (e.type = 'log' AND e.custom_key_1::INT >= $%d::INT))\n", param(*filter.level))
}
if len(filter.calls) > 0 {
q += " AND ("
for i, call := range filter.calls {
if i > 0 {
q += " OR "
}
if sourceModule, ok := call.sourceModule.Get(); ok {
q += fmt.Sprintf("(e.type != 'call' OR (e.type = 'call' AND e.custom_key_1 = $%d AND e.custom_key_3 = $%d))", param(sourceModule), param(call.destModule))
} else if destVerb, ok := call.destVerb.Get(); ok {
q += fmt.Sprintf("(e.type != 'call' OR (e.type = 'call' AND e.custom_key_3 = $%d AND e.custom_key_4 = $%d))", param(call.destModule), param(destVerb))
} else {
q += fmt.Sprintf("(e.type != 'call' OR (e.type = 'call' AND e.custom_key_3 = $%d))", param(call.destModule))
}
}
q += ")\n"
}
if filter.descending {
q += " ORDER BY e.time_stamp DESC, e.id DESC"
} else {
q += " ORDER BY e.time_stamp ASC, e.id ASC"
}
q += fmt.Sprintf(" LIMIT %d", limit)
// Issue query.
rows, err = d.db.Conn().Query(ctx, q, args...)
if err != nil {
return nil, fmt.Errorf("%s: %w", q, translatePGError(err))
}
defer rows.Close()
events, err := transformRowsToEvents(deploymentKeys, rows)
if err != nil {
return nil, err
}
return events, nil
}
func transformRowsToEvents(deploymentKeys map[int64]model.DeploymentKey, rows pgx.Rows) ([]Event, error) {
var out []Event
for rows.Next() {
row := eventRow{}
var deploymentID int64
err := rows.Scan(
&row.ID, &deploymentID, &row.RequestKey, &row.TimeStamp,
&row.CustomKey1, &row.CustomKey2, &row.CustomKey3, &row.CustomKey4,
&row.Type, &row.Payload,
)
if err != nil {
return nil, err
}
row.DeploymentKey = deploymentKeys[deploymentID]
switch row.Type {
case sql.EventTypeLog:
var jsonPayload eventLogJSON
if err := json.Unmarshal(row.Payload, &jsonPayload); err != nil {
return nil, err
}
level, err := strconv.ParseInt(row.CustomKey1.MustGet(), 10, 32)
if err != nil {
return nil, fmt.Errorf("invalid log level: %q: %w", row.CustomKey1.MustGet(), err)
}
out = append(out, &LogEvent{
ID: row.ID,
DeploymentKey: row.DeploymentKey,
RequestKey: row.RequestKey,
Time: row.TimeStamp,
Level: int32(level),
Attributes: jsonPayload.Attributes,
Message: jsonPayload.Message,
Error: jsonPayload.Error,
Stack: jsonPayload.Stack,
})
case sql.EventTypeCall:
var jsonPayload eventCallJSON
if err := json.Unmarshal(row.Payload, &jsonPayload); err != nil {
return nil, err
}
var sourceVerb optional.Option[schema.Ref]
sourceModule, smok := row.CustomKey1.Get()
sourceName, snok := row.CustomKey2.Get()
if smok && snok {
sourceVerb = optional.Some(schema.Ref{Module: sourceModule, Name: sourceName})
}
out = append(out, &CallEvent{
ID: row.ID,
DeploymentKey: row.DeploymentKey,
RequestKey: row.RequestKey,
Time: row.TimeStamp,
SourceVerb: sourceVerb,
DestVerb: schema.Ref{Module: row.CustomKey3.MustGet(), Name: row.CustomKey4.MustGet()},
Duration: time.Duration(jsonPayload.DurationMS) * time.Millisecond,
Request: jsonPayload.Request,
Response: jsonPayload.Response,
Error: jsonPayload.Error,
Stack: jsonPayload.Stack,
})
case sql.EventTypeDeploymentCreated:
var jsonPayload eventDeploymentCreatedJSON
if err := json.Unmarshal(row.Payload, &jsonPayload); err != nil {
return nil, err
}
out = append(out, &DeploymentCreatedEvent{
ID: row.ID,
DeploymentKey: row.DeploymentKey,
Time: row.TimeStamp,
Language: row.CustomKey1.MustGet(),
ModuleName: row.CustomKey2.MustGet(),
MinReplicas: jsonPayload.MinReplicas,
ReplacedDeployment: jsonPayload.ReplacedDeployment,
})
case sql.EventTypeDeploymentUpdated:
var jsonPayload eventDeploymentUpdatedJSON
if err := json.Unmarshal(row.Payload, &jsonPayload); err != nil {
return nil, err
}
out = append(out, &DeploymentUpdatedEvent{
ID: row.ID,
DeploymentKey: row.DeploymentKey,
Time: row.TimeStamp,
MinReplicas: jsonPayload.MinReplicas,
PrevMinReplicas: jsonPayload.PrevMinReplicas,
})
default:
panic("unknown event type: " + row.Type)
}
}
return out, nil
}