mirror of
https://github.com/diegosouzapw/OmniRoute.git
synced 2026-08-02 05:12:11 +03:00
158 lines
4.9 KiB
TypeScript
158 lines
4.9 KiB
TypeScript
/**
|
|
* Log Rotation & Cleanup — manages application log file rotation.
|
|
*
|
|
* Handles:
|
|
* - Rotating log files when they exceed max size
|
|
* - Cleaning up old log files past retention period
|
|
* - Capping the number of rotated log files kept on disk
|
|
* - Creating the log directory on startup
|
|
*
|
|
* Configuration via env vars:
|
|
* - APP_LOG_TO_FILE: enable file logging (default: true)
|
|
* - APP_LOG_FILE_PATH: path to log file (default: logs/application/app.log)
|
|
* - APP_LOG_MAX_FILE_SIZE: max file size before rotation (default: 50MB)
|
|
* - APP_LOG_RETENTION_DAYS: days to keep old logs (default: 7)
|
|
* - APP_LOG_MAX_FILES: max number of rotated log files to keep (default: 20)
|
|
*/
|
|
|
|
import { existsSync, mkdirSync, statSync, renameSync, readdirSync, unlinkSync } from "fs";
|
|
import { dirname, join, basename, extname } from "path";
|
|
import {
|
|
getAppLogFilePath,
|
|
getAppLogMaxFiles,
|
|
getAppLogMaxFileSize,
|
|
getAppLogRetentionDays,
|
|
getAppLogToFile,
|
|
} from "./logEnv";
|
|
|
|
export function getLogConfig() {
|
|
const logToFile = getAppLogToFile();
|
|
const logFilePath = getAppLogFilePath() || join(process.cwd(), "logs/application/app.log");
|
|
const maxFileSize = getAppLogMaxFileSize();
|
|
const retentionDays = getAppLogRetentionDays();
|
|
const maxFiles = getAppLogMaxFiles();
|
|
|
|
return { logToFile, logFilePath, maxFileSize, retentionDays, maxFiles };
|
|
}
|
|
|
|
/**
|
|
* Ensure the log directory exists.
|
|
*/
|
|
export function ensureLogDir(logFilePath: string): void {
|
|
const dir = dirname(logFilePath);
|
|
if (!existsSync(dir)) {
|
|
mkdirSync(dir, { recursive: true });
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Rotate the log file if it exceeds the max size.
|
|
* Renames current file to app.YYYY-MM-DD_HHmmss.log
|
|
*/
|
|
export function rotateIfNeeded(logFilePath: string, maxFileSize: number): void {
|
|
try {
|
|
if (!existsSync(logFilePath)) return;
|
|
const stats = statSync(logFilePath);
|
|
if (stats.size < maxFileSize) return;
|
|
|
|
const dir = dirname(logFilePath);
|
|
const ext = extname(logFilePath);
|
|
const base = basename(logFilePath, ext);
|
|
const now = new Date();
|
|
const ts = `${now.getFullYear()}-${String(now.getMonth() + 1).padStart(2, "0")}-${String(
|
|
now.getDate()
|
|
).padStart(2, "0")}_${String(now.getHours()).padStart(2, "0")}${String(
|
|
now.getMinutes()
|
|
).padStart(2, "0")}${String(now.getSeconds()).padStart(2, "0")}`;
|
|
|
|
const rotatedPath = join(dir, `${base}.${ts}${ext}`);
|
|
renameSync(logFilePath, rotatedPath);
|
|
} catch {
|
|
// If rotation fails, continue writing to the same file
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Remove log files older than the retention period.
|
|
*/
|
|
export function cleanupOldLogs(logFilePath: string, retentionDays: number): void {
|
|
try {
|
|
const dir = dirname(logFilePath);
|
|
if (!existsSync(dir)) return;
|
|
|
|
const ext = extname(logFilePath);
|
|
const base = basename(logFilePath, ext);
|
|
const files = readdirSync(dir);
|
|
const cutoff = Date.now() - retentionDays * 24 * 60 * 60 * 1000;
|
|
|
|
for (const file of files) {
|
|
// Match rotated files like app.2026-02-19_030000.log
|
|
if (file.startsWith(base + ".") && file.endsWith(ext) && file !== basename(logFilePath)) {
|
|
const filePath = join(dir, file);
|
|
try {
|
|
const stats = statSync(filePath);
|
|
if (stats.mtimeMs < cutoff) {
|
|
unlinkSync(filePath);
|
|
}
|
|
} catch {
|
|
// Skip files we can't stat
|
|
}
|
|
}
|
|
}
|
|
} catch {
|
|
// Cleanup is best-effort
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Keep only the newest rotated files up to the configured count limit.
|
|
*/
|
|
export function cleanupOverflowLogs(logFilePath: string, maxFiles: number): void {
|
|
try {
|
|
const dir = dirname(logFilePath);
|
|
if (!existsSync(dir) || maxFiles < 1) return;
|
|
|
|
const ext = extname(logFilePath);
|
|
const base = basename(logFilePath, ext);
|
|
const rotatedFiles = readdirSync(dir)
|
|
.filter(
|
|
(file) =>
|
|
file !== basename(logFilePath) && file.startsWith(base + ".") && file.endsWith(ext)
|
|
)
|
|
.map((file) => {
|
|
const filePath = join(dir, file);
|
|
try {
|
|
return { filePath, mtimeMs: statSync(filePath).mtimeMs };
|
|
} catch {
|
|
return null;
|
|
}
|
|
})
|
|
.filter((entry): entry is { filePath: string; mtimeMs: number } => !!entry)
|
|
.sort((a, b) => b.mtimeMs - a.mtimeMs);
|
|
|
|
for (const entry of rotatedFiles.slice(maxFiles)) {
|
|
try {
|
|
unlinkSync(entry.filePath);
|
|
} catch {
|
|
// Best effort only.
|
|
}
|
|
}
|
|
} catch {
|
|
// Cleanup is best-effort
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Initialize log rotation — call once at application startup.
|
|
* Creates directories, rotates if needed, and cleans up old files.
|
|
*/
|
|
export function initLogRotation(): void {
|
|
const config = getLogConfig();
|
|
if (!config.logToFile) return;
|
|
|
|
ensureLogDir(config.logFilePath);
|
|
rotateIfNeeded(config.logFilePath, config.maxFileSize);
|
|
cleanupOldLogs(config.logFilePath, config.retentionDays);
|
|
cleanupOverflowLogs(config.logFilePath, config.maxFiles);
|
|
}
|