Winston.js日志拦截与自定义参数注入指南

import winston from 'winston';
// 假设 correlator 是一个用于在请求上下文中获取或生成关联ID的库。
// 在实际应用中，您可能需要集成一个如 cls-hooked 或 async_hooks 这样的库来管理上下文。
// 这里仅作示例，correlator.getId() 代表获取当前上下文的关联ID。
const correlator = {
  getId: () => {
    // 实际应用中，这里会从请求上下文（如AsyncLocalStorage）中获取ID
    // 示例：生成一个简单的随机ID
    return Math.random().toString(36).substring(2, 15);
  }
};

/**
 * 自定义Winston格式：注入关联ID
 * 这个格式函数会在每次日志记录时被调用，并将当前的关联ID注入到info对象中。
 */
export const correlationInjection = winston.format(info => {
  // 尝试从 correlator 获取当前的关联ID
  const correlationId = correlator.getId();
  if (correlationId) {
    info.correlationId = correlationId;
  }
  return info; // 必须返回修改后的info对象
});

import winston from 'winston';
import { correlationInjection } from './correlationInjection'; // 导入上面定义的格式

// 配置 Winston Logger
const logger = winston.createLogger({
  level: 'info', // 设置日志级别
  format: winston.format.combine(
    correlationInjection(), // 首先应用自定义的关联ID注入格式
    winston.format.timestamp({ format: 'YYYY-MM-DD HH:mm:ss' }), // 添加时间戳
    winston.format.json() // 将日志输出为 JSON 格式，便于查看注入的字段
  ),
  transports: [
    new winston.transports.Console() // 输出到控制台
    // 还可以添加文件传输器等
    // new winston.transports.File({ filename: 'combined.log' })
  ]
});

// 使用 Logger 进行日志记录
logger.info('用户登录成功', { userId: 123, ip: '192.168.1.1' });
logger.warn('数据库连接超时');
logger.error('处理订单失败', new Error('Payment gateway error'));

// 示例输出（当 correlationId 被注入时，JSON 格式的日志会包含该字段）
/*
{
  "level": "info",
  "correlationId": "some-generated-correlation-id", // 注入的字段
  "timestamp": "2023-10-27 10:30:00",
  "message": "用户登录成功",
  "userId": 123,
  "ip": "192.168.1.1"
}
{
  "level": "warn",
  "correlationId": "some-generated-correlation-id",
  "timestamp": "2023-10-27 10:30:01",
  "message": "数据库连接超时"
}
*/