PM2启动项目后日志不输出如何解决？

Question

问题：使用PM2启动Node.js项目后，发现应用日志未输出到控制台或日志文件中，导致无法排查运行时错误。常见原因包括PM2配置文件中未正确设置`output`、`error`和`log`日志路径，或应用本身通过`console.log`输出但被PM2默认重定向策略忽略。此外，若应用使用了自定义日志模块（如winston或bunyan）而未配置输出流，也可能导致日志“丢失”。如何正确配置PM2及应用日志，确保启动后日志正常输出？

Answer 1

一、问题现象与初步排查

在使用PM2启动Node.js项目时，开发者常遇到应用日志未输出至控制台或指定日志文件的问题。这种“日志丢失”现象直接影响了运行时错误的排查效率。最直观的表现是：尽管代码中存在console.log()调用，但在执行pm2 logs命令时无任何输出，或日志文件为空。

初步排查应从以下三个维度入手：

• PM2默认日志重定向机制：PM2会自动捕获process.stdout和process.stderr，并将输出写入其管理的日志文件。
• 配置文件缺失或路径错误：若未正确设置output（标准输出）、error（错误输出）和log（PM2自身日志）路径，则可能导致日志写入失败。
• 应用层日志模块干扰：当使用如Winston、Bunyan等第三方日志库时，若未显式配置输出流（stream），可能绕过PM2的日志捕获机制。

二、深入分析：PM2日志机制原理

PM2通过拦截Node.js进程的标准输出（stdout）和标准错误（stderr）来实现日志收集。其核心逻辑如下图所示：

app.js
console.log('Hello from app');
console.error('Error occurred');

graph TD A[Node.js应用] -->|stdout/stderr| B(PM2日志拦截器) B --> C{是否配置output/error路径?} C -->|是| D[写入指定日志文件] C -->|否| E[写入默认路径 ~/.pm2/logs/] D --> F[可通过 pm2 logs 查看] E --> F

需要注意的是，PM2仅能捕获直接写入stdout和stderr的内容。如果应用使用自定义日志器且关闭了控制台输出（如设置silent: true），则这些日志将不会出现在PM2日志流中。

三、常见配置错误与修正方案

配置项	作用	常见错误	推荐值
output	标准输出重定向路径	未设置或权限不足	./logs/app-out.log
error	错误输出重定向路径	路径不存在	./logs/app-error.log
log	PM2自身操作日志	与output混淆	./logs/pm2.log
mergeLogs	合并所有实例日志	多实例下日志混乱	true
maxMemoryRestart	内存超限重启	未启用导致内存泄漏无法发现	1G

示例：正确的ecosystem.config.js配置应包含明确的日志路径定义：

module.exports = {
  apps: [
    {
      name: 'my-app',
      script: './app.js',
      output: './logs/app-out.log',
      error: './logs/app-error.log',
      log: './logs/pm2.log',
      mergeLogs: true,
      instances: 2,
      autorestart: true,
      maxMemoryRestart: '1G'
    }
  ]
};

四、结合Winston/Bunyan等日志库的高级配置

当应用使用Winston进行日志记录时，需确保传输器（transport）正确绑定到process.stdout和process.stderr，以便PM2能够捕获输出。以下为Winston的兼容性配置示例：

const winston = require('winston');

const logger = winston.createLogger({
  level: 'info',
  format: winston.format.json(),
  transports: [
    new winston.transports.Console({
      format: winston.format.simple(),
      stream: process.stdout  // 关键：绑定到stdout
    }),
    new winston.transports.File({ filename: 'logs/error.log', level: 'error' }),
    new winston.transports.File({ filename: 'logs/combined.log' })
  ]
});

同理，对于Bunyan，可通过streams配置实现相同效果：

const bunyan = require('bunyan');
const log = bunyan.createLogger({
  name: 'my-service',
  streams: [
    {
      level: 'info',
      stream: process.stdout  // 必须显式指向stdout
    },
    {
      level: 'error',
      path: 'logs/bunyan-error.log'
    }
  ]
});

此时，即使启用了文件写入，PM2仍可通过拦截process.stdout获取日志内容，实现双端留存。

五、运维级最佳实践建议

1. 统一日志目录结构：mkdir -p ./logs && chmod 755 ./logs
2. 定期轮转日志文件，避免磁盘占满，可结合logrotate或PM2自带的--log-date-format选项。
3. 启用pm2 install pm2-logrotate插件以自动切割日志。
4. 在CI/CD流程中验证日志路径可写性。
5. 生产环境禁用console.log裸调用，统一通过结构化日志库输出。
6. 使用pm2 describe <app_name>检查当前日志文件路径。
7. 通过pm2 logs --nostream查看历史日志快照。
8. 监控日志文件大小变化趋势，设置告警阈值。
9. 对微服务架构，建议按服务+实例命名日志文件，如service-user-1.log。
10. 结合ELK或Graylog等集中式日志系统，提升跨服务追踪能力。