pm2常用的命令用法介紹

　　pm2 是一個帶有負載均衡功能的Node應用的進程管理器.當你要把你的獨立代碼利用全部的服務器上的所有CPU,並保證進程永遠都活着,0秒的重載, PM2是完美的,下面我們來看pm2常用的命令用法介紹吧。

　　PM2 （github上的源碼）是開源的基於Nodejs的進程管理器，包括守護進程，監控，日志的一整套完整的功能，基本是Nodejs應用程序不二的守護進程選擇，事實上它並不僅僅可以啟動Nodejs的程序，只要是一般的腳本的程序它同樣可以勝任。

　　以下是pm2常用的命令行：

$ pm2 start app.js              # 啟動app.js應用程序

$ pm2 start app.js -i 4         # cluster mode 模式啟動4個app.js的應用實例     # 4個應用程序會自動進行負載均衡

$ pm2 start app.js --name="api" # 啟動應用程序並命名為 "api"

$ pm2 start app.js --watch      # 當文件變化時自動重啟應用

$ pm2 start script.sh           # 啟動 bash 腳本


$ pm2 list                      # 列表 PM2 啟動的所有的應用程序

$ pm2 monit                     # 顯示每個應用程序的CPU和內存占用情況

$ pm2 show [app-name]           # 顯示應用程序的所有信息


$ pm2 logs                      # 顯示所有應用程序的日志

$ pm2 logs [app-name]           # 顯示指定應用程序的日志

$ pm2 flush


$ pm2 stop all                  # 停止所有的應用程序

$ pm2 stop 0                    # 停止 id為 0的指定應用程序

$ pm2 restart all               # 重啟所有應用

$ pm2 reload all                # 重啟 cluster mode下的所有應用

$ pm2 gracefulReload all        # Graceful reload all apps in cluster mode

$ pm2 delete all                # 關閉並刪除所有應用

$ pm2 delete 0                  # 刪除指定應用 id 0

$ pm2 scale api 10              # 把名字叫api的應用擴展到10個實例

$ pm2 reset [app-name]          # 重置重啟數量


$ pm2 startup                   # 創建開機自啟動命令

$ pm2 save                      # 保存當前應用列表

$ pm2 resurrect                 # 重新加載保存的應用列表

$ pm2 update                    # Save processes, kill PM2 and restore processes

$ pm2 generate                  # Generate a sample json configuration file


$ pm2 deploy app.json prod setup    # Setup "prod" remote server

$ pm2 deploy app.json prod          # Update "prod" remote server

$ pm2 deploy app.json prod revert 2 # Revert "prod" remote server by 2


$ pm2 module:generate [name]    # Generate sample module with name [name]

$ pm2 install pm2-logrotate     # Install module (here a log rotation system)

$ pm2 uninstall pm2-logrotate   # Uninstall module

$ pm2 publish                   # Increment version, git push and npm publish

 

一.安裝

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

​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就是

pm2 start ./bin/www –watch

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

　　參數說明：

--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 restart app.js

四.停止

　　停止特定的應用。可以先通過pm2 list獲取應用的名字（–name指定的）或者進程id。

pm2 stop app_name|app_id

　　如果要停止所有應用，可以

pm2 stop all

五.查看進程狀態

pm2 list

六.配置文件

　　配置文件里的設置項，跟命令行參數基本是一一對應的。可以選擇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”: { “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/” }

　　env為默認的環境配置（生產環境），env_dev、env_test則分別是開發、測試環境。可以看到，不同環境下的NODE_ENV、REMOTE_ADDR字段的值是不同的。

　　在應用中，可以通過process.env.REMOTE_ADDR等來讀取配置中生命的變量。

　　假設通過下面啟動腳本（開發環境），那么，此時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 startup來實現開機自啟動。細節可參考。大致流程如下：

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

　　假設是在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

十二.監控(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 + 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 Hostproxy_add_x_forwarded_for; 
    proxy_set_header Hosthttp_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

 

文章來源：https://blog.csdn.net/sunscheung/article/details/79171608