-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Expand file tree
/
Copy pathLogsListPresenter.server.ts
More file actions
604 lines (536 loc) · 18.1 KB
/
LogsListPresenter.server.ts
File metadata and controls
604 lines (536 loc) · 18.1 KB
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
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
import { z } from "zod";
import { type ClickHouse, type LogsListResult } from "@internal/clickhouse";
import { MachinePresetName } from "@trigger.dev/core/v3";
import {
type PrismaClient,
type PrismaClientOrTransaction,
type TaskRunStatus,
TaskRunStatus as TaskRunStatusEnum,
TaskTriggerSource,
} from "@trigger.dev/database";
import { getConfiguredEventRepository } from "~/v3/eventRepository/index.server";
// Create a schema that validates TaskRunStatus enum values
const TaskRunStatusSchema = z.array(z.nativeEnum(TaskRunStatusEnum));
import parseDuration from "parse-duration";
import { type Direction } from "~/components/ListPagination";
import { timeFilters } from "~/components/runs/v3/SharedFilters";
import { findDisplayableEnvironment } from "~/models/runtimeEnvironment.server";
import { getAllTaskIdentifiers } from "~/models/task.server";
import { RunsRepository } from "~/services/runsRepository/runsRepository.server";
import { ServiceValidationError } from "~/v3/services/baseService.server";
import { kindToLevel, type LogLevel, LogLevelSchema } from "~/utils/logUtils";
import { BasePresenter } from "~/presenters/v3/basePresenter.server";
import {
convertDateToClickhouseDateTime,
convertClickhouseDateTime64ToJsDate,
} from "~/v3/eventRepository/clickhouseEventRepository.server";
export type { LogLevel };
type ErrorAttributes = {
error?: {
message?: unknown;
};
[key: string]: unknown;
};
export type LogsListOptions = {
userId?: string;
projectId: string;
// filters
tasks?: string[];
versions?: string[];
statuses?: TaskRunStatus[];
tags?: string[];
scheduleId?: string;
period?: string;
bulkId?: string;
from?: number;
to?: number;
isTest?: boolean;
rootOnly?: boolean;
batchId?: string;
runId?: string[];
queues?: string[];
machines?: MachinePresetName[];
levels?: LogLevel[];
defaultPeriod?: string;
// search
search?: string;
includeDebugLogs?: boolean;
// pagination
direction?: Direction;
cursor?: string;
pageSize?: number;
};
export const LogsListOptionsSchema = z.object({
userId: z.string().optional(),
projectId: z.string(),
tasks: z.array(z.string()).optional(),
versions: z.array(z.string()).optional(),
statuses: TaskRunStatusSchema.optional(),
tags: z.array(z.string()).optional(),
scheduleId: z.string().optional(),
period: z.string().optional(),
bulkId: z.string().optional(),
from: z.number().int().nonnegative().optional(),
to: z.number().int().nonnegative().optional(),
isTest: z.boolean().optional(),
rootOnly: z.boolean().optional(),
batchId: z.string().optional(),
runId: z.array(z.string()).optional(),
queues: z.array(z.string()).optional(),
machines: z.array(MachinePresetName).optional(),
levels: z.array(LogLevelSchema).optional(),
defaultPeriod: z.string().optional(),
search: z.string().max(1000).optional(),
includeDebugLogs: z.boolean().optional(),
direction: z.enum(["forward", "backward"]).optional(),
cursor: z.string().optional(),
pageSize: z.number().int().positive().max(1000).optional(),
});
const DEFAULT_PAGE_SIZE = 50;
const MAX_RUN_IDS = 5000;
export type LogsList = Awaited<ReturnType<LogsListPresenter["call"]>>;
export type LogEntry = LogsList["logs"][0];
export type LogsListAppliedFilters = LogsList["filters"];
// Cursor is a base64 encoded JSON of the pagination keys
type LogCursor = {
startTime: string;
traceId: string;
spanId: string;
runId: string;
};
const LogCursorSchema = z.object({
startTime: z.string(),
traceId: z.string(),
spanId: z.string(),
runId: z.string(),
});
function encodeCursor(cursor: LogCursor): string {
return Buffer.from(JSON.stringify(cursor)).toString("base64");
}
function decodeCursor(cursor: string): LogCursor | null {
try {
const decoded = Buffer.from(cursor, "base64").toString("utf-8");
const parsed = JSON.parse(decoded);
const validated = LogCursorSchema.safeParse(parsed);
if (!validated.success) {
return null;
}
return validated.data;
} catch {
return null;
}
}
// Convert display level to ClickHouse kinds and statuses
function levelToKindsAndStatuses(level: LogLevel): { kinds?: string[]; statuses?: string[] } {
switch (level) {
case "DEBUG":
return { kinds: ["DEBUG_EVENT", "LOG_DEBUG"] };
case "INFO":
return { kinds: ["LOG_INFO", "LOG_LOG"] };
case "WARN":
return { kinds: ["LOG_WARN"] };
case "ERROR":
return { kinds: ["LOG_ERROR"], statuses: ["ERROR"] };
case "CANCELLED":
return { statuses: ["CANCELLED"] };
case "TRACE":
return { kinds: ["SPAN", "ANCESTOR_OVERRIDE", "SPAN_EVENT"] };
}
}
function convertDateToNanoseconds(date: Date): bigint {
return BigInt(date.getTime()) * 1_000_000n;
}
function formatNanosecondsForClickhouse(ns: bigint): string {
const nsString = ns.toString();
// Handle negative numbers (dates before 1970-01-01)
if (nsString.startsWith("-")) {
const absString = nsString.slice(1);
const padded = absString.padStart(19, "0");
return "-" + padded.slice(0, 10) + "." + padded.slice(10);
}
// Pad positive numbers to 19 digits to ensure correct slicing
const padded = nsString.padStart(19, "0");
return padded.slice(0, 10) + "." + padded.slice(10);
}
export class LogsListPresenter extends BasePresenter {
constructor(
private readonly replica: PrismaClientOrTransaction,
private readonly clickhouse: ClickHouse
) {
super();
}
public async call(
organizationId: string,
environmentId: string,
{
userId,
projectId,
tasks,
versions,
statuses,
tags,
scheduleId,
period,
bulkId,
isTest,
rootOnly,
batchId,
runId,
queues,
machines,
levels,
search,
from,
to,
cursor,
pageSize = DEFAULT_PAGE_SIZE,
includeDebugLogs = true,
defaultPeriod,
}: LogsListOptions
) {
const time = timeFilters({
period,
from,
to,
defaultPeriod,
});
let effectiveFrom = time.from;
let effectiveTo = time.to;
if (!effectiveFrom && !effectiveTo && time.period) {
const periodMs = parseDuration(time.period);
if (periodMs) {
effectiveFrom = new Date(Date.now() - periodMs);
effectiveTo = new Date();
}
}
const hasStatusFilters = statuses && statuses.length > 0;
const hasRunLevelFilters =
(versions !== undefined && versions.length > 0) ||
hasStatusFilters ||
(bulkId !== undefined && bulkId !== "") ||
(scheduleId !== undefined && scheduleId !== "") ||
(tags !== undefined && tags.length > 0) ||
batchId !== undefined ||
(runId !== undefined && runId.length > 0) ||
(queues !== undefined && queues.length > 0) ||
(machines !== undefined && machines.length > 0) ||
typeof isTest === "boolean" ||
rootOnly === true;
const hasFilters =
(tasks !== undefined && tasks.length > 0) ||
hasRunLevelFilters ||
(levels !== undefined && levels.length > 0) ||
(search !== undefined && search !== "") ||
!time.isDefault;
const possibleTasksAsync = getAllTaskIdentifiers(this.replica, environmentId);
const bulkActionsAsync = this.replica.bulkActionGroup.findMany({
select: {
friendlyId: true,
type: true,
createdAt: true,
name: true,
},
where: {
projectId: projectId,
environmentId,
},
orderBy: {
createdAt: "desc",
},
take: 20,
});
const [possibleTasks, bulkActions, displayableEnvironment] = await Promise.all([
possibleTasksAsync,
bulkActionsAsync,
findDisplayableEnvironment(environmentId, userId),
]);
if (bulkId && !bulkActions.some((bulkAction) => bulkAction.friendlyId === bulkId)) {
const selectedBulkAction = await this.replica.bulkActionGroup.findFirst({
select: {
friendlyId: true,
type: true,
createdAt: true,
name: true,
},
where: {
friendlyId: bulkId,
projectId,
environmentId,
},
});
if (selectedBulkAction) {
bulkActions.push(selectedBulkAction);
}
}
if (!displayableEnvironment) {
throw new ServiceValidationError("No environment found");
}
// If we have run-level filters, we need to first get matching run IDs from Postgres
let runIds: string[] | undefined;
if (hasRunLevelFilters) {
const runsRepository = new RunsRepository({
clickhouse: this.clickhouse,
prisma: this.replica,
});
function clampToNow(date: Date): Date {
const now = new Date();
return date > now ? now : date;
}
runIds = await runsRepository.listFriendlyRunIds({
organizationId,
environmentId,
projectId,
tasks,
versions,
statuses,
tags,
scheduleId,
period,
from: effectiveFrom ? effectiveFrom.getTime() : undefined,
to: effectiveTo ? clampToNow(effectiveTo).getTime() : undefined,
isTest,
rootOnly,
batchId,
runId,
bulkId,
queues,
machines,
page: {
size: MAX_RUN_IDS,
direction: "forward",
},
});
if (runIds.length === 0) {
return {
logs: [],
pagination: {
next: undefined,
previous: undefined,
},
possibleTasks: possibleTasks
.map((task) => ({
slug: task.slug,
triggerSource: task.triggerSource,
}))
.sort((a, b) => a.slug.localeCompare(b.slug)),
bulkActions: bulkActions.map((bulkAction) => ({
id: bulkAction.friendlyId,
type: bulkAction.type,
createdAt: bulkAction.createdAt,
name: bulkAction.name || bulkAction.friendlyId,
})),
filters: {
tasks: tasks || [],
versions: versions || [],
statuses: statuses || [],
levels: levels || [],
from: effectiveFrom,
to: effectiveTo,
},
hasFilters,
hasAnyLogs: false,
searchTerm: search,
};
}
}
// Determine which store to use based on organization configuration
const { store } = await getConfiguredEventRepository(organizationId);
// Throw error if postgres is detected
if (store === "postgres") {
throw new ServiceValidationError(
"Logs are not available for PostgreSQL event store. Please contact support."
);
}
// Get the appropriate query builder based on store type
const isClickhouseV2 = store === "clickhouse_v2";
const queryBuilder = isClickhouseV2
? this.clickhouse.taskEventsV2.logsListQueryBuilder()
: this.clickhouse.taskEvents.logsListQueryBuilder();
queryBuilder.prewhere("environment_id = {environmentId: String}", {
environmentId,
});
queryBuilder.where("organization_id = {organizationId: String}", {
organizationId,
});
queryBuilder.where("project_id = {projectId: String}", { projectId });
// Time filters - inserted_at in PREWHERE only for v2, start_time in WHERE for both
if (effectiveFrom) {
const fromNs = convertDateToNanoseconds(effectiveFrom);
// Only use inserted_at for partition pruning if v2
if (isClickhouseV2) {
queryBuilder.prewhere("inserted_at >= {insertedAtStart: DateTime64(3)}", {
insertedAtStart: convertDateToClickhouseDateTime(effectiveFrom),
});
}
queryBuilder.where("start_time >= {fromTime: String}", {
fromTime: formatNanosecondsForClickhouse(fromNs),
});
}
if (effectiveTo) {
const clampedTo = effectiveTo > new Date() ? new Date() : effectiveTo;
const toNs = convertDateToNanoseconds(clampedTo);
// Only use inserted_at for partition pruning if v2
if (isClickhouseV2) {
queryBuilder.prewhere("inserted_at <= {insertedAtEnd: DateTime64(3)}", {
insertedAtEnd: convertDateToClickhouseDateTime(clampedTo),
});
}
queryBuilder.where("start_time <= {toTime: String}", {
toTime: formatNanosecondsForClickhouse(toNs),
});
}
// Task filter (applies directly to ClickHouse)
if (tasks && tasks.length > 0) {
queryBuilder.where("task_identifier IN {tasks: Array(String)}", {
tasks,
});
}
// Run IDs filter (from Postgres lookup)
if (runIds && runIds.length > 0) {
queryBuilder.where("run_id IN {runIds: Array(String)}", { runIds });
}
// Case-insensitive search in message, attributes, and status fields
if (search && search.trim() !== "") {
const searchTerm = search.trim();
queryBuilder.where(
"(message ilike {searchPattern: String} OR attributes_text ilike {searchPattern: String} OR status = {statusTerm: String})",
{
searchPattern: `%${searchTerm}%`,
statusTerm: searchTerm.toUpperCase(),
}
);
}
if (levels && levels.length > 0) {
const conditions: string[] = [];
const params: Record<string, string[]> = {};
const hasErrorOrCancelledLevel = levels.includes("ERROR") || levels.includes("CANCELLED");
for (const level of levels) {
const filter = levelToKindsAndStatuses(level);
const levelConditions: string[] = [];
if (filter.kinds && filter.kinds.length > 0) {
const kindsKey = `kinds_${level}`;
let kindCondition = `kind IN {${kindsKey}: Array(String)}`;
// For TRACE: exclude error/cancelled traces if ERROR/CANCELLED not explicitly selected
if (level === "TRACE" && !hasErrorOrCancelledLevel) {
kindCondition += ` AND status NOT IN {excluded_statuses: Array(String)}`;
params["excluded_statuses"] = ["ERROR", "CANCELLED"];
}
levelConditions.push(kindCondition);
params[kindsKey] = filter.kinds;
}
if (filter.statuses && filter.statuses.length > 0) {
const statusesKey = `statuses_${level}`;
levelConditions.push(`status IN {${statusesKey}: Array(String)}`);
params[statusesKey] = filter.statuses;
}
if (levelConditions.length > 0) {
conditions.push(`(${levelConditions.join(" OR ")})`);
}
}
if (conditions.length > 0) {
queryBuilder.where(`(${conditions.join(" OR ")})`, params);
}
}
// Debug logs are available only to admins
if (includeDebugLogs === false) {
queryBuilder.where("kind NOT IN {debugKinds: Array(String)}", {
debugKinds: ["DEBUG_EVENT", "LOG_DEBUG"],
});
}
queryBuilder.where("NOT (kind = 'SPAN' AND status = 'PARTIAL')");
// Cursor pagination
const decodedCursor = cursor ? decodeCursor(cursor) : null;
if (decodedCursor) {
queryBuilder.where(
"(start_time, trace_id, span_id, run_id) < ({cursorStartTime: String}, {cursorTraceId: String}, {cursorSpanId: String}, {cursorRunId: String})",
{
cursorStartTime: decodedCursor.startTime,
cursorTraceId: decodedCursor.traceId,
cursorSpanId: decodedCursor.spanId,
cursorRunId: decodedCursor.runId,
}
);
}
queryBuilder.orderBy("start_time DESC, trace_id DESC, span_id DESC, run_id DESC");
// Limit + 1 to check if there are more results
queryBuilder.limit(pageSize + 1);
const [queryError, records] = await queryBuilder.execute();
if (queryError) {
throw queryError;
}
const results = records || [];
const hasMore = results.length > pageSize;
const logs = results.slice(0, pageSize);
// Build next cursor from the last item
let nextCursor: string | undefined;
if (hasMore && logs.length > 0) {
const lastLog = logs[logs.length - 1];
nextCursor = encodeCursor({
startTime: lastLog.start_time,
traceId: lastLog.trace_id,
spanId: lastLog.span_id,
runId: lastLog.run_id,
});
}
// Transform results
// Use :: as separator since dash conflicts with date format in start_time
const transformedLogs = logs.map((log) => {
let displayMessage = log.message;
// For error logs with status ERROR, try to extract error message from attributes
if (log.status === "ERROR" && log.attributes_text) {
try {
const attributes = JSON.parse(log.attributes_text) as ErrorAttributes;
if (attributes?.error?.message && typeof attributes.error.message === "string") {
displayMessage = attributes.error.message;
}
} catch {
// If attributes parsing fails, use the regular message
}
}
return {
id: `${log.trace_id}::${log.span_id}::${log.run_id}::${log.start_time}`,
runId: log.run_id,
taskIdentifier: log.task_identifier,
startTime: convertClickhouseDateTime64ToJsDate(log.start_time).toISOString(),
traceId: log.trace_id,
spanId: log.span_id,
parentSpanId: log.parent_span_id || null,
message: displayMessage,
kind: log.kind,
status: log.status,
duration: typeof log.duration === "number" ? log.duration : Number(log.duration),
level: kindToLevel(log.kind, log.status),
};
});
return {
logs: transformedLogs,
pagination: {
next: nextCursor,
previous: undefined, // For now, only support forward pagination
},
possibleTasks: possibleTasks
.map((task) => ({
slug: task.slug,
triggerSource: task.triggerSource,
}))
.sort((a, b) => a.slug.localeCompare(b.slug)),
bulkActions: bulkActions.map((bulkAction) => ({
id: bulkAction.friendlyId,
type: bulkAction.type,
createdAt: bulkAction.createdAt,
name: bulkAction.name || bulkAction.friendlyId,
})),
filters: {
tasks: tasks || [],
versions: versions || [],
statuses: statuses || [],
levels: levels || [],
from: effectiveFrom,
to: effectiveTo,
},
hasFilters,
hasAnyLogs: transformedLogs.length > 0,
searchTerm: search,
};
}
}