Github地址 https://github.com/Unitech/pm2
官方文檔 http://pm2.keymetrics.io/docs/usage/quick-start/
pm2是守護nodejs進程后台運行的,異常停止后可以自動重啟,並且也可以袒護其它第三方的命令行程序,比如php的命令行
{
"name": "應用進程名稱", "args": "傳遞給腳本的參數", "script": "啟動的腳本路徑", "exec_interpreter": "指定的腳本解釋器", "exec_mode": "fork", "max_memory_restart": "100M", //其它參數 "watch": [ // 監控變化的目錄,一旦變化,自動重啟 "bin", "routers" ], "ignore_watch" : [ // 從監控目錄中排除 "node_modules", "logs", "public" ], "watch_options": { "followSymlinks": false }, "error_file" : "./logs/app-err.log", // 錯誤日志路徑 "out_file" : "./logs/app-out.log", // 普通日志路徑 "env": { "NODE_ENV": "production" // 環境參數,當前指定為生產環境 } }
-
name 腳本顯示名稱
-
args 腳本參數
-
script 腳本文件名稱
-
exec_interpreter 使用的解析器
-
exec_mode 啟動模式,fork為使用子進程啟動,cluster 使用nodejs的cluster模塊啟動
-
max_memory_restart 進程占用內存超過時自動重啟
使用示例
后台運行一個php的socket程序,需要一直運行,所以需要使用pm2來守護進程
創建一個socket.json的配置文件,里面是數組格式可以啟動多個
[{
"name": "php-socket", "args": "", "script": "./include/Socket.php", "exec_interpreter": "php.exe", "exec_mode": "fork", "max_memory_restart": "100M" }]
然后cmd到當前目錄執行
pm2 start socket.json
進程已經運行啦,查看此進程的詳細情況用下面命令后面的0就是上面顯示的id,在我的系統上面那個id不知道怎么回事顯示成一個方框啦,應該是亂碼啦
pm2 describe 0
注意到里面的日志文件有好幾個.error肯定是錯誤日志啦。out的就是命令行里的輸出字符都在這里
主要特性:
內建負載均衡(使用Node cluster 集群模塊)
后台運行
0秒停機重載,我理解大概意思是維護升級的時候不需要停機.
具有Ubuntu和CentOS 的啟動腳本
停止不穩定的進程(避免無限循環)
控制台檢測
提供 HTTP API
遠程控制和實時的接口API ( Nodejs 模塊,允許和PM2進程管理器交互 )
測試過Nodejs v0.11 v0.10 v0.8版本,兼容CoffeeScript,基於Linux 和MacOS.
安裝
npm install -g pm2
用法
$ npm install pm2 -g # 命令行安裝 pm2
$ pm2 start app.js -i 4 #后台運行pm2,啟動4個app.js
# 也可以把'max' 參數傳遞給 start
# 正確的進程數目依賴於Cpu的核心數目
$ pm2 start app.js --name my-api # 命名進程
$ pm2 list # 顯示所有進程狀態
$ pm2 monit # 監視所有進程
$ 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
$ pm2 delete 0 # 殺死指定的進程
$ pm2 delete all # 殺死全部進程
運行進程的不同方式:
$ pm2 start app.js -i max # 根據有效CPU數目啟動最大進程數目
$ 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 並且傳遞參數 (-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 傳遞參數
$ pm2 start app.js -i max -e err.log -o out.log # 啟動 並 生成一個配置文件
你也可以執行用其他語言編寫的app ( fork 模式):
$ pm2 start my-bash-script.sh -x --interpreter bash
$ pm2 start my-python-script.py -x --interpreter python
0秒停機重載:
這項功能允許你重新載入代碼而不用失去請求連接。
注意:
僅能用於web應用
運行於Node 0.11.x版本
運行於 cluster 模式(默認模式)
$ pm2 reload all
CoffeeScript:
$ pm2 start my_app.coffee #這就是全部
PM2准備好為產品級服務了嗎?
只需在你的服務器上測試
$ git clone https://github.com/Unitech/pm2.git
$ cd pm2
$ npm install # 或者 npm install --dev ,如果devDependencies 沒有安裝
$ npm test
pm2 list
列出由pm2管理的所有進程信息,還會顯示一個進程會被啟動多少次,因為沒處理的異常。
pm2 monit
監視每個node進程的CPU和內存的使用情況。
最后附上一些配置說明
配置項
name 應用名稱;
script 啟動腳本路徑;
cwd 應用啟動的路徑;
args 傳遞給腳本的參數;
interpreter 指定的腳本解釋器;
interpreter_args 傳遞給解釋器的參數;
instances 應用啟動實例個數,僅在cluster模式有效,默認為fork;
exec_mode 應用啟動模式,支持fork和cluster模式;
watch 監聽重啟,啟用情況下,文件夾或子文件夾下變化應用自動重啟;
ignore_watch 忽略監聽的文件夾,支持正則表達式;
max_memory_restart 最大內存限制數,超出自動重啟;
env 環境變量,object類型,如{"NODE_ENV":"production", "ID": "42"};
log_date_format 指定日志日期格式,如YYYY-MM-DD HH:mm:ss;
error_file 記錄標准錯誤流,$HOME/.pm2/logs/XXXerr.log),代碼錯誤可在此文件查找;
out_file 記錄標准輸出流,$HOME/.pm2/logs/XXXout.log),如應用打印大量的標准輸出,會導致pm2日志過大;
min_uptime 應用運行少於時間被認為是異常啟動;
max_restarts 最大異常重啟次數,即小於min_uptime運行時間重啟次數;
autorestart 默認為true, 發生異常的情況下自動重啟;
cron_restart crontab時間格式重啟應用,目前只支持cluster模式;
force 默認false,如果true,可以重復啟動一個腳本。pm2不建議這么做;
restart_delay 異常重啟情況下,延時重啟時間;