PM2是node進程管理工具，可以利用它來簡化很多node應用管理的繁瑣任務，如性能監(jiān)控、自動重啟、負載均衡等，而且使用非常簡單。
下面就對PM2進行入門性的介紹，基本涵蓋了PM2的常用的功能和配置。
安裝 PM2
$ npm install pm2 -g
啟動一個應用程序
$ pm2 start app.js
更新 PM2
# 安裝最新的pm2
$ pm2 save # 記得保存進程狀態(tài)
$ npm install pm2 -g
$ pm2 update
目錄介紹
pm2安裝好后，會自動創(chuàng)建下面目錄。看文件名基本就知道干嘛的了，就不翻譯了。
-
$HOME/.pm2will contain all PM2 related files -
$HOME/.pm2/logswill contain all applications logs -
$HOME/.pm2/pidswill contain all applications pids -
$HOME/.pm2/pm2.logPM2 logs -
$HOME/.pm2/pm2.pidPM2 pid -
$HOME/.pm2/rpc.sockSocket file for remote commands -
$HOME/.pm2/pub.sockSocket file for publishable events -
$HOME/.pm2/conf.jsPM2 Configuration
入門教程
挑我們最愛的express應用來舉例。一般我們都是通過npm start啟動應用，其實就是調用node ./bin/www。那么，換成pm2就是
注意，這里用了--watch參數(shù)，意味著當你的express應用代碼發(fā)生變化時，pm2會幫你重啟服務，多貼心。
pm2 start ./bin/www --watch
入門太簡單了，沒什么好講的。直接上官方文檔：http://pm2.keymetrics.io/docs/usage/quick-start
常用命令
啟動
參數(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
重啟
pm2 restart app.js
停止
停止特定的應用。可以先通過pm2 list獲取應用的名字（--name指定的）或者進程id。
pm2 stop app_name|app_id
如果要停止所有應用，可以
pm2 stop all
刪除
類似pm2 stop，如下
pm2 stop app_name|app_id
pm2 stop all
查看進程狀態(tài)
pm2 list
查看某個進程的信息
[root@iZ94wb7tioqZ pids]# pm2 describe 0
Describing process with id 0 - name oc-server
┌───────────────────┬──────────────────────────────────────────────────────────────┐
│ status │ online │
│ name │ oc-server │
│ id │ 0 │
│ path │ /data/file/qiquan/over_the_counter/server/bin/www │
│ args │ │
│ exec cwd │ /data/file/qiquan/over_the_counter/server │
│ error log path │ /data/file/qiquan/over_the_counter/server/logs/app-err-0.log │
│ out log path │ /data/file/qiquan/over_the_counter/server/logs/app-out-0.log │
│ pid path │ /root/.pm2/pids/oc-server-0.pid │
│ mode │ fork_mode │
│ node v8 arguments │ │
│ watch & reload │ │
│ interpreter │ node │
│ restarts │ 293 │
│ unstable restarts │ 0 │
│ uptime │ 87m │
│ created at │ 2016-08-26T08:13:43.705Z │
└───────────────────┴──────────────────────────────────────────────────────────────┘
配置文件
簡單說明
- 配置文件里的設置項，跟命令行參數(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)境參數(shù)，當前指定為生產(chǎn)環(huán)境
}
}
自動重啟
前面已經(jīng)提到了，這里貼命令行，更多點擊這里。
pm2 start app.js --watch
這里是監(jiān)控整個項目的文件，如果只想監(jiān)聽指定文件和目錄，建議通過配置文件的watch、ignore_watch字段來設置。
環(huán)境切換
在實際項目開發(fā)中，我們的應用經(jīng)常需要在多個環(huán)境下部署，比如開發(fā)環(huán)境、測試環(huán)境、生產(chǎn)環(huán)境等。在不同環(huán)境下，有時候配置項會有差異，比如鏈接的數(shù)據(jù)庫地址不同等。
對于這種場景，pm2也是可以很好支持的。首先通過在配置文件中通過env_xx來聲明不同環(huán)境的配置，然后在啟動應用時，通過--env參數(shù)指定運行的環(huán)境。
環(huán)境配置聲明
首先，在配置文件中，通過env選項聲明多個環(huán)境配置。簡單說明下：
-
env為默認的環(huán)境配置（生產(chǎ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的值就是相應的 http://wdev.example.com/ ，可以自己試驗下。
pm2 start app.js --env dev
負載均衡
命令如下，表示開啟三個進程。如果-i 0，則會根據(jù)機器當前核數(shù)自動開啟盡可能多的進程。
pm2 start app.js -i 3 # 開啟三個進程
pm2 start app.js -i max # 根據(jù)機器CPU核數(shù)，開啟對應數(shù)目的進程
參考文檔：點擊查看
日志查看
除了可以打開日志文件查看日志外，還可以通過pm2 logs來查看實時日志。這點對于線上問題排查非常重要。
比如某個node服務突然異常重啟了，那么可以通過pm2提供的日志工具來查看實時日志，看是不是腳本出錯之類導致的異常重啟。
pm2 logs
指令tab補全
運行pm2 --help，可以看到pm2支持的子命令還是蠻多的，這個時候，自動完成的功能就很重要了。
運行如下命令。恭喜，已經(jīng)能夠通過tab自動補全了。細節(jié)可參考這里。
pm2 completion install
source ~/.bash_profile
開機自動啟動
可以通過pm2 startup來實現(xiàn)開機自啟動。細節(jié)可參考。大致流程如下
- 通過
pm2 save保存當前進程狀態(tài)。 - 通過
pm2 startup [platform]生成開機自啟動的命令。（記得查看控制臺輸出） - 將步驟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
監(jiān)控(monitor)
運行如下命令，查看當前通過pm2運行的進程的狀態(tài)。
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參數(shù)。（有對應的配置項）
pm2 start big-array.js --max-memory-restart 20M
常用命令一覽
# 普通 General
$ npm install pm2 -g # 安裝 PM2
$ pm2 start app.js # 啟動，守護進程，自動重啟應用程序 Start, Daemonize and auto-restart application (Node)
$ pm2 start app.py # 啟動，守護進程，自動重啟python應用程序 Start, Daemonize and auto-restart application (Python)
$ pm2 start npm -- start # 啟動，守護進程，自動重啟node應用程序 Start, Daemonize and auto-restart Node application
# 集群模式 (只支持node進程) Cluster Mode (Node.js only)
$ pm2 start app.js -i 4 # 在集群模式下，啟動4個應用程序實例 Start 4 instances of application in cluster mode
# 同時，將網(wǎng)絡請求，負載均衡到每個應用實例 it will load balance network queries to each app
$ pm2 reload all # 0秒重啟所有應用 Zero Second Downtime Reload
$ pm2 scale [app-name] 10 # 將應用進程調整到10 Scale Cluster app to 10 process
# 進程監(jiān)控 Scale Cluster app to 10 process
$ pm2 list # 列出所有用PM2啟動的進程 List all processes started with PM2
$ pm2 monit # 顯示每個應用占用的cpu和內存 Display memory and cpu usage of each app
$ pm2 show [app-name] # 顯示某個進程的所有信息 Show all informations about application
# 日志管理 Log management
$ pm2 logs # 顯示所有應用的日志 Display logs of all apps
$ pm2 logs [app-name] # 顯示某個應用的日志 Display logs for a specific app
$ pm2 logs --json # json化日志 Logs in JSON format
$ pm2 flush
$ pm2 reloadLogs
# 進程狀態(tài)管理 Process State Management
$ pm2 start app.js --name="api" # 啟動一個應用并命名為api。 Start application and name it "api"
$ pm2 start app.js -- -a 34 # 啟動一個應用，并傳遞“-a 34”的參數(shù)。 Start app and pass option "-a 34" as argument
$ pm2 start app.js --watch # 重啟一個應用，當文件改變的時候。Restart application on file change
$ pm2 start script.sh # 啟動一個bash腳本。Start bash script
$ pm2 start app.json # 啟動在app.json中聲明的所有應用。Start all applications declared in app.json
$ pm2 reset [app-name] # 重置所有計數(shù)器。Reset all counters
$ pm2 stop all # 停止所有應用。Stop all apps
$ pm2 stop 0 # 停止id 為0的應用。Stop process with id 0
$ pm2 restart all # 重啟所有應用。Restart all apps
$ pm2 gracefulReload all # 在集群模式下，平穩(wěn)的重加載所有應用。Graceful reload all apps in cluster mode
$ pm2 delete all # 殺掉所有應用。Kill and delete all apps
$ pm2 delete 0 # 殺掉id為0的進程。Delete app with id 0
# 啟動／引導管理 Startup/Boot management
$ pm2 startup # 檢測init系統(tǒng)，在啟動時生成和配置pm2。Detect init system, generate and configure pm2 boot on startup
$ pm2 save # 保存當前進程列表。Save current process list
$ pm2 resurrect # 恢復以前保存的進程。Restore previously save processes
$ pm2 unstartup # 停用和刪除啟動系統(tǒng)。Disable and remove startup system
$ pm2 update # 保存進程，終止PM2并恢復進程。Save processes, kill PM2 and restore processes
$ pm2 generate # 生成樣本json配置文件。Generate a sample json configuration file
# 部署 Deployment
$ pm2 deploy app.json prod setup # 設置“生產(chǎn)環(huán)境”遠程服務器。 Setup "prod" remote server
$ pm2 deploy app.json prod # 更新“生產(chǎn)環(huán)境”遠程服務器。 Update "prod" remote server
$ pm2 deploy app.json prod revert 2 # 將“生產(chǎn)環(huán)境”遠程服務器恢復2。Revert "prod" remote server by 2
# 模塊系統(tǒng) Module system
$ pm2 module:generate [name] # 生成名稱為[name]的示例模塊。Generate sample module with name [name]
$ pm2 install pm2-logrotate # 安裝模塊（這里是日志循環(huán)系統(tǒng)）。Install module (here a log rotation system)
$ pm2 uninstall pm2-logrotate # 卸載模塊。Uninstall module
$ pm2 publish # 增量版本，git push和npm發(fā)布。Increment version, git push and npm publish
進程管理
列出正在運行的應用程序
$ pm2 list
很簡單的管理你的應用進程
$ pm2 stop <app_name|id|'all'|json_conf>
$ pm2 restart <app_name|id|'all'|json_conf>
$ pm2 delete <app_name|id|'all'|json_conf>
CPU/進程監(jiān)控
監(jiān)控所有啟動的進程：
$ pm2 monit
日志設施
實時顯示指定進程或所有進程的日志。提供標準，原始，JSON和格式輸出。
$ pm2 logs ['all'|app_name|app_id] [--json] [--format] [--raw]`
例子:
$ pm2 logs APP-NAME # Display APP-NAME logs
$ pm2 logs --json # JSON output
$ pm2 logs --format # Formated output
$ pm2 flush # Flush all logs
$ pm2 reloadLogs # Reload all logs
生成啟動腳本
/* PM2可以生成和配置啟動腳本，以在每次服務器重新啟動時保持PM2和您的進程活動。
支持init系統(tǒng)，如：systemd（Ubuntu 16，CentOS，Arch），upstart（Ubuntu 14/12），launchd（MacOSx，Darwin），rc.d（FreeBSD）。
自動檢測init系統(tǒng)+在服務器啟動時生成和設置PM2引導。 Auto detect init system + generate and setup PM2 boot at server startup */
$ pm2 startup
# 手動指定啟動系統(tǒng). Manually specify the startup system
# 可以是：systemd，upstart，launchd，rcd。
$ pm2 startup [platform]
# 在服務器啟動時禁用和刪除PM2引導。Disable and remove PM2 boot at server startup
$ pm2 unstartup
在重新啟動時保存/凍結進程列表：
$ pm2 save
模塊系統(tǒng) Module system
PM2嵌入了一個簡單而強大的模塊系統(tǒng)。安裝模塊很簡單：
$ pm2 install <module_name>
