Electron-log日志轮转机制解析与自定义配置指南

Electron-log日志轮转机制解析与自定义配置指南

日志轮转的基本原理

electron-log作为Electron应用中的常用日志记录工具，其内置了简洁高效的日志轮转机制。当日志文件达到预设的maxSize大小时，系统会自动触发轮转操作，将当前日志文件重命名为带有".old.log"后缀的文件，然后创建一个新的空日志文件继续记录。

默认行为的问题分析

默认情况下，electron-log的轮转机制采用固定命名方式，即每次轮转都会生成相同的"xxx.old.log"文件名。这种设计虽然简单，但存在明显的局限性：当连续多次触发轮转时，新的轮转文件会直接覆盖旧的轮转文件，导致历史日志信息丢失。

自定义轮转方案

electron-log提供了archiveLogFn配置项，允许开发者完全自定义日志轮转行为。通过实现这个函数，我们可以创建更符合实际需求的轮转策略：

log.transports.file.archiveLogFn = (oldLogFile) => {
    const oldLogFilePath = oldLogFile.toString();
    const info = path.parse(oldLogFilePath);
    
    try {
        // 使用时间戳作为文件名后缀
        const timestamp = new Date()
            .toISOString()
            .replace(/[:.]/g, '-')
            .replace('T', '_');
        
        fs.renameSync(
            oldLogFilePath,
            path.join(info.dir, `${info.name}.${timestamp}${info.ext}`)
        );
    } catch (e) {
        console.error('日志轮转失败:', e);
    }
}

进阶轮转策略建议

1. 时间戳命名：如示例所示，使用精确到毫秒的时间戳可以确保每个轮转文件都有唯一名称。

2. 序列号命名：对于需要简单排序的场景，可以使用递增的数字序列作为后缀。

3. 多级归档：可以结合日期创建目录结构，如按年/月/日分级存储。

4. 压缩归档：对于长期保存的日志，可以在轮转时自动压缩以节省空间。

5. 清理策略：建议配套实现定期清理机制，防止日志文件无限增长。

最佳实践

在实际项目中，建议根据以下因素选择合适的轮转策略：

• 日志的重要性等级
• 存储空间的限制
• 日志分析的需求
• 合规性要求

对于关键业务系统，推荐采用时间戳命名+定期归档的策略，既便于管理又能完整保留历史记录。对于客户端应用，则可考虑更简单的序列号方式，配合自动清理机制。

electron-log的这种灵活设计，使得开发者能够根据具体场景定制最适合的日志管理方案，平衡存储效率与信息完整性的需求。