使用Winston.js自定义格式化函数注入日志参数

import winston from 'winston';
// 假设 correlator 是一个用于生成和获取关联ID的库
// 例如：import correlator from 'correlation-id';
// 为演示目的，这里可以简化或模拟 correlator.getId()
const correlator = {
  getId: () => Math.random().toString(36).substring(2, 15) // 模拟生成一个随机ID
};

/**
 * 自定义Winston格式化函数，用于注入关联ID。
 * @param {object} info - Winston日志信息对象。
 * @returns {object} - 注入关联ID后的日志信息对象。
 */
export const correlationInjection = winston.format(info => {
  // 在这里可以获取当前请求的关联ID，并将其添加到info对象中
  info.correlationId = correlator.getId();
  return info;
});

import winston from 'winston';
// 引入上面定义的自定义格式
import { correlationInjection } from './correlation-format'; // 假设保存为 correlation-format.js

// 创建一个Winston Logger实例
const logger = winston.createLogger({
  level: 'info', // 最小日志级别
  format: winston.format.combine(
    correlationInjection(), // 首先应用我们的自定义注入格式
    winston.format.timestamp(), // 添加时间戳
    winston.format.json() // 将日志输出为JSON格式
  ),
  transports: [
    new winston.transports.Console() // 输出到控制台
    // 也可以添加文件传输等
    // new winston.transports.File({ filename: 'combined.log' })
  ]
});

export default logger;

// main.js
import logger from './logger'; // 引入上面配置的logger

function processRequest(requestId) {
  // 在实际应用中，你可能需要一个全局的上下文来设置和获取correlationId
  // 例如，使用 express-winston 或 async_hooks
  // 这里我们只是模拟日志输出
  logger.info('处理请求中...', { requestId });
  logger.debug('这是一个调试信息，应该包含关联ID');
  logger.error('发生了一个错误！', { error: new Error('Something went wrong') });
}

// 模拟几次请求
console.log('--- 第一次模拟请求 ---');
processRequest('req-001');

// 模拟 correlator.getId() 返回不同的ID
// 在实际应用中，这通常由请求上下文管理
correlator.getId = () => Math.random().toString(36).substring(2, 15);

console.log('\n--- 第二次模拟请求 ---');
processRequest('req-002');

{"level":"info","message":"处理请求中...","requestId":"req-001","correlationId":"<随机ID1>","timestamp":"2023-10-27T10:00:00.000Z"}
{"level":"debug","message":"这是一个调试信息，应该包含关联ID","correlationId":"<随机ID1>","timestamp":"2023-10-27T10:00:00.001Z"}
{"level":"error","message":"发生了一个错误！","error":{},"correlationId":"<随机ID1>","timestamp":"2023-10-27T10:00:00.002Z"}

{"level":"info","message":"处理请求中...","requestId":"req-002","correlationId":"<随机ID2>","timestamp":"2023-10-27T10:00:00.003Z"}
{"level":"debug","message":"这是一个调试信息，应该包含关联ID","correlationId":"<随机ID2>","timestamp":"2023-10-27T10:00:00.004Z"}
{"level":"error","message":"发生了一个错误！","error":{},"correlationId":"<随机ID2>","timestamp":"2023-10-27T10:00:00.005Z"}