快捷導(dǎo)航

一文教你如何使用Node進(jìn)程管理工具-pm2

更新時(shí)間：2023年04月19日 10:09:26 作者：東方小月

這篇文章詳細(xì)介紹了如何使用node進(jìn)程管理工具pm2，文中代碼示例講解的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友可以借鑒一下

pm2 是什么

pm2 是一個(gè)守護(hù)進(jìn)程管理工具,它能幫你守護(hù)和管理你的應(yīng)用程序。通常一般會(huì)在服務(wù)上線的時(shí)候使用 pm2 進(jìn)行管理。pm2 能做的其實(shí)有很多,比如監(jiān)聽(tīng)文件改動(dòng)自動(dòng)重啟,統(tǒng)一管理多個(gè)進(jìn)程,內(nèi)置的負(fù)載均衡,日志系統(tǒng)等等,下面就讓我們看下 pm2 是如何使用的吧

pm2 基本命令

首先我們先創(chuàng)建一個(gè)簡(jiǎn)單的 node 服務(wù),新建文件夾執(zhí)行npm init,然后裝 pm2

npm i pm2 -g

新建 index.js 和 index2.js,寫(xiě)兩個(gè)簡(jiǎn)單的 http 服務(wù),然后用 pm2 進(jìn)行管理

//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(`服務(wù)器啟動(dòng)成功,通過(guò)http://localhost:3000/進(jìn)行訪問(wèn)`);
});

//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(`服務(wù)器啟動(dòng)成功,通過(guò)http://localhost:3001/進(jìn)行訪問(wèn)`);
});

接下來(lái)我們將使用 pm2 的第一個(gè)命令: pm2 start index.js和pm2 start index2.js 分別啟動(dòng)這兩個(gè)個(gè)程序

當(dāng)然如果你想指定進(jìn)程名字可以這樣: pm2 start -n test index.js,如果你想監(jiān)聽(tīng)文件改動(dòng)可以加--watch等等

訪問(wèn)http://localhost:3000/

執(zhí)行pm2 log可以看到我們打印的日志

pm2 的命令還有很多,下面列舉幾個(gè)

停止 1 個(gè)/多個(gè)/所有程序 pm2 stop id/id1 id2 id3/all
殺死 1 個(gè)/多個(gè)/所有程序 pm2 delete id/id1 id2 id3/all
重啟 1 個(gè)/多個(gè)/所有程序 pm2 restart id/id1 id2 id3/all
啟動(dòng)并查看日志 pm2 start api.js --attach
列出應(yīng)用程序 pm2 list
查看監(jiān)控面板 pm2 monit
查看程序數(shù)據(jù) pm2 show [id]

負(fù)載均衡

我們都知道 NodeJS 是一個(gè)異步單線程語(yǔ)言,倘若不做任何處理直接部署到服務(wù)器上,那么它也只能使用服務(wù)器的一個(gè)線程,這樣是非常浪費(fèi)性能的。

使用 pm2 只需一個(gè)命令就能讓我們的程序充分利用服務(wù)器的 CPU,拿 index.js 為例:pm2 start index -i max,比如我的電腦是 10 核 20 線程,它就會(huì)開(kāi) 20 個(gè)線程

當(dāng)然如果你想指定多少線程可以直接將 max 改成你想開(kāi)的線程數(shù) pm2 start index -i 3

配置文件

上面的例子我們都是使用命令行進(jìn)行管理的,這樣其實(shí)挺不方便的,好在 pm2 提供了配置文件的形式。

我們直接使用命令pm2 init simple即可生成一個(gè)簡(jiǎn)單的配置文件ecosystem.config.js,修改一下讓它指向我們的兩個(gè)服務(wù)

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

然后我們將原先的進(jìn)程都 kill 掉,執(zhí)行pm2 start ecosystem.config.js,同樣的我們的兩個(gè)服務(wù)都被啟動(dòng)了

下面列舉一些配置項(xiàng)ecosystem.config.js

module.exports = {
  apps: [
    {
      name: "index", //name
      script: "./index.js", //相對(duì)于pm2 start 的相對(duì)路徑
      cwd: "", //要啟動(dòng)的應(yīng)用程序的目錄
      instances: 2, //要啟動(dòng)實(shí)例的數(shù)量,就是上面提到的負(fù)載
      watch: true, //是否啟動(dòng)監(jiān)聽(tīng)
      env: { NODE_ENV: "development" }, //	將出現(xiàn)在您的應(yīng)用程序中的 env 變量
      env_xxx: {
        NODE_ENV: "xxx", //使用pm2注入xxx變量進(jìn)行切換
      },
      log_date_format: "YYYY-MM-DD HH:mm Z", //日志時(shí)間格式
      error_file: "./log/index-error.log", //錯(cuò)誤文件路徑
      out_file: "./log/index-out.log", //輸出日志文件路徑
      max_restarts: 10, //最大重啟數(shù)
      restart_delay: 4000, //重啟延遲時(shí)間ms
      autorestart: true, //是否自動(dòng)重啟
      cron_restart: "", //定時(shí)重啟 使用cron表達(dá)式
    },
    {
      name: "index2",
      script: "./index2.js",
    },
  ],
};

日志

日志對(duì)于后端排查錯(cuò)誤是非常重要的,pm2 自帶日志功能,比如我們?cè)谏厦媾渲梦募信渲昧巳罩鞠嚓P(guān)的參數(shù)

log_date_format: "YYYY-MM-DD HH:mm Z", //日志時(shí)間格式
error_file: "./log/index-error.log", //錯(cuò)誤文件路徑
out_file: "./log/index-out.log", //輸出日志文件路徑

當(dāng)我們啟動(dòng)項(xiàng)目的時(shí)候,日志就會(huì)記錄在 log 下

pm2 自帶的日志功能是不支持日志分割的。隨著時(shí)間的推移,日志文件會(huì)越來(lái)越大,不僅會(huì)影響性能,后期排查問(wèn)題也十分麻煩,因此我們需要對(duì)日志進(jìn)行分割。日志分割操作很簡(jiǎn)單,只需要安裝pm2-logrotate插件即可,注意這里是 pm2 install

pm2 install pm2-logrotate

然后執(zhí)行 pm2 conf 可以看到相關(guān)配置

解釋一下相關(guān)含義

Compress：是否通過(guò) gzip 壓縮日志
max_size：?jiǎn)蝹€(gè)日志文件的大小
retain：保留的日志文件個(gè)數(shù)
dateFormat：日志文件名中的日期格式，默認(rèn)是 YYYY-MM-DD_HH-mm-ss
rotateModule：是否把 pm2 本身的日志也進(jìn)行分割,
workerInterval：檢查文件時(shí)間間隔
rotateInterval：設(shè)置強(qiáng)制分割，默認(rèn)值是 0 0 * * *，意思是每天晚上 0 點(diǎn)分割,這里使用的是 corn 表達(dá)式,不會(huì)的可以搜索一下

如果我們想要配置也很簡(jiǎn)單,比如修改 max_size