一文教你如何使用Node程式管理工具-pm2

web前端進階發表於2023-04-25

pm2 是什麼

pm2 是一個守護程式管理工具,它能幫你守護和管理你的應用程式。通常一般會在服務上線的時候使用 pm2 進行管理。pm2 能做的其實有很多,比如監聽檔案改動自動重啟,統一管理多個程式,內建的負載均衡,日誌系統等等,下面就讓我們看下 pm2 是如何使用的吧

pm2 基本命令

首先我們先建立一個簡單的 node 服務,新建資料夾執行npm init,然後裝 pm2

npm i pm2 -g

新建 index.js 和 index2.js,寫兩個簡單的 http 服務,然後用 pm2 進行管理

//index.js
let http = require("http");
let server = http.createServer();
server.on("request", function (req, res) {
  console.log("------------------enter");
  res.write("hello juejin");
  res.end();
});

server.listen(3000, function () {
  console.log(`伺服器啟動成功,透過http://localhost:3000/進行訪問`);
});

//index2.js
let http = require("http");
let server = http.createServer();
server.on("request", function (req, res) {
  console.log("------------------enter2");
  res.write("hello juejin2");
  res.end();
});

server.listen(3001, function () {
  console.log(`伺服器啟動成功,透過http://localhost:3001/進行訪問`);
});

接下來我們將使用 pm2 的第一個命令: pm2 start index.js和pm2 start index2.js 分別啟動這兩個個程式

image.png

當然如果你想指定程式名字可以這樣: pm2 start -n test index.js,如果你想監聽檔案改動可以加--watch等等

訪問http://localhost:3000/

image.png

執行pm2 log可以看到我們列印的日誌

image.png

pm2 的命令還有很多,下面列舉幾個

  • 停止 1 個/多個/所有程式 pm2 stop id/id1 id2 id3/all
  • 殺死 1 個/多個/所有程式 pm2 delete id/id1 id2 id3/all
  • 重啟 1 個/多個/所有程式 pm2 restart id/id1 id2 id3/all
  • 啟動並檢視日誌 pm2 start api.js --attach
  • 列出應用程式 pm2 list
  • 檢視監控皮膚 pm2 monit
  • 檢視程式資料 pm2 show [id]

負載均衡

我們都知道 NodeJS 是一個非同步單執行緒語言,倘若不做任何處理直接部署到伺服器上,那麼它也只能使用伺服器的一個執行緒,這樣是非常浪費效能的。

使用 pm2 只需一個命令就能讓我們的程式充分利用伺服器的 CPU,拿 index.js 為例:pm2 start index -i max,比如我的電腦是 10 核 20 執行緒,它就會開 20 個執行緒

image.png

當然如果你想指定多少執行緒可以直接將 max 改成你想開的執行緒數 pm2 start index -i 3

image.png

配置檔案

上面的例子我們都是使用命令列進行管理的,這樣其實挺不方便的,好在 pm2 提供了配置檔案的形式。

我們直接使用命令pm2 init simple即可生成一個簡單的配置檔案ecosystem.config.js,修改一下讓它指向我們的兩個服務

module.exports = {
  apps: [
    {
      name: "index",
      script: "./index.js",
    },
    {
      name: "index2",
      script: "./index2.js",
    },
  ],
};

然後我們將原先的程式都 kill 掉,執行pm2 start ecosystem.config.js,同樣的我們的兩個服務都被啟動了

image.png

下面列舉一些配置項ecosystem.config.js

module.exports = {
  apps: [
    {
      name: "index", //name
      script: "./index.js", //相對於pm2 start 的相對路徑
      cwd: "", //要啟動的應用程式的目錄
      instances: 2, //要啟動例項的數量,就是上面提到的負載
      watch: true, //是否啟動監聽
      env: { NODE_ENV: "development" }, //	將出現在您的應用程式中的 env 變數
      env_xxx: {
        NODE_ENV: "xxx", //使用pm2注入xxx變數進行切換
      },
      log_date_format: "YYYY-MM-DD HH:mm Z", //日誌時間格式
      error_file: "./log/index-error.log", //錯誤檔案路徑
      out_file: "./log/index-out.log", //輸出日誌檔案路徑
      max_restarts: 10, //最大重啟數
      restart_delay: 4000, //重啟延遲時間ms
      autorestart: true, //是否自動重啟
      cron_restart: "", //定時重啟 使用cron表示式
    },
    {
      name: "index2",
      script: "./index2.js",
    },
  ],
};

日誌

日誌對於後端排查錯誤是非常重要的,pm2 自帶日誌功能,比如我們在上面配置檔案中配置了日誌相關的引數

log_date_format: "YYYY-MM-DD HH:mm Z", //日誌時間格式
error_file: "./log/index-error.log", //錯誤檔案路徑
out_file: "./log/index-out.log", //輸出日誌檔案路徑

當我們啟動專案的時候,日誌就會記錄在 log 下

image.png

pm2 自帶的日誌功能是不支援日誌分割的。隨著時間的推移,日誌檔案會越來越大,不僅會影響效能,後期排查問題也十分麻煩,因此我們需要對日誌進行分割。日誌分割操作很簡單,只需要安裝pm2-logrotate外掛即可,注意這裡是 pm2 install

pm2 install pm2-logrotate

然後執行 pm2 conf 可以看到相關配置

image.png

解釋一下相關含義

  • Compress：是否透過 gzip 壓縮日誌

  • max_size：單個日誌檔案的大小

  • retain：保留的日誌檔案個數

  • dateFormat：日誌檔名中的日期格式，預設是 YYYY-MM-DD_HH-mm-ss

  • rotateModule：是否把 pm2 本身的日誌也進行分割,

  • workerInterval：檢查檔案時間間隔

  • rotateInterval：設定強制分割，預設值是 0 0 * * *，意思是每天晚上 0 點分割,這裡使用的是 corn 表示式,不會的可以搜尋一下

如果我們想要配置也很簡單,比如修改 max_size

pm2 set pm2-logrotate:max_size 1K

然後我們簡單測試一下這個工具,我們先設定每個 log 檔案最大 1kb

然後重啟我們的專案

pm2 restart ecosystem.config.js

然後就會發現我們的日誌被分割了

image.png

總結

pm2對於node服務的管理是十分方便的,文中提到的只是其中一部分,如果你想使用pm2管理你的服務的話可以到官網pm2.io/ 進行學習

關注公眾號web前端進階每日更新最新前端技術文章,你想要的都有!

相關文章