探索 PM2 Cluster 模式下 Log4js 日誌丟失

Node 應用為單執行緒應用，JS 雖可利用非同步 I/O 避免執行緒阻塞，但無法利用多核 CPU 的優勢提升執行效率，提高吞吐量仍需多執行緒。Node Cluster 可產生多個工作執行緒共享同一 TCP 連線，主執行緒通過 IPC 通道與工作執行緒通訊，並使用 Round-robin 負載均衡極好的處理執行緒間壓力。

PM2 Cluster 使得 Node 操作叢集更加容易，PM2 會根據伺服器 CPU 核數產生相應的工作執行緒，只需按如下方式啟動應用：

pm2 start app.js -i 0
複製程式碼

但 PM2 Cluster 與 Log4js 相撞時，砸出了大坑，本人踩了進去。

踩坑經過：某日服務端同學上報了一線上請求引數異常日誌，為追蹤異常產生原因，我在所有線上伺服器翻查均未尋到相關日誌。服務端異常日誌並非捏造，前端日誌丟失並非偶然。為統計日誌丟失率，線上下環境定量發起 100 條請求，結果僅產生 25 條日誌，多次實驗發現丟失率穩定在 3/4 令人髮指！熱（好）愛（奇）技（心）術（重）的我查閱了 Log4js 原始碼：

configuration.addListener((config) => {
    // clear out the listeners, because configure has been called.
    listeners.length = 0;

    disabled = config.disableClustering;
    pm2 = config.pm2;
    pm2InstanceVar = config.pm2InstanceVar || 'NODE_APP_INSTANCE';

    debug(`clustering disabled ? ${disabled}`);
    debug(`cluster.isMaster ? ${cluster.isMaster}`);
    debug(`pm2 enabled ? ${pm2}`);
    debug(`pm2InstanceVar = ${pm2InstanceVar}`);
    debug(`process.env[${pm2InstanceVar}] = ${process.env[pm2InstanceVar]}`);

    // just in case configure is called after shutdown.
    if (pm2) {
        process.removeListener('message', receiver);
    }
    if (cluster.removeListener) {
        cluster.removeListener('message', receiver);
    }

    if (config.disableClustering) {
        debug('Not listening for cluster messages, because clustering disabled.');
    } else if (isPM2Master()) {
        // PM2 cluster support
        // PM2 runs everything as workers - install pm2-intercom for this to work.
        // we only want one of the app instances to write logs.
        debug('listening for PM2 broadcast messages');
        process.on('message', receiver);
    } else if (cluster.isMaster) {
        debug('listening for cluster messages');
        cluster.on('message', receiver);
    } else {
        debug('not listening for messages, because we are not a master process.');
    }
});
複製程式碼

請注意：

PM2 runs everything as workers - install pm2-intercom for this to work.

Log4js 在 Cluster 模式下，worker 將日誌傳送至 master，master 實現日誌寫入檔案。但在 PM2 Cluster 模式下，所有程式皆為 worker：

於是按照 Log4js 原始碼的指引安裝 pm2-intercom 程式間通訊模組：

仍不奏效，又注意到 isPM2Master()：

const isPM2Master = () => pm2 && process.env[pm2InstanceVar] === '0';
const isMaster = () => disabled || cluster.isMaster || isPM2Master();
複製程式碼

isPM2Master 通過 Log4js configure 中 pm2 及 pm2InstanceVar 引數確定，於是修改 Log4js 配置如下：

Log4JS.configure({
    // ...
    pm2: true,
    pm2InstanceVar: 'INSTANCE_ID'
});
複製程式碼

終於解決了 PM2 Cluster 模式下 Log4js 日誌丟失問題。

---

補充一下：

自行實現 Node Cluster：

const OS = require('os');
const Cluster = require('cluster');
const Koa = require('koa');
const App = new Koa();
if (Cluster.isMaster) {
    for (let i = 0; i < OS.cpus().length; i++) Cluster.fork();
    console.log('master', process.pid);
} else {
    App.listen(3000);
    console.log('worker', process.pid);
}
複製程式碼

埠 PID 與控制檯顯示的 PID List 關係：

使用 PM2 Cluster 啟動 Node 應用，埠 PID 與 PM2 控制檯顯示的 PID List 關係：

---

作者：呆戀小喵

我的後花園：sunmengyuan.github.io/garden/

我的 github：github.com/sunmengyuan

原文連結：sunmengyuan.github.io/garden/2018…