nodeJS進(jìn)程管理器pm2的使用

pm2是一個(gè)帶有負(fù)載均衡功能的Node應(yīng)用的進(jìn)程管理器。當(dāng)你要把你的獨(dú)立代碼利用全部的服務(wù)器上的所有CPU，并保證進(jìn)程永遠(yuǎn)都活著，0秒的重載， PM2是完美的。

PM2是開(kāi)源的基于Nodejs的進(jìn)程管理器，包括守護(hù)進(jìn)程，監(jiān)控，日志的一整套完整的功能，基本是Nodejs應(yīng)用程序不二的守護(hù)進(jìn)程選擇，事實(shí)上它并不僅僅可以啟動(dòng)Nodejs的程序，只要是一般的腳本的程序它同樣可以勝任。

主要特性：

• 內(nèi)建負(fù)載均衡（使用Node cluster 集群模塊）
• 后臺(tái)運(yùn)行
• 0秒停機(jī)重載（這項(xiàng)功能允許你重新載入代碼而不用失去請(qǐng)求連接。）
• 具有Ubuntu和CentOS 的啟動(dòng)腳本
• 停止不穩(wěn)定的進(jìn)程（避免無(wú)限循環(huán)）
• 控制臺(tái)檢測(cè)
• 提供 HTTP API
• 遠(yuǎn)程控制和實(shí)時(shí)的接口API ( Nodejs 模塊,允許和PM2進(jìn)程管理器交互 )
  

使用環(huán)境：

• 僅能用于web應(yīng)用
• 運(yùn)行于Node 0.11.x版本
• 運(yùn)行于 cluster 模式（默認(rèn)模式）
  

安裝

npm install -g pm2

pm2安裝好后，會(huì)自動(dòng)創(chuàng)建下面目錄：

/.pm2 
/.pm2/logs  
/.pm2/pids 
/.pm2/pm2.log 
/.pm2/pm2.pid 
/.pm2/rpc.sock 
/.pm2/pub.sock 
/.pm2/conf.js

用法

npm install pm2 -g          # 命令行安裝 pm2 
pm2 start app.js -i 4        #后臺(tái)運(yùn)行pm2，啟動(dòng)4個(gè)app.js 
                        # 也可以把'max' 參數(shù)傳遞給 start
                        # 正確的進(jìn)程數(shù)目依賴于Cpu的核心數(shù)目
pm2 start app.js --name my-api # 命名進(jìn)程
pm2 list                 # 顯示所有進(jìn)程狀態(tài)
pm2 monit                # 監(jiān)視所有進(jìn)程
pm2 logs                 # 顯示所有進(jìn)程日志
pm2 stop all               # 停止所有進(jìn)程
pm2 restart all             # 重啟所有進(jìn)程
pm2 reload all              # 0秒停機(jī)重載進(jìn)程 (用于 NETWORKED 進(jìn)程)
pm2 stop 0                # 停止指定的進(jìn)程
pm2 restart 0              # 重啟指定的進(jìn)程
pm2 startup               # 產(chǎn)生 init 腳本 保持進(jìn)程活著
pm2 web                 # 運(yùn)行健壯的 computer API endpoint (http://localhost:9615)
pm2 delete 0               # 殺死指定的進(jìn)程
pm2 delete all              # 殺死全部進(jìn)程

運(yùn)行進(jìn)程的不同方式：

$ pm2 start app.js -i max # 根據(jù)有效CPU數(shù)目啟動(dòng)最大進(jìn)程數(shù)目
$ pm2 start app.js -i 3   # 啟動(dòng)3個(gè)進(jìn)程
$ pm2 start app.js -x    #用fork模式啟動(dòng) app.js 而不是使用 cluster
$ pm2 start app.js -x -- -a 23  # 用fork模式啟動(dòng) app.js 并且傳遞參數(shù) (-a 23)
$ pm2 start app.js --name serverone # 啟動(dòng)一個(gè)進(jìn)程并把它命名為 serverone
$ pm2 stop serverone    # 停止 serverone 進(jìn)程
$ pm2 start app.json    # 啟動(dòng)進(jìn)程, 在 app.json里設(shè)置選項(xiàng)
$ pm2 start app.js -i max -- -a 23          #在--之后給 app.js 傳遞參數(shù)
$ pm2 start app.js -i max -e err.log -o out.log # 啟動(dòng) 并 生成一個(gè)配置文件
你也可以執(zhí)行用其他語(yǔ)言編寫(xiě)的app ( fork 模式):
$ pm2 start my-bash-script.sh  -x --interpreter bash
$ pm2 start my-python-script.py -x --interpreter python

pm2 list

列出由pm2管理的所有進(jìn)程信息，還會(huì)顯示一個(gè)進(jìn)程會(huì)被啟動(dòng)多少次，因?yàn)闆](méi)處理的異常。

