nodeJS進程管理器pm2的使用
pm2是一個帶有負載均衡功能的Node應用的進程管理器。當你要把你的獨立代碼利用全部的服務器上的所有CPU,并保證進程永遠都活著,0秒的重載, PM2是完美的。
PM2是開源的基于Nodejs的進程管理器,包括守護進程,監(jiān)控,日志的一整套完整的功能,基本是Nodejs應用程序不二的守護進程選擇,事實上它并不僅僅可以啟動Nodejs的程序,只要是一般的腳本的程序它同樣可以勝任。
主要特性:
- 內建負載均衡(使用Node cluster 集群模塊)
- 后臺運行
- 0秒停機重載(這項功能允許你重新載入代碼而不用失去請求連接。)
- 具有Ubuntu和CentOS 的啟動腳本
- 停止不穩(wěn)定的進程(避免無限循環(huán))
- 控制臺檢測
- 提供 HTTP API
- 遠程控制和實時的接口API ( Nodejs 模塊,允許和PM2進程管理器交互 )
使用環(huán)境:
- 僅能用于web應用
- 運行于Node 0.11.x版本
- 運行于 cluster 模式(默認模式)
安裝
npm install -g pm2
pm2安裝好后,會自動創(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 #后臺運行pm2,啟動4個app.js # 也可以把'max' 參數(shù)傳遞給 start # 正確的進程數(shù)目依賴于Cpu的核心數(shù)目 pm2 start app.js --name my-api # 命名進程 pm2 list # 顯示所有進程狀態(tài) pm2 monit # 監(jiān)視所有進程 pm2 logs # 顯示所有進程日志 pm2 stop all # 停止所有進程 pm2 restart all # 重啟所有進程 pm2 reload all # 0秒停機重載進程 (用于 NETWORKED 進程) pm2 stop 0 # 停止指定的進程 pm2 restart 0 # 重啟指定的進程 pm2 startup # 產生 init 腳本 保持進程活著 pm2 web # 運行健壯的 computer API endpoint (http://localhost:9615) pm2 delete 0 # 殺死指定的進程 pm2 delete all # 殺死全部進程
運行進程的不同方式:
$ pm2 start app.js -i max # 根據(jù)有效CPU數(shù)目啟動最大進程數(shù)目 $ pm2 start app.js -i 3 # 啟動3個進程 $ pm2 start app.js -x #用fork模式啟動 app.js 而不是使用 cluster $ pm2 start app.js -x -- -a 23 # 用fork模式啟動 app.js 并且傳遞參數(shù) (-a 23) $ pm2 start app.js --name serverone # 啟動一個進程并把它命名為 serverone $ pm2 stop serverone # 停止 serverone 進程 $ pm2 start app.json # 啟動進程, 在 app.json里設置選項 $ pm2 start app.js -i max -- -a 23 #在--之后給 app.js 傳遞參數(shù) $ pm2 start app.js -i max -e err.log -o out.log # 啟動 并 生成一個配置文件 你也可以執(zhí)行用其他語言編寫的app ( fork 模式): $ pm2 start my-bash-script.sh -x --interpreter bash $ pm2 start my-python-script.py -x --interpreter python
pm2 list
列出由pm2管理的所有進程信息,還會顯示一個進程會被啟動多少次,因為沒處理的異常。
pm2 monit
監(jiān)視每個node進程的CPU和內存的使用情況。
入門教程
挑我們最愛的express應用來舉例。一般我們都是通過npm start啟動應用,其實就是調用node ./bin/www。那么,換成pm2就是
pm2 start ./bin/www –watch
這里用了–watch參數(shù),意味著當你的express應用代碼發(fā)生變化時,pm2會幫你重啟服務。
參數(shù)說明:
--watch:監(jiān)聽應用目錄的變化,一旦發(fā)生變化,自動重啟。如果要精確監(jiān)聽、不見聽的目錄,最好通過配置文件。 -i --instances:啟用多少個實例,可用于負載均衡。如果-i 0或者-i max,則根據(jù)當前機器核數(shù)確定實例數(shù)目。 --ignore-watch:排除監(jiān)聽的目錄/文件,可以是特定的文件名,也可以是正則。比如--ignore-watch="test node_modules "some scripts"" -n --name:應用的名稱。查看應用信息的時候可以用到。 -o --output <path>:標準輸出日志文件的路徑。 -e --error <path>:錯誤輸出日志文件的路徑。 --interpreter <interpreter>:the interpreter pm2 should use for executing app (bash, python...)。比如你用的coffee script來編寫應用。
完整命令行參數(shù)列表:
pm2 start app.js –watch -i 2
配置文件
- 配置文件里的設置項,跟命令行參數(shù)基本是一一對應的。
- 可以選擇yaml或者json文件,就看個人洗好了。
- json格式的配置文件,pm2當作普通的js文件來處理,所以可以在里面添加注釋或者編寫代碼,這對于動態(tài)調整配置很有好處。
- 如果啟動的時候指定了配置文件,那么命令行參數(shù)會被忽略。(個別參數(shù)除外,比如--env)
舉個簡單例子:
{ "name" : "fis-receiver", // 應用名稱 "script" : "./bin/www", // 實際啟動腳本 "cwd" : "./", // 當前工作路徑 "watch": [ // 監(jiān)控變化的目錄,一旦變化,自動重啟 "bin", "routers" ], "ignore_watch" : [ // 從監(jiān)控目錄中排除 "node_modules", "logs", "public" ], "watch_options": { "followSymlinks": false }, "error_file" : "./logs/app-err.log", // 錯誤日志路徑 "out_file" : "./logs/app-out.log", // 普通日志路徑 "env": { "NODE_ENV": "production" // 環(huán)境變量,object類型,如{"NODE_ENV":"production", "ID": "42"}; }, "instances" : "max", // 開啟進程數(shù),可為數(shù)值,也可為max。與服務器cpu核數(shù)相關。應用啟動實例個數(shù),僅在cluster模式有效,默認為fork; "exec_mode" : "cluster" // 應用啟動模式,支持fork和cluster模式;cluster(多核推薦) "min_uptime": "60s", // 應用運行少于時間被認為是異常啟動; "max_restarts": 30, // 最大異常重啟次數(shù),即小于min_uptime運行時間重啟次數(shù); "max_memory_restart": "300M", // 最大內存限制數(shù),超出自動重啟; "autorestart": true, // 默認為true, 發(fā)生異常的情況下自動重啟; }
自定義啟動文件,創(chuàng)建一個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ù)說明:
- apps:json結構,apps是一個數(shù)組,每一個數(shù)組成員就是對應一個pm2中運行的應用
- name:應用程序的名稱
- cwd:應用程序所在的目錄
- script:應用程序的腳本路徑
- exec_interpreter:應用程序的腳本類型,這里使用的shell,默認是nodejs
- min_uptime:最小運行時間,這里設置的是60s即如果應用程序在60s內退出,pm2會認為程序異常退出,此時觸發(fā)重啟max_restarts設置數(shù)量
- autorestart 默認為true, 發(fā)生異常的情況下自動重啟;
- max_restarts:設置應用程序異常退出重啟的次數(shù),默認15次(從0開始計數(shù))
- exec_mode:應用程序啟動模式,這里設置的是cluster(集群),默認是fork
- error_file:自定義應用程序的錯誤日志文件
- out_file:自定義應用程序日志文件
- pid_file:自定義應用程序的pid文件
- watch:是否啟用監(jiān)控模式,默認是false。如果設置成true,當應用程序變動時,pm2會自動重載。這里也可以設置你要監(jiān)控的文件。
- max_memory_restart:當內存超過設置的數(shù)量時自動重啟。 如果工程中有比較棘手的內存泄露問題,這個算是一個折中方案。
- instances: 啟用多少個實例,可用于負載均衡。僅在cluster模式有效,默認為fork;
- cron_restart crontab時間格式,定時重啟應用,目前只支持cluster模式;
運行實例:已上面的test.json為例
pm2 start test.json
環(huán)境切換
在實際項目開發(fā)中,我們的應用經常需要在多個環(huán)境下部署,比如開發(fā)環(huán)境、測試環(huán)境、生產環(huán)境等。在不同環(huán)境下,有時候配置項會有差異,比如鏈接的數(shù)據(jù)庫地址不同等。
對于這種場景,pm2也是可以很好支持的。首先通過在配置文件中通過env_xx來聲明不同環(huán)境的配置,然后在啟動應用時,通過–env參數(shù)指定運行的環(huán)境。
首先,在配置文件中,通過env選項聲明多個環(huán)境配置。簡單說明下:
env為默認的環(huán)境配置(生產環(huán)境),env_dev、env_test則分別是開發(fā)、測試環(huán)境??梢钥吹?,不同環(huán)境下的NODE_ENV、REMOTE_ADDR字段的值是不同的。
在應用中,可以通過process.env.REMOTE_ADDR等來讀取配置中生命的變量。
例如:
"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/}
啟動指明環(huán)境:假設通過下面啟動腳本(開發(fā)環(huán)境),那么,此時process.env.REMOTE_ADDR的值就是相應的鏈接地址
pm2 start app.js --env dev
負載均衡
命令如下,表示開啟三個進程。如果-i 0,則會根據(jù)機器當前核數(shù)自動開啟盡可能多的進程。
m2 start app.js -i 3 # 開啟三個進程 pm2 start app.js -i max # 根據(jù)機器CPU核數(shù),開啟對應數(shù)目的進程
日志查看
除了可以打開日志文件查看日志外,還可以通過pm2 logs來查看實時日志。這點對于線上問題排查非常重要。
比如某個node服務突然異常重啟了,那么可以通過pm2提供的日志工具來查看實時日志,看是不是腳本出錯之類導致的異常重啟。
pm2 logs
開機自動啟動
可以通過pm2 startup來實現(xiàn)開機自啟動。大致流程如下:
通過pm2 save保存當前進程狀態(tài)。
通過pm2 startup [platform]生成開機自啟動的命令。(記得查看控制臺輸出)
將步驟2生成的命令,粘貼到控制臺進行,搞定。
自動重啟應用
fork不支持定時重啟,cluster支持定時重啟。定時重啟也就是配置中的cron_restart配置項。
監(jiān)控(monitor)
運行如下命令,查看當前通過pm2運行的進程的狀態(tài)。
pm2 monit
內存使用超過上限自動重啟
如果想要你的應用,在超過使用內存上限后自動重啟,那么可以加上–max-memory-restart參數(shù)。(有對應的配置項)
pm2 start big-array.js –max-memory-restart 20M
Web API
如果你不僅僅想監(jiān)控被pm2管理的進程,還需要監(jiān)控進程所運行的機器的信息,你可以使用下面這個API。
pm2 web
pm2會啟動一個叫做pm2-http-interface的進程提供web服務。你打開瀏覽器輸入http://127.0.0.1:9615,是不是被看到的結果驚艷到了。
pm2與forever對比
Feature | Forever | PM2 |
---|---|---|
Keep Alive | ✔ | ✔ |
Coffeescript | ✔ | |
Log aggregation | ✔ | |
API | ✔ | |
Terminal monitoring | ✔ | |
Clustering | ✔ | |
JSON configuration | ✔ |
穩(wěn)定運行建議
PM2是一款非常優(yōu)秀的Node進程管理工具,它有著豐富的特性:能夠充分利用多核CPU且能夠負載均衡、能夠幫助應用在崩潰后、指定時間(cluster model)和超出最大內存限制等情況下實現(xiàn)自動重啟。
個人幾點看法保證常駐應用進程穩(wěn)定運行:
- 定時重啟,應用進程運行時間久了或許總會產生一些意料之外的問題,定時可以規(guī)避一些不可測的情況;
- 最大內存限制,根據(jù)觀察設定合理內存限制,保證應用異常運行;
- 合理min_uptime,min_uptime是應用正常啟動的最小持續(xù)運行時長,超出此時間則被判定為異常啟動;
- 設定異常重啟延時restart_delay,對于異常情況導致應用停止,設定異常重啟延遲可防止應用在不可測情況下不斷重啟的導致重啟次數(shù)過多等問題;
- 設置異常重啟次數(shù),如果應用不斷異常重啟,并超過一定的限制次數(shù),說明此時的環(huán)境長時間處于不可控狀態(tài),服務器異常。此時便可停止嘗試,發(fā)出錯誤警告通知等。
與supervisor對比
supervisor可以實現(xiàn)修改命令后重啟應用,但是關閉控制臺之后,整個進程就掛了。pm2則可以后臺運行,關閉控制臺之后也不影響進程運行。
以上就是本文的全部內容,希望對大家的學習有所幫助,也希望大家多多支持腳本之家。
相關文章
node.js中的fs.truncateSync方法使用說明
這篇文章主要介紹了node.js中的fs.truncateSync方法使用說明,本文介紹了fs.truncateSync的方法說明、語法、接收參數(shù)、使用實例和實現(xiàn)源碼,需要的朋友可以參考下2014-12-12Nodejs進階:基于express+multer的文件上傳實例
本篇文章主要介紹了基于express+multer的文件上傳實例,現(xiàn)在分享給大家,也給大家做個參考,感興趣的小伙伴們可以參考一下。2016-11-11使用Nodejs連接mongodb數(shù)據(jù)庫的實現(xiàn)代碼
這篇文章主要介紹了使用Nodejs連接mongodb數(shù)據(jù)庫的實現(xiàn)代碼,需要的朋友可以參考下2017-08-08nodejs模塊nodemailer基本使用-郵件發(fā)送示例(支持附件)
本篇文章主要介紹了nodejs模塊nodemailer基本使用-郵件發(fā)送示例(支持附件),具有一定的參考價值,感興趣的小伙伴們可以參考一下。2017-03-03