Winston DailyRotateFile自定义格式化失效问题咨询

我之前也踩过这个坑！问题出在winston-daily-rotate-file这个第三方传输插件上——它早期版本的配置逻辑和Winston原生的Console传输不一样，不支持直接使用formatter参数，这就是为啥你的Console日志格式正常，但文件日志还是默认样式的原因。下面给你两个可行的解决思路：

思路1：升级依赖并使用Winston标准的format API #

Winston后来推出了更灵活的format API，而新版的winston-daily-rotate-file已经对齐了这个标准，建议优先用这种方式，代码更统一也更容易维护：

首先确保你安装了最新版的依赖：

npm update winston winston-daily-rotate-file

然后重构你的日志配置，用winston.format.combine来组合自定义格式：

const winston = require('winston');
const { DailyRotateFile } = require('winston-daily-rotate-file');

// 定义统一的自定义格式化规则
const customLogFormat = winston.format.combine(
  // 自定义时间戳（和你之前的逻辑一致）
  winston.format.timestamp({ format: () => Date.now().toString() }),
  // 拼接最终的日志内容，还可以轻松加入交易ID等动态字段
  winston.format.printf(({ timestamp, message }) => {
    // 如果需要加入交易ID，可以在打日志时传参：logger.info('xxx', { transactionId: 'abc123' })
    // 然后这里可以用 info.transactionId 来获取
    return `${timestamp}-${process.env.NODE_ENV}- message: ${message}`;
  })
);

const transports = [
  new DailyRotateFile({
    filename: './logs/scrapper.log',
    datePattern: 'yyyy-MM-dd.',
    prepend: true,
    level: config.get('logging.level'),
    zippedArchive: false,
    format: customLogFormat // 这里用format代替旧的formatter
  }),
  new winston.transports.Console({
    format: customLogFormat // 复用同一个格式化规则，避免重复代码
  })
];

// 创建logger实例
const logger = winston.createLogger({ transports });

思路2：旧版本兼容方案（使用transform参数） #

如果因为项目依赖限制不能升级版本，可以用winston-daily-rotate-file旧版本支持的transform参数来替代formatter——它的作用和formatter类似，是这个插件自己实现的内容处理钩子：

const transports = [
  new (winston.transports.DailyRotateFile)({
    filename: './logs/scrapper.log',
    datePattern: 'yyyy-MM-dd.',
    prepend: true,
    colorize: true,
    level: config.get('logging.level'),
    zippedArchive: false,
    timestamp: function(){ return Date.now(); },
    // 用transform替代formatter，参数和旧formatter逻辑一致
    transform: function(info, opts) {
      return opts.timestamp() + '-' + process.env.NODE_ENV + '- message:' + (info.message ? info.message : '');
    }
  }),
  new (winston.transports.Console)({
    timestamp: function() { return Date.now(); },
    formatter: function(options) {
      return options.timestamp() + '-' + process.env.NODE_ENV + '- message: ' + (options.message ? options.message : '');
    }
  })
];

额外补充：自动注入业务字段（比如交易ID） #

如果你想自动加入交易ID这类不需要每次手动传参的字段，可以结合Winston的format和请求中间件实现：比如在Express中间件里生成交易ID并挂载到req对象，然后用自定义format从上下文读取并注入日志：

// 自定义format，从请求上下文获取交易ID
const addTransactionId = winston.format((info) => {
  // 假设你把交易ID存在了全局变量或者请求上下文里
  info.transactionId = global.currentTransactionId || 'unknown';
  return info;
});

// 组合到格式化规则里
const customLogFormat = winston.format.combine(
  addTransactionId(),
  winston.format.timestamp({ format: () => Date.now().toString() }),
  winston.format.printf(({ timestamp, message, transactionId }) => {
    return `${timestamp}-${process.env.NODE_ENV}-[${transactionId}]- message: ${message}`;
  })
);

这样开发人员打日志时就不用手动传meta参数，日志会自动带上环境、交易ID这些字段啦～

内容的提问来源于stack exchange，提问作者Diego Ramirez