pm2 monit

監(jiān)視每個(gè)node進(jìn)程的CPU和內(nèi)存的使用情況。

入門(mén)教程

挑我們最愛(ài)的express應(yīng)用來(lái)舉例。一般我們都是通過(guò)npm start啟動(dòng)應(yīng)用，其實(shí)就是調(diào)用node ./bin/www。那么，換成pm2就是

pm2 start ./bin/www –watch

這里用了–watch參數(shù)，意味著當(dāng)你的express應(yīng)用代碼發(fā)生變化時(shí)，pm2會(huì)幫你重啟服務(wù)。

參數(shù)說(shuō)明：

--watch：監(jiān)聽(tīng)?wèi)?yīng)用目錄的變化，一旦發(fā)生變化，自動(dòng)重啟。如果要精確監(jiān)聽(tīng)、不見(jiàn)聽(tīng)的目錄，最好通過(guò)配置文件。
-i --instances：?jiǎn)⒂枚嗌賯€(gè)實(shí)例，可用于負(fù)載均衡。如果-i 0或者-i max，則根據(jù)當(dāng)前機(jī)器核數(shù)確定實(shí)例數(shù)目。
--ignore-watch：排除監(jiān)聽(tīng)的目錄/文件，可以是特定的文件名，也可以是正則。比如--ignore-watch="test node_modules "some scripts""
-n --name：應(yīng)用的名稱。查看應(yīng)用信息的時(shí)候可以用到。
-o --output <path>：標(biāo)準(zhǔn)輸出日志文件的路徑。
-e --error <path>：錯(cuò)誤輸出日志文件的路徑。
--interpreter <interpreter>：the interpreter pm2 should use for executing app (bash, python...)。比如你用的coffee script來(lái)編寫(xiě)應(yīng)用。

完整命令行參數(shù)列表：

pm2 start app.js –watch -i 2

配置文件

1. 配置文件里的設(shè)置項(xiàng)，跟命令行參數(shù)基本是一一對(duì)應(yīng)的。
2. 可以選擇yaml或者json文件，就看個(gè)人洗好了。
3. json格式的配置文件，pm2當(dāng)作普通的js文件來(lái)處理，所以可以在里面添加注釋或者編寫(xiě)代碼，這對(duì)于動(dòng)態(tài)調(diào)整配置很有好處。
4. 如果啟動(dòng)的時(shí)候指定了配置文件，那么命令行參數(shù)會(huì)被忽略。（個(gè)別參數(shù)除外，比如--env）
   

舉個(gè)簡(jiǎn)單例子：

{ 
  "name" : "fis-receiver",        // 應(yīng)用名稱 
  "script" : "./bin/www",         // 實(shí)際啟動(dòng)腳本 
  "cwd" : "./",              // 當(dāng)前工作路徑 
  "watch": [               // 監(jiān)控變化的目錄，一旦變化，自動(dòng)重啟 
    "bin", "routers" 
  ], 
  "ignore_watch" : [           // 從監(jiān)控目錄中排除 
    "node_modules", "logs", "public"
  ], 
  "watch_options": { 
    "followSymlinks": false 
  }, 
  "error_file" : "./logs/app-err.log",  // 錯(cuò)誤日志路徑 
  "out_file" : "./logs/app-out.log",   // 普通日志路徑 
  "env": { 
    "NODE_ENV": "production"      // 環(huán)境變量，object類型，如{"NODE_ENV":"production", "ID": "42"}；
  },
  "instances" : "max",          // 開(kāi)啟進(jìn)程數(shù)，可為數(shù)值，也可為max。與服務(wù)器cpu核數(shù)相關(guān)。應(yīng)用啟動(dòng)實(shí)例個(gè)數(shù)，僅在cluster模式有效，默認(rèn)為fork；
  "exec_mode" : "cluster"         // 應(yīng)用啟動(dòng)模式，支持fork和cluster模式；cluster(多核推薦)
  "min_uptime": "60s",          // 應(yīng)用運(yùn)行少于時(shí)間被認(rèn)為是異常啟動(dòng)；
  "max_restarts": 30,           // 最大異常重啟次數(shù)，即小于min_uptime運(yùn)行時(shí)間重啟次數(shù)；
  "max_memory_restart": "300M",      // 最大內(nèi)存限制數(shù)，超出自動(dòng)重啟；
  "autorestart": true,          // 默認(rèn)為true, 發(fā)生異常的情況下自動(dòng)重啟；
}

自定義啟動(dòng)文件，創(chuàng)建一個(gè)test.json的示例文件，格式如下：

{
 "apps":[
  {
   "name": "test",
   "cwd": "/data/wwwroot/nodejs",
   "script": "./test.sh",
   "exec_interpreter": "bash",
   "min_uptime": "60s",
   "max_restarts": 30,
   "exec_mode" : "cluster_mode",
   "error_file" : "./test-err.log",
   "out_file": "./test-out.log",
   "pid_file": "./test.pid"
   "watch": false
  }
]}

參數(shù)說(shuō)明：

• apps：json結(jié)構(gòu)，apps是一個(gè)數(shù)組，每一個(gè)數(shù)組成員就是對(duì)應(yīng)一個(gè)pm2中運(yùn)行的應(yīng)用
• name：應(yīng)用程序的名稱
• cwd：應(yīng)用程序所在的目錄
• script：應(yīng)用程序的腳本路徑
• exec_interpreter：應(yīng)用程序的腳本類型，這里使用的shell，默認(rèn)是nodejs
• min_uptime：最小運(yùn)行時(shí)間，這里設(shè)置的是60s即如果應(yīng)用程序在60s內(nèi)退出，pm2會(huì)認(rèn)為程序異常退出，此時(shí)觸發(fā)重啟max_restarts設(shè)置數(shù)量
• autorestart 默認(rèn)為true, 發(fā)生異常的情況下自動(dòng)重啟；
• max_restarts：設(shè)置應(yīng)用程序異常退出重啟的次數(shù)，默認(rèn)15次（從0開(kāi)始計(jì)數(shù)）
• exec_mode：應(yīng)用程序啟動(dòng)模式，這里設(shè)置的是cluster（集群），默認(rèn)是fork
• error_file：自定義應(yīng)用程序的錯(cuò)誤日志文件
• out_file：自定義應(yīng)用程序日志文件
• pid_file：自定義應(yīng)用程序的pid文件
• watch：是否啟用監(jiān)控模式，默認(rèn)是false。如果設(shè)置成true，當(dāng)應(yīng)用程序變動(dòng)時(shí)，pm2會(huì)自動(dòng)重載。這里也可以設(shè)置你要監(jiān)控的文件。
• max_memory_restart：當(dāng)內(nèi)存超過(guò)設(shè)置的數(shù)量時(shí)自動(dòng)重啟。 如果工程中有比較棘手的內(nèi)存泄露問(wèn)題，這個(gè)算是一個(gè)折中方案。
• instances： 啟用多少個(gè)實(shí)例，可用于負(fù)載均衡。僅在cluster模式有效，默認(rèn)為fork；
• cron_restart crontab時(shí)間格式，定時(shí)重啟應(yīng)用，目前只支持cluster模式；
  

運(yùn)行實(shí)例：已上面的test.json為例

pm2 start test.json

環(huán)境切換

在實(shí)際項(xiàng)目開(kāi)發(fā)中，我們的應(yīng)用經(jīng)常需要在多個(gè)環(huán)境下部署，比如開(kāi)發(fā)環(huán)境、測(cè)試環(huán)境、生產(chǎn)環(huán)境等。在不同環(huán)境下，有時(shí)候配置項(xiàng)會(huì)有差異，比如鏈接的數(shù)據(jù)庫(kù)地址不同等。

對(duì)于這種場(chǎng)景，pm2也是可以很好支持的。首先通過(guò)在配置文件中通過(guò)env_xx來(lái)聲明不同環(huán)境的配置，然后在啟動(dòng)應(yīng)用時(shí)，通過(guò)–env參數(shù)指定運(yùn)行的環(huán)境。

首先，在配置文件中，通過(guò)env選項(xiàng)聲明多個(gè)環(huán)境配置。簡(jiǎn)單說(shuō)明下：

env為默認(rèn)的環(huán)境配置（生產(chǎn)環(huán)境），env_dev、env_test則分別是開(kāi)發(fā)、測(cè)試環(huán)境。可以看到，不同環(huán)境下的NODE_ENV、REMOTE_ADDR字段的值是不同的。

在應(yīng)用中，可以通過(guò)process.env.REMOTE_ADDR等來(lái)讀取配置中生命的變量。

例如：

"env": { "NODE_ENV": "production","REMOTE_ADDR": "http://www.example.com/"}
"env_dev": { "NODE_ENV": "development", "REMOTE_ADDR": "http://wdev.example.com/"} 
​"env_test": { "NODE_ENV": "test", "REMOTE_ADDR": http://wtest.example.com/}

啟動(dòng)指明環(huán)境：假設(shè)通過(guò)下面啟動(dòng)腳本（開(kāi)發(fā)環(huán)境），那么，此時(shí)process.env.REMOTE_ADDR的值就是相應(yīng)的鏈接地址

pm2 start app.js --env dev

負(fù)載均衡

命令如下，表示開(kāi)啟三個(gè)進(jìn)程。如果-i 0，則會(huì)根據(jù)機(jī)器當(dāng)前核數(shù)自動(dòng)開(kāi)啟盡可能多的進(jìn)程。

m2 start app.js -i 3 # 開(kāi)啟三個(gè)進(jìn)程 
​ 
​pm2 start app.js -i max # 根據(jù)機(jī)器CPU核數(shù)，開(kāi)啟對(duì)應(yīng)數(shù)目的進(jìn)程

日志查看

除了可以打開(kāi)日志文件查看日志外，還可以通過(guò)pm2 logs來(lái)查看實(shí)時(shí)日志。這點(diǎn)對(duì)于線上問(wèn)題排查非常重要。

比如某個(gè)node服務(wù)突然異常重啟了，那么可以通過(guò)pm2提供的日志工具來(lái)查看實(shí)時(shí)日志，看是不是腳本出錯(cuò)之類導(dǎo)致的異常重啟。

pm2 logs

開(kāi)機(jī)自動(dòng)啟動(dòng)

可以通過(guò)pm2 startup來(lái)實(shí)現(xiàn)開(kāi)機(jī)自啟動(dòng)。大致流程如下：

通過(guò)pm2 save保存當(dāng)前進(jìn)程狀態(tài)。

通過(guò)pm2 startup [platform]生成開(kāi)機(jī)自啟動(dòng)的命令。（記得查看控制臺(tái)輸出）

將步驟2生成的命令，粘貼到控制臺(tái)進(jìn)行，搞定。

自動(dòng)重啟應(yīng)用

fork不支持定時(shí)重啟，cluster支持定時(shí)重啟。定時(shí)重啟也就是配置中的cron_restart配置項(xiàng)。

監(jiān)控(monitor)

運(yùn)行如下命令，查看當(dāng)前通過(guò)pm2運(yùn)行的進(jìn)程的狀態(tài)。

pm2 monit

內(nèi)存使用超過(guò)上限自動(dòng)重啟

如果想要你的應(yīng)用，在超過(guò)使用內(nèi)存上限后自動(dòng)重啟，那么可以加上–max-memory-restart參數(shù)。（有對(duì)應(yīng)的配置項(xiàng)）

pm2 start big-array.js –max-memory-restart 20M

Web API

如果你不僅僅想監(jiān)控被pm2管理的進(jìn)程，還需要監(jiān)控進(jìn)程所運(yùn)行的機(jī)器的信息，你可以使用下面這個(gè)API。

pm2 web

pm2會(huì)啟動(dòng)一個(gè)叫做pm2-http-interface的進(jìn)程提供web服務(wù)。你打開(kāi)瀏覽器輸入http：//127.0.0.1:9615，是不是被看到的結(jié)果驚艷到了。

pm2與forever對(duì)比

穩(wěn)定運(yùn)行建議

PM2是一款非常優(yōu)秀的Node進(jìn)程管理工具，它有著豐富的特性：能夠充分利用多核CPU且能夠負(fù)載均衡、能夠幫助應(yīng)用在崩潰后、指定時(shí)間(cluster model)和超出最大內(nèi)存限制等情況下實(shí)現(xiàn)自動(dòng)重啟。

個(gè)人幾點(diǎn)看法保證常駐應(yīng)用進(jìn)程穩(wěn)定運(yùn)行：

• 定時(shí)重啟，應(yīng)用進(jìn)程運(yùn)行時(shí)間久了或許總會(huì)產(chǎn)生一些意料之外的問(wèn)題，定時(shí)可以規(guī)避一些不可測(cè)的情況；
• 最大內(nèi)存限制，根據(jù)觀察設(shè)定合理內(nèi)存限制，保證應(yīng)用異常運(yùn)行；
• 合理min_uptime，min_uptime是應(yīng)用正常啟動(dòng)的最小持續(xù)運(yùn)行時(shí)長(zhǎng)，超出此時(shí)間則被判定為異常啟動(dòng)；
• 設(shè)定異常重啟延時(shí)restart_delay，對(duì)于異常情況導(dǎo)致應(yīng)用停止，設(shè)定異常重啟延遲可防止應(yīng)用在不可測(cè)情況下不斷重啟的導(dǎo)致重啟次數(shù)過(guò)多等問(wèn)題；
• 設(shè)置異常重啟次數(shù)，如果應(yīng)用不斷異常重啟，并超過(guò)一定的限制次數(shù)，說(shuō)明此時(shí)的環(huán)境長(zhǎng)時(shí)間處于不可控狀態(tài)，服務(wù)器異常。此時(shí)便可停止嘗試，發(fā)出錯(cuò)誤警告通知等。

與supervisor對(duì)比

supervisor可以實(shí)現(xiàn)修改命令后重啟應(yīng)用，但是關(guān)閉控制臺(tái)之后，整個(gè)進(jìn)程就掛了。pm2則可以后臺(tái)運(yùn)行，關(guān)閉控制臺(tái)之后也不影響進(jìn)程運(yùn)行。

以上就是本文的全部?jī)?nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持億速云。