-
-
Notifications
You must be signed in to change notification settings - Fork 80.8k
Expand file tree
/
Copy pathlog-tail.ts
More file actions
176 lines (161 loc) · 4.88 KB
/
Copy pathlog-tail.ts
File metadata and controls
176 lines (161 loc) · 4.88 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
// Log tail helpers read recent log lines with optional parsing and redaction.
import fs from "node:fs/promises";
import path from "node:path";
import { getResolvedLoggerSettings } from "../logging.js";
import { clamp } from "../utils.js";
import { redactSensitiveLines, resolveRedactOptions } from "./redact.js";
// Tail reader for the active log file, with cursor reset and line redaction.
const DEFAULT_LIMIT = 500;
const DEFAULT_MAX_BYTES = 250_000;
const MAX_LIMIT = 5000;
const MAX_BYTES = 1_000_000;
const ROLLING_LOG_RE = /^openclaw-\d{4}-\d{2}-\d{2}\.log$/;
/** Payload returned to log-tail callers with cursor and truncation metadata. */
export type LogTailPayload = {
file: string;
cursor: number;
size: number;
lines: string[];
truncated: boolean;
reset: boolean;
};
function isRollingLogFile(file: string): boolean {
return ROLLING_LOG_RE.test(path.basename(file));
}
/** Resolves a rolling daily log path to the newest existing rolling log when needed. */
export async function resolveLogFile(file: string): Promise<string> {
const stat = await fs.stat(file).catch(() => null);
if (stat) {
return file;
}
if (!isRollingLogFile(file)) {
return file;
}
const dir = path.dirname(file);
const entries = await fs.readdir(dir, { withFileTypes: true }).catch(() => null);
if (!entries) {
return file;
}
const candidates = await Promise.all(
entries
.filter((entry) => entry.isFile() && ROLLING_LOG_RE.test(entry.name))
.map(async (entry) => {
const fullPath = path.join(dir, entry.name);
const fileStat = await fs.stat(fullPath).catch(() => null);
return fileStat ? { path: fullPath, mtimeMs: fileStat.mtimeMs } : null;
}),
);
const sorted = candidates
.filter((entry): entry is NonNullable<typeof entry> => Boolean(entry))
.toSorted((a, b) => b.mtimeMs - a.mtimeMs);
return sorted[0]?.path ?? file;
}
async function readLogSlice(params: {
file: string;
cursor?: number;
limit: number;
maxBytes: number;
}): Promise<Omit<LogTailPayload, "file">> {
const stat = await fs.stat(params.file).catch(() => null);
if (!stat) {
return {
cursor: 0,
size: 0,
lines: [],
truncated: false,
reset: false,
};
}
const size = stat.size;
const maxBytes = clamp(params.maxBytes, 1, MAX_BYTES);
const limit = clamp(params.limit, 1, MAX_LIMIT);
let cursor =
typeof params.cursor === "number" && Number.isFinite(params.cursor)
? Math.max(0, Math.floor(params.cursor))
: undefined;
let reset = false;
let truncated = false;
let start;
if (cursor != null) {
if (cursor > size) {
// File rotated or shrank since the previous cursor; restart near the end.
reset = true;
start = Math.max(0, size - maxBytes);
truncated = start > 0;
} else {
start = cursor;
if (size - start > maxBytes) {
// Cursor is valid but too stale; cap reads and tell the caller state was reset.
reset = true;
truncated = true;
start = Math.max(0, size - maxBytes);
}
}
} else {
start = Math.max(0, size - maxBytes);
truncated = start > 0;
}
if (size === 0 || size <= start) {
return {
cursor: size,
size,
lines: [],
truncated,
reset,
};
}
const handle = await fs.open(params.file, "r");
try {
let prefix = "";
if (start > 0) {
const prefixBuf = Buffer.alloc(1);
const prefixRead = await handle.read(prefixBuf, 0, 1, start - 1);
prefix = prefixBuf.toString("utf8", 0, prefixRead.bytesRead);
}
const length = Math.max(0, size - start);
const buffer = Buffer.alloc(length);
const readResult = await handle.read(buffer, 0, length, start);
const text = buffer.toString("utf8", 0, readResult.bytesRead);
let lines = text.split("\n");
if (start > 0 && prefix !== "\n") {
// Drop the first partial line when starting in the middle of a file.
lines = lines.slice(1);
}
if (lines.length > 0 && lines[lines.length - 1] === "") {
lines = lines.slice(0, -1);
}
if (lines.length > limit) {
lines = lines.slice(lines.length - limit);
}
cursor = size;
return {
cursor,
size,
lines,
truncated,
reset,
};
} finally {
await handle.close();
}
}
/** Reads and redacts the configured log tail with bounded bytes and line count. */
export async function readConfiguredLogTail(params?: {
cursor?: number;
limit?: number;
maxBytes?: number;
}): Promise<LogTailPayload> {
const file = await resolveLogFile(getResolvedLoggerSettings().file);
const result = await readLogSlice({
file,
cursor: params?.cursor,
limit: params?.limit ?? DEFAULT_LIMIT,
maxBytes: params?.maxBytes ?? DEFAULT_MAX_BYTES,
});
const redaction = resolveRedactOptions();
return {
file,
...result,
lines: redactSensitiveLines(result.lines, redaction),
};
}