node 進程管理工具比較
- supervisor:是開發環境用,修改命令后重啟應用,但是關閉控制臺之后,整個進程就掛了
- forever:管理多個站點,每個站點訪問量不大,不需要監控。
- pm2:網站訪問量比較大,需要完整的監控界面。可以后臺運行,關閉控制臺之后也不影響進程運行。
PM2 使用介紹:
P (rocess) M (anager)2
- PM2 是一個帶有負載均衡功能的 Node 應用的進程管理器,利用它來簡化很多node應用管理的繁瑣任務,如性能監控、自動重啟、負載均衡等,而且使用非常簡單
- 當你要把你的獨立代碼利用全部的服務器上的所有 CPU,并保證進程永遠都活著,0 秒的重載, PM2 是完美的。它非常適合 IaaS 結構,但不要把它用于 PaaS 方案(隨后將開發 Paas 的解決方案)
備注:
- SaaS、PaaS 和 IaaS 是云服務模式
- SaaS 軟件即服務,例如 Google 的 Gmail 郵箱服務,面向應用型用戶
- PaaS 平臺即服務,例如 Google 的 GAE,面向開發型用戶
- IaaS 基礎架構即服務,例如亞馬遜的 AWS,IaaS 對于不知道新推出的應用程序/網站會有多成功的創業公司來說非常有用
- 參考文檔 通俗易懂版本
PM2的主要特性:
- 內建負載均衡(使用Node cluster 集群模塊)
- 后臺運行
- 0秒停機重載,我理解大概意思是維護升級的時候不需要停機.?
- 具有Ubuntu和CentOS 的啟動腳本
- 停止不穩定的進程(避免無限循環)
- 控制臺檢測
- 提供 HTTP API
- 遠程控制和實時的接口API ( Nodejs 模塊,允許和PM2進程管理器交互 )
準備工作-Express 項目創建 并啟動服務:
* express -e pm2-demo
* npm install
* npm start
安裝
`npm install -g pm2`
目錄介紹
$HOME/.pm2 will contain all PM2 related files
$HOME/.pm2/logs will contain all applications logs
$HOME/.pm2/pids will contain all applications pids
$HOME/.pm2/pm2.log PM2 logs
$HOME/.pm2/pm2.pid PM2 pid
$HOME/.pm2/rpc.sock Socket file for remote commands
$HOME/.pm2/pub.sock Socket file for publishable events
$HOME/.pm2/conf.js PM2 Configuration
用法
$ 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 (http://localhost:9615)
$ 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 版本
- 運行于 fork 模式(默認模式)
常用命令
啟動
參數說明:
- --watch:監聽應用目錄的變化,一旦發生變化,自動重啟。如果要精確監聽、不見聽的目錄,最好通過配置文件。
- -i --instances:啟用多少個實例,可用于負載均衡。如果-i 0或者-i max,則根據當前機器核數確定實例數目。
- --ignore-watch:排除監聽的目錄/文件,可以是特定的文件名,也可以是正則。比如--ignore-watch="test node_modules "some scripts""
- -n --name:應用的名稱。查看應用信息的時候可以用到。
- -o --output :標準輸出日志文件的路徑。
- -e --error :錯誤輸出日志文件的路徑。
- --interpreter :the interpreter pm2 should use for executing app (bash, python...)。比如你用的coffee script來編寫應用。
完整命令行參數列表:地址
pm2 start app.js --watch -i 2
pm2的fork啟動模式和cluster模式的區別
參考文檔 文檔最后
重啟
- pm2 restart app.js
停止
停止特定的應用。可以先通過pm2 list獲取應用的名字(--name指定的)或者進程id。
pm2 stop app_name|app_id
如果要停止所有應用,可以
pm2 stop all
刪除
類似pm2 stop,如下
pm2 delete app_name|app_id
pm2 delete all
查看進程狀態
pm2 list
查看某個進程的信息
pm2 describe 0
配置文件
簡單說明
- 配置文件里的設置項,跟命令行參數基本是一一對應的。
- 可以選擇yaml或者json文件,就看個人喜好了。
- json格式的配置文件,pm2當作普通的js文件來處理,所以可以在里面添加注釋或者編寫代碼,這對于動態調整配置很有好處
- 如果啟動的時候指定了配置文件,那么命令行參數會被忽略。(個別參數除外,比如--env)
配置項
{
"name" : "fis-receiver", // 應用名稱
"script" : "./bin/www", // 實際啟動腳本
"cwd" : "./", // 當前工作路徑
"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" // 環境變量,object類型,如{"NODE_ENV":"production", "ID": "42"};
},
"instances" : "max", // 開啟進程數,可為數值,也可為max。與服務器cpu核數相關。應用啟動實例個數,僅在cluster模式有效,默認為fork;
"exec_mode" : "cluster" // 應用啟動模式,支持fork和cluster模式;cluster(多核推薦)
"min_uptime": "60s", // 應用運行少于時間被認為是異常啟動;
"max_restarts": 30, // 最大異常重啟次數,即小于min_uptime運行時間重啟次數;
"max_memory_restart": "300M", // 最大內存限制數,超出自動重啟;
"autorestart": true, // 默認為true, 發生異常的情況下自動重啟;
}
例子
- 舉個簡單例子,完整配置說明請參考官方文檔。 自定義啟動文件,創建一個test.json的示例文件,格式如下:
{
"name" : "fis-receiver", // 應用名稱
"script" : "./bin/www", // 實際啟動腳本
"cwd" : "./", // 當前工作路徑
"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" // 環境參數,當前指定為生產環境
}
}
參數說明
apps:json結構,apps是一個數組,每一個數組成員就是對應一個pm2中運行的應用
name:應用程序的名稱
cwd:應用程序所在的目錄
script:應用程序的腳本路徑
exec_interpreter:應用程序的腳本類型,這里使用的shell,默認是nodejs
minuptime:最小運行時間,這里設置的是60s即如果應用程序在60s內退出,pm2會認為程序異常退出,此時觸發重啟maxrestarts設置數量
autorestart 默認為true, 發生異常的情況下自動重啟;
max_restarts:設置應用程序異常退出重啟的次數,默認15次(從0開始計數)
exec_mode:應用程序啟動模式,這里設置的是cluster(集群),默認是fork
error_file:自定義應用程序的錯誤日志文件
out_file:自定義應用程序日志文件
pid_file:自定義應用程序的pid文件
watch:是否啟用監控模式,默認是false。如果設置成true,當應用程序變動時,pm2會自動重載。這里也可以設置你要監控的文件。
maxmemoryrestart:當內存超過設置的數量時自動重啟。 如果工程中有比較棘手的內存泄露問題,這個算是一個折中方案。
instances: 啟用多少個實例,可用于負載均衡。僅在cluster模式有效,默認為fork; cron_restart crontab時間格式,定時重啟應用,目前只支持cluster模式;
自動重啟
前面已經提到了,這里貼命令行,更多點擊
pm2 start app.js --watch
這里是監控整個項目的文件,如果只想監聽指定文件和目錄,建議通過配置文件的watch、ignore_watch字段來設置。
環境切換
在實際項目開發中,我們的應用經常需要在多個環境下部署,比如開發環境、測試環境、生產環境等。在不同環境下,有時候配置項會有差異,比如鏈接的數據庫地址不同等。
對于這種場景,pm2也是可以很好支持的。首先通過在配置文件中通過env_xx來聲明不同環境的配置,然后在啟動應用時,通過--env參數指定運行的環境。
環境配置聲明
首先,在配置文件中,通過env選項聲明多個環境配置。簡單說明下:
- env為默認的環境配置(生產環境),envdev、envtest則分別是開發、測試環境。可以看到,不同環境下的NODEENV、REMOTEADDR字段的值是不同的。
- 在應用中,可以通過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/"
}
啟動指明環境
假設通過下面啟動腳本(開發環境),那么,此時process.env.REMOTE_ADDR的值就是相應的 http://wdev.example.com/ ,可以自己試驗下。
pm2 start app.js --env dev
負載均衡
命令如下,表示開啟三個進程。如果-i 0,則會根據機器當前核數自動開啟盡可能多的進程。
pm2 start app.js -i 3 # 開啟三個進程
pm2 start app.js -i max # 根據機器CPU核數,開啟對應數目的進程
參考文檔:點擊查看
日志查看
除了可以打開日志文件查看日志外,還可以通過pm2 logs來查看實時日志。這點對于線上問題排查非常重要。
比如某個node服務突然異常重啟了,那么可以通過pm2提供的日志工具來查看實時日志,看是不是腳本出錯之類導致的異常重啟
pm2 logs
指令tab補全
運行pm2 --help,可以看到pm2支持的子命令還是蠻多的,這個時候,自動完成的功能就很重要了。
運行如下命令。恭喜,已經能夠通過tab自動補全了。細節可參考這里
pm2 completion install
source ~/.bash_profile
開機自動啟動
可以通過pm2 startup來實現開機自啟動。細節可參考。大致流程如下
1.通過pm2 save保存當前進程狀態。
2.通過pm2 startup [platform]生成開機自啟動的命令。(記得查看控制臺輸出)
3.將步驟2生成的命令,粘貼到控制臺進行,搞定。
傳入node args
直接上例子,分別是通過命令行和配置文件
命令行
pm2 start app.js --node-args="--harmony"
配置文件
{
"name" : "oc-server",
"script" : "app.js",
"node_args" : "--harmony"
}
實例說明
假設是在centos下,那么運行如下命令,搞定。強烈建議運行完成之后,重啟機器,看是否設置成功。
[root@iZ94wb7tioqZ option_analysis]# pm2 save
[root@iZ94wb7tioqZ option_analysis]# pm2 startup centos
[PM2] Generating system init script in /etc/init.d/pm2-init.sh
[PM2] Making script booting at startup...
[PM2] /var/lock/subsys/pm2-init.sh lockfile has been added
[PM2] -centos- Using the command:
su -c "chmod +x /etc/init.d/pm2-init.sh; chkconfig --add pm2-init.sh"
[PM2] Done.
[root@iZ94wb7tioqZ option_analysis]# pm2 save
[PM2] Dumping processes
遠程部署
可參考官方文檔,配置也不復雜,用到的時候再來填寫這里的坑。TODO
監控(monitor)
運行如下命令,查看當前通過pm2運行的進程的狀態。
pm2 monit
看到類似輸出
[root@oneday-dev0 server]# pm2 monit
? PM2 monitoring (To go further check out https://app.keymetrics.io) [ ] 0 %
? PM2 monitoring (To go further check o[||||||||||||||| ] 196.285 MB
● fis-receiver [ ] 0 %
[1] [fork_mode] [||||| ] 65.773 MB
● www [ ] 0 %
[2] [fork_mode] [||||| ] 74.426 MB
● oc-server [ ] 0 %
[3] [fork_mode] [|||| ] 57.801 MB
● pm2-http-interface [ ] stopped
[4] [fork_mode] [ ] 0 B
● start-production
[5] [fork_mode]
內存使用超過上限自動重啟
如果想要你的應用,在超過使用內存上限后自動重啟,那么可以加上--max-memory-restart參數。(有對應的配置項)
pm2 start big-array.js --max-memory-restart 20M
更新pm2
$ pm2 save # 記得保存進程狀態
$ npm install pm2 -g
$ pm2 update
Web API
如果你不僅僅想監控被pm2管理的進程,還需要監控進程所運行的機器的信息,你可以使用下面這個API
$ pm2 web
pm2會啟動一個叫做pm2-http-interface的進程提供web服務。你打開瀏覽器輸入http://127.0.0.1:9615,是不是被看到的結果驚艷到了。
pm2 + nginx
無非就是在nginx上做個反向代理配置,直接貼配置。 官方文檔
upstream my_nodejs_upstream {
server 127.0.0.1:3001;
}
server {
listen 80;
server_name my_nodejs_server;
root /home/www/project_root;
location / {
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header Host $http_host;
proxy_set_header X-NginX-Proxy true;
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";
proxy_max_temp_file_size 0;
proxy_pass http://my_nodejs_upstream/;
proxy_redirect off;
proxy_read_timeout 240s;
}
}
pm2編程接口
如果想把pm2的進程監控,跟其他自動化流程整合起來,pm2的編程接口就很有用了。細節可參考官方文檔
模塊擴展系統
pm2支持第三方擴展,比如常用的log rotate等。可參考官方文檔