PM2實用入門指南

簡介

PM2是node進程管理工具，可以利用它來簡化很多node應用管理的繁瑣任務，如性能監控、自動重啟、負載均衡等，而且使用非常簡單。

下面就對PM2進行入門性的介紹，基本涵蓋了PM2的常用的功能和配置。

安裝

全局安裝，簡直不能更簡單。

npm install -g pm2

目錄介紹

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

入門教程

挑我們最愛的express應用來舉例。一般我們都是通過npm start啟動應用，其實就是調用node ./bin/www。那么，換成pm2就是

注意，這里用了--watch參數，意味着當你的express應用代碼發生變化時，pm2會幫你重啟服務，多貼心。

pm2 start ./bin/www --watch

入門太簡單了，沒什么好講的。直接上官方文檔：http://pm2.keymetrics.io/docs/usage/quick-start

常用命令

啟動

參數說明：

• --watch：監聽應用目錄的變化，一旦發生變化，自動重啟。如果要精確監聽、不見聽的目錄，最好通過配置文件。
• -i --instances：啟用多少個實例，可用於負載均衡。如果-i 0或者-i max，則根據當前機器核數確定實例數目。
• --ignore-watch：排除監聽的目錄/文件，可以是特定的文件名，也可以是正則。比如--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來編寫應用。

完整命令行參數列表：地址

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

查看進程狀態

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                                     │
└───────────────────┴──────────────────────────────────────────────────────────────┘

配置文件

簡單說明

• 配置文件里的設置項，跟命令行參數基本是一一對應的。
• 可以選擇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"  // 環境參數，當前指定為生產環境
  }
}

自動重啟

前面已經提到了，這里貼命令行，更多點擊這里。

pm2 start app.js --watch

這里是監控整個項目的文件，如果只想監聽指定文件和目錄，建議通過配置文件的watch、ignore_watch字段來設置。

環境切換

在實際項目開發中，我們的應用經常需要在多個環境下部署，比如開發環境、測試環境、生產環境等。在不同環境下，有時候配置項會有差異，比如鏈接的數據庫地址不同等。

對於這種場景，pm2也是可以很好支持的。首先通過在配置文件中通過env_xx來聲明不同環境的配置，然后在啟動應用時，通過--env參數指定運行的環境。

環境配置聲明

首先，在配置文件中，通過env選項聲明多個環境配置。簡單說明下：

• env為默認的環境配置（生產環境），env_dev、env_test則分別是開發、測試環境。可以看到，不同環境下的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/"
  }

啟動指明環境

假設通過下面啟動腳本（開發環境），那么，此時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

官方文檔：http://pm2.keymetrics.io/docs/usage/deployment/#getting-started

監控(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

官方文檔：http://pm2.keymetrics.io/docs/usage/update-pm2/#updating-pm2

$ pm2 save # 記得保存進程狀態
$ npm install pm2 -g
$ pm2 update

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;
    }
}

官方文檔：http://pm2.keymetrics.io/docs/tutorials/pm2-nginx-production-setup

在線監控系統

收費服務，使用超級簡單，可以方便的對進程的服務情況進行監控。可以試用下，地址在這里。

這里貼個項目中試用的截圖。

pm2編程接口

如果想把pm2的進程監控，跟其他自動化流程整合起來，pm2的編程接口就很有用了。細節可參考官方文檔：
http://pm2.keymetrics.io/docs/usage/pm2-api/

模塊擴展系統

pm2支持第三方擴展，比如常用的log rotate等。可參考官方文檔。

寫在后面

pm2的文檔已經寫的很好了，學習成本很低，即使是沒用過pm2的小伙伴，基本上照着getting started的例子就可以把項目給跑起來，所以文中不少地方都是建議直接參看官方文檔。

。。。