在Pino日志库中实现精确文件名与行号记录

概述

Pino作为Node.js生态中高性能的日志记录库，其默认输出并不包含日志调用位置的文件名和行号信息。本文将详细介绍如何在Pino中配置以显示精确的日志调用位置，这对于调试和问题追踪至关重要。

问题背景

开发者在配置Pino时遇到一个常见需求：希望日志输出能显示日志语句所在的精确文件名和行号，而不仅仅是日志工具本身的文件位置。默认情况下，Pino的日志输出会固定显示日志工具模块的文件路径（如示例中的src/logging.ts），这在实际调试中帮助有限。

解决方案

使用pino-caller插件

Pino社区提供了一个官方插件pino-caller，专门用于解决这个问题。该插件会修改Pino的日志输出，自动添加调用位置的文件名和行号。

安装方法：

npm install pino-caller

配置示例：

const pino = require('pino');
const pinoCaller = require('pino-caller');

const log = pinoCaller(pino({
  level: 'info',
  transport: {
    target: 'pino-pretty',
    options: {
      colorize: true
    }
  }
}));

自定义实现方案

如果不使用插件，也可以通过修改Pino配置手动实现类似功能：

const path = require('path');
const pino = require('pino');

function getCallerInfo() {
  const stack = new Error().stack.split('\n');
  // 通常第三行是调用者的信息
  const callerLine = stack[3] || '';
  const match = callerLine.match(/\((.+):(\d+):(\d+)\)/);
  if (match) {
    return {
      file: path.basename(match[1]),
      line: match[2],
      column: match[3]
    };
  }
  return { file: 'unknown', line: '0', column: '0' };
}

const log = pino({
  level: 'info',
  mixin() {
    const { file, line } = getCallerInfo();
    return { file, line };
  },
  transport: {
    target: 'pino-pretty',
    options: {
      messageFormat: '{file}:{line} - {msg}'
    }
  }
});

性能考虑

需要注意的是，获取调用栈信息是一个相对昂贵的操作，可能会影响应用程序的性能，特别是在高频日志记录的场景下。因此建议：

1. 在生产环境中仅对ERROR及以上级别的日志启用调用位置记录
2. 在开发/测试环境可以全面启用以便调试
3. 考虑使用pino-caller等优化过的解决方案而非手动实现

最佳实践

1. 环境区分：根据NODE_ENV不同采用不同配置
2. 日志级别控制：高频率的DEBUG日志可以不记录位置信息
3. 格式统一：保持整个项目的日志格式一致性
4. 性能监控：启用后观察应用性能变化

总结

在Pino中实现精确的日志位置记录对于调试复杂应用非常有价值。通过使用官方插件或自定义实现，开发者可以灵活地控制日志输出的详细程度。但需要注意性能影响，根据实际场景权衡功能与开销。