前言
log4js 算是“出镜率”很高的日志记录工具了，如果你熟悉 java ，就会一第时间在 npm 中搜索到它。适用于大多数项目对日志需求（日志分级、按时间分割文件、按不同分类记录等…）。类似的还有 winston ，loglevel 等。
但在使用 PM2 开启 多线程 模式时，结果却不符合预期，比如：日志不输出、日志记录数据也有缺失。
社区解决方案很详细，这里做个总结，同时讲下日志管理的相关事项。
先来看下 log4js 的基本配置
如下配置对日志会有如下功能：
- 未指定 categories 会有默认 default 的日志显示 appenders 输出，default 的日志级别为 debugger 及以上。
- appenders 分为：控制台 console 输出、访问日志输出、错误异常输出。
- 其中访问日志会按照日期进行分割。
正常运行项目后，日志输出正常，一切符合预期。（基于单进程方式）
当遇到 PM2 时（cluster）
为充分利用 cpu ，给应用开启多核能力，最方便莫过于使用 pm2 模块。具体使用不做赘述，简单使用，官网的文档足够了：
https://pm2.keymetrics.io/docs/usage/pm2-doc-single-page/
但开启多 cluster 后，log4js 日志却没有输出，不然也不会有那么多人苦恼了。
配置修改
log4js 相关：
回到官网，看下有什么特殊配置，不过还得抱怨一下，log4js 的文档真的很“蛋疼”。
https://log4js-node.github.io/log4js-node/api.html#configuration-object
如上图，分别在 log4js 的配置里增加了：pm2、pm2InstanceVar 两个参数。
pm2 配置相关：
pm2 启动配置
修改配置说明
设置 instance_var 实例变量，在交给 pm2 运行后，会自动赋值给 process.env.NODE_APP_INSTANCE 。详细说明可以看下官网说明：
https://pm2.keymetrics.io/docs/usage/environment/#specific-environment-variables
先结合 pm2 的 instance_var 配置，看下 log4js 的 pm2InstanceVar ，这两者必须设置的值相同。因为有关 isPM2Master 的逻辑判断：
再来具体看下 log4js 相关代码：
根据新增参数，预先移除原有的事件监听方式，当 isPM2Master 判断为 pm2 为主进程时，pm2-intercom 作为新的消息收发“中转站”。
这就是为何配置了 log4js 的配置，但 没有安装 pm2-intercom ，就会发生日志不输出的情况。
当然如果你图方便，在出现一些“未知错误”，可以尝试在 log4js 添加如下配置：
disableClustering: true;
它会使上面所说的方式失效，每个线程将会单独向目标日志文件输出内容，表明似乎问题可以解决，但是在高频访问下会出现日志缺失的情况。毕竟日志文件被多个进程写入放操作着。
有效的日志管理
对于一个线上的项目，可能需要一些其他手段来对日志做维护管理。既然现在说 pm2 ，就要看下其日志插件：pm2-logrotate
来看下具体配置：
定时轮询
rotateInterval 和 workerInterval 都有定时的作用。
前者通过编写 cron 表达式，约定每隔多少时间 强制 检查日志的状态。
后者 workerInterval 是约定固定秒数来查询日志状况。（默认 30 秒）
日志分割条件
max_size 和 retain 分别来约束日志的大小，和文件个数
每次 定时轮询 触发后，会对文件大小，数量进行检查。超过约定的值，则会重新创建新文件。
实际运用
假设单日日志产出为 10G ，按照 rotateInterval 每天零点进行切割日志，虽然有章法，但如果要从 10G 大小的日志文件中排查问题，这似乎有些困难。
我们可以设置 max_size 为 100M ，这样 10G 总大小的文件，将在一天中被切成 100 个。
甚至如果每天的访问量有迹可循，比如上午 9-12 点会出现高峰，其他时间相对低频。可以进一步优化 workerInterval 和 rotateInterval cron 表达式：
这样在高访问时间段，可以跟有效的分割日志。（美中不足的是如果符合日志分割条件，00:00 和 00:30 时，会出现两份日志，强迫症表示不太适应）
关于我
一名工作在一线的前端工程师，乐于实践，并分享前端开发经验。
关注头条号 or 微信公众号【前端雨爸】，欢迎评论留言，愿与各位交流进步。
点击 ↙ 了解更多，了解更多前端开发技术文章。
