推荐使用 winston-daily-rotate-file 进行日志管理

推荐使用 winston-daily-rotate-file 进行日志管理

winston-daily-rotate-fileA transport for winston which logs to a rotating file each day. 项目地址:https://gitcode.com/gh_mirrors/wi/winston-daily-rotate-file

项目介绍

winston-daily-rotate-file 是一个为 winston 日志库设计的传输模块，专门用于日志文件的自动轮转。通过这个模块，你可以轻松实现日志文件按日期、大小或数量进行轮转，并支持旧日志文件的自动删除。

项目技术分析

winston-daily-rotate-file 利用了 file-stream-rotator 模块来实现文件的轮转功能。自版本 2.0.0 起，该模块进行了重大重构，以提供更灵活和强大的日志管理功能。

兼容性

• 如果你使用的是 winston@2，需要安装 winston-daily-rotate-file@3。
• winston-daily-rotate-file@4 及以上版本已不再支持 winston@2。
• 该模块支持 Node.js 8.x 及以上版本，但建议在 Node.js 14+ 环境下使用。

项目及技术应用场景

winston-daily-rotate-file 适用于需要高效管理大量日志文件的场景，例如：

• Web 服务器日志管理：自动轮转和归档日志文件，避免日志文件过大。
• 应用程序监控：定期清理旧日志，确保日志数据的时效性和可用性。
• 系统监控和调试：通过日志轮转功能，方便地跟踪和分析系统运行状态。

项目特点

• 灵活的轮转策略：支持按分钟、小时、天、月、年或工作日进行日志轮转。
• 自动压缩归档：支持将旧日志文件压缩归档，节省存储空间。
• 自定义文件名和路径：允许自定义日志文件名和存储路径，便于管理和检索。
• 事件驱动：提供多种自定义事件，如 new、rotate、archive 和 logRemoved，方便进行日志文件的监控和管理。
• 错误处理：支持捕获和处理底层文件系统错误，确保应用程序的稳定性。

安装与使用

安装

npm install winston-daily-rotate-file

基本使用示例

var winston = require('winston');
require('winston-daily-rotate-file');

var transport = new winston.transports.DailyRotateFile({
  filename: 'application-%DATE%.log',
  datePattern: 'YYYY-MM-DD-HH',
  zippedArchive: true,
  maxSize: '20m',
  maxFiles: '14d'
});

transport.on('error', error => {
  // 处理错误
});

transport.on('rotate', (oldFilename, newFilename) => {
  // 处理轮转事件
});

var logger = winston.createLogger({
  transports: [transport]
});

logger.info('Hello World!');

使用多个传输

var winston = require('winston');
require('winston-daily-rotate-file');

var transport1 = new winston.transports.DailyRotateFile({
  filename: 'application-%DATE%.log',
  datePattern: 'YYYY-MM-DD-HH',
  zippedArchive: true,
  maxSize: '20m',
  maxFiles: '14d'
});

var transport2 = new winston.transports.DailyRotateFile({
  level: 'error',
  filename: 'application-error-%DATE%.log',
  datePattern: 'YYYY-MM-DD-HH',
  zippedArchive: true,
  maxSize: '20m',
  maxFiles: '14d'
});

transport1.on('error', error => {
  // 处理错误
});

transport2.on('error', error => {
  // 处理错误
});

transport1.on('rotate', function(oldFilename, newFilename) {
  // 处理轮转事件
});

transport2.on('rotate', function(oldFilename, newFilename) {

winston-daily-rotate-fileA transport for winston which logs to a rotating file each day. 项目地址:https://gitcode.com/gh_mirrors/wi/winston-daily-rotate-file