PM2實用入門指南

來源：https://www.cnblogs.com/chyingp/p/pm2-documentation.html

 

 

簡介

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，以下

1.  
   pm2 stop app_name|app_id
2.  
   pm2 stop all

查看進程狀態

pm2 list

查看某個進程的信息

1.  
   [root @iZ94wb7tioqZ pids]# pm2 describe 0
2.  
   Describing process with id 0 - name oc-server
3.  
   ┌───────────────────┬──────────────────────────────────────────────────────────────┐
4.  
   │ status │ online │
5.  
   │ name │ oc-server │
6.  
   │ id │ 0 │
7.  
   │ path │ / data/file/qiquan/over_the_counter/server/bin/www │
8.  
   │ args │ │
9.  
   │ exec cwd │ /data/file/qiquan/over_the_counter/server │
10.  
    │ error log path │ /data/file/qiquan/over_the_counter/server/logs/app-err-0.log │
11.  
    │ out log path │ /data/file/qiquan/over_the_counter/server/logs/app-out-0.log │
12.  
    │ pid path │ /root/.pm2/pids/oc-server- 0.pid │
13.  
    │ mode │ fork_mode │
14.  
    │ node v8 arguments │ │
15.  
    │ watch & reload │ │
16.  
    │ interpreter │ node │
17.  
    │ restarts │ 293 │
18.  
    │ unstable restarts │ 0 │
19.  
    │ uptime │ 87m │
20.  
    │ created at │ 2016-08-26T08:13:43.705Z │
21.  
    └───────────────────┴──────────────────────────────────────────────────────────────┘

配置文件

簡單說明

• 配置文件裏的設置項，跟命令行參數基本是一一對應的。
• 能夠選擇yaml或者json文件，就看我的洗好了。
• json格式的配置文件，pm2看成普通的js文件來處理，因此能夠在裏面添加註釋或者編寫代碼，這對於動態調整配置頗有好處。
• 若是啓動的時候指定了配置文件，那麼命令行參數會被忽略。（個別參數除外，好比--env）

例子

舉個簡單例子，完整配置說明請參考官方文檔。

1.  
   {
2.  
   "name" : "fis-receiver", // 應用名稱
3.  
   "script" : "./bin/www", // 實際啓動腳本
4.  
   "cwd" : "./", // 當前工做路徑
5.  
   "watch": [ // 監控變化的目錄，一旦變化，自動重啓
6.  
   "bin",
7.  
   "routers"
8.  
   ],
9.  
   "ignore_watch" : [ // 從監控目錄中排除
10.  
    "node_modules",
11.  
    "logs",
12.  
    "public"
13.  
    ],
14.  
    "watch_options": {
15.  
    "followSymlinks": false
16.  
    },
17.  
    "error_file" : "./logs/app-err.log", // 錯誤日誌路徑
18.  
    "out_file" : "./logs/app-out.log", // 普通日誌路徑
19.  
    "env": {
20.  
    "NODE_ENV": "production" // 環境參數，當前指定爲生產環境
21.  
    }
22.  
    }

自動重啓

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

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等來讀取配置中生命的變量。

1.  
   "env": {
2.  
   "NODE_ENV": "production",
3.  
   "REMOTE_ADDR": "http://www.example.com/"
4.  
   },
5.  
   "env_dev": {
6.  
   "NODE_ENV": "development",
7.  
   "REMOTE_ADDR": "http://wdev.example.com/"
8.  
   },
9.  
   "env_test": {
10.  
    "NODE_ENV": "test",
11.  
    "REMOTE_ADDR": "http://wtest.example.com/"
12.  
    }

啓動指明環境

假設經過下面啓動腳本（開發環境），那麼，此時process.env.REMOTE_ADDR的值就是相應的 http://wdev.example.com/ ，能夠本身試驗下。

pm2 start app.js --env dev

負載均衡

命令以下，表示開啓三個進程。若是-i 0，則會根據機器當前核數自動開啓儘量多的進程。

1.  
   pm2 start app.js -i 3 # 開啓三個進程
2.  
   pm2 start app.js -i max # 根據機器CPU核數，開啓對應數目的進程

參考文檔：點擊查看

日誌查看

除了能夠打開日誌文件查看日誌外，還能夠經過pm2 logs來查看實時日誌。這點對於線上問題排查很是重要。

好比某個node服務忽然異常重啓了，那麼能夠經過pm2提供的日誌工具來查看實時日誌，看是否是腳本出錯之類致使的異常重啓。

pm2 logs

指令tab補全

運行pm2 --help，能夠看到pm2支持的子命令仍是蠻多的，這個時候，自動完成的功能就很重要了。

運行以下命令。恭喜，已經可以經過tab自動補全了。細節可參考這裏。

1.  
   pm2 completion install
2.  
   source ~/.bash_profile

開機自動啓動

能夠經過pm2 startup來實現開機自啓動。細節可參考。大體流程以下

1. 經過pm2 save保存當前進程狀態。
2. 經過pm2 startup [platform]生成開機自啓動的命令。（記得查看控制檯輸出）
3. 將步驟2生成的命令，粘貼到控制檯進行，搞定。

傳入node args

直接上例子，分別是經過命令行和配置文件。

命令行：

pm2 start app.js --node-args="--harmony"

配置文件：

1.  
   {
2.  
   "name" : "oc-server",
3.  
   "script" : "app.js",
4.  
   "node_args" : "--harmony"
5.  
   }

實例說明

假設是在centos下，那麼運行以下命令，搞定。強烈建議運行完成以後，重啓機器，看是否設置成功。

1.  
   [ root@iZ94wb7tioqZ option_analysis]# pm2 save
2.  
   [ root@iZ94wb7tioqZ option_analysis]# pm2 startup centos
3.  
   [ PM2] Generating system init script in /etc/init.d/pm2-init.sh
4.  
   [ PM2] Making script booting at startup...
5.  
   [ PM2] /var/lock/subsys/pm2-init.sh lockfile has been added
6.  
   [ PM2] -centos- Using the command:
7.  
   su -c "chmod +x /etc/init.d/pm2-init.sh; chkconfig --add pm2-init.sh"
8.  
    
9.  
   [ PM2] Done.
10.  
    [ root@iZ94wb7tioqZ option_analysis]# pm2 save
11.  
    [ PM2] Dumping processes

遠程部署

可參考官方文檔，配置也不復雜，用到的時候再來填寫這裏的坑。TODO

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

監控(monitor)

運行以下命令，查看當前經過pm2運行的進程的狀態。

pm2 monit

看到相似輸出

1.  
   [ root@oneday-dev0 server]# pm2 monit
2.  
   ⌬ PM2 monitoring (To go further check out https://app.keymetrics.io)
3.  
   [ ] 0 %
4.  
   ⌬ PM2 monitoring (To go further check o[||||||||||||||| ] 196.285 MB
5.  
    
6.  
   ● fis-receiver [ ] 0 %
7.  
   [ 1] [fork_mode] [||||| ] 65.773 MB
8.  
    
9.  
   ● www [ ] 0 %
10.  
    [ 2] [fork_mode] [||||| ] 74.426 MB
11.  
     
12.  
    ● oc-server [ ] 0 %
13.  
    [ 3] [fork_mode] [|||| ] 57.801 MB
14.  
     
15.  
    ● pm2-http- interface [ ] stopped
16.  
    [4] [fork_mode] [ ] 0 B
17.  
     
18.  
    ● start-production
19.  
    [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

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

pm2 + nginx

無非就是在nginx上作個反向代理配置，直接貼配置。

1.  
    
2.  
   upstream my_nodejs_upstream {
3.  
   server 127.0.0.1:3001;
4.  
   }
5.  
    
6.  
   server {
7.  
   listen 80;
8.  
   server_name my_nodejs_server;
9.  
   root /home/www/project_root;
10.  
     
11.  
    location / {
12.  
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
13.  
    proxy_set_header Host $http_host;
14.  
    proxy_set_header X-NginX-Proxy true;
15.  
    proxy_http_version 1.1;
16.  
    proxy_set_header Upgrade $http_upgrade;
17.  
    proxy_set_header Connection "upgrade";
18.  
    proxy_max_temp_file_size 0;
19.  
    proxy_pass http://my_nodejs_upstream/;
20.  
    proxy_redirect off;
21.  
    proxy_read_timeout 240s;
22.  
    }
23.  
    }

官方文檔：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的例子就能夠把項目給跑起來，因此文中很多地方都是建議直接參看官方文檔。