pm2經常使用的命令用法介紹

時間  2019-11-10
標籤 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

簡介javascript

PM2是node進程管理工具，能夠利用它來簡化不少node應用管理的繁瑣任務，如性能監控、自動重啓、負載均衡等，並且使用很是簡單。php

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

安裝

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

​npm install -g pm2node

目錄介紹

pm2安裝好後，會自動建立下面目錄。看文件名基本就知道幹嗎的了，就不翻譯了。python

  • $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就是linux

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

pm2 start ./bin/www --watch

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

經常使用命令

啓動

參數說明：github

  • --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

查看某個進程的信息

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

配置文件

簡單說明

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

Alt text

開機自動啓動

能夠經過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下，那麼運行以下命令，搞定。強烈建議運行完成以後，重啓機器，看是否設置成功。

  1.  
    [ 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
  2.  
    [ PM2] Making script booting at startup...
  3.  
    [ PM2] /var/lock/subsys/pm2-init.sh lockfile has been added
  4.  
    [ PM2] -centos- Using the command:
  5.  
    su -c "chmod +x /etc/init.d/pm2-init.sh; chkconfig --add pm2-init.sh"
    ​[PM2] Done.
  6.  
    [ root@iZ94wb7tioqZ option_analysis]# pm2 save
    ​[PM2] Dumping processes

遠程部署

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

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

監控(monitor)

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

pm2 monit

看到相似輸出

  1.  
    [ 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
  2.  
    [ 4] [fork_mode] [ ] 0 B
    ​● start-production
  3.  
    [ 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上作個反向代理配置，直接貼配置。

  1.  
    upstream my_nodejs_upstream { server 127.0.0.1:3001;
  2.  
    } 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;
  3.  
    }
  4.  
    }

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

​

pm2編程接口

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

模塊擴展系統

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

2、安裝

Linux Binaries下載地址：https://nodejs.org/dist

  1. cd oneinstack/src
  2. wget https://nodejs.org/dist/v4.2.4/node-v4.2.4-linux-x64.tar.gz
  3. tar xzf node-v4.2.4-linux-x64.tar.gz
  4. cp node-v4.2.4-linux-x64/bin/node /usr/local/bin/
  5. cp -R node-v4.2.4-linux-x64/lib/node_modules /usr/local/lib/
  6. ln -s /usr/local/lib/node_modules/npm/bin/npm-cli.js /usr/local/bin/npm
  7. npm install pm2@latest -g #安裝最新版本pm2模塊

PS: 若是你的主機沒法鏈接公網，先找到能連公網的主機安裝上面的方法安裝pm2，而後拷貝到你要安裝的主機。拷貝以下目錄：

  1. /usr/local/bin/node
  2. /usr/local/lib/node_modules

再建立相關軟鏈接

3、PM2經常使用命令

假設你如今已經寫好了一個app.js的文件，須要啓動，你可使用pm2進行管理

1. 啓動

 
  1. # pm2 start app.js
  2. # pm2 start app.js --name my-api   #my-api爲PM2進程名稱
  3. # pm2 start app.js -i 0           #根據CPU核數啓動進程個數
  4. # pm2 start app.js --watch   #實時監控app.js的方式啓動，當app.js文件有變更時，pm2會自動reload

2. 查看進程

 
  1. # pm2 list
  2. # pm2 show 0 或者 # pm2 info 0  #查看進程詳細信息，0爲PM2進程id

3. 監控

 
  1. # pm2 monit

4. 中止

 
  1. # pm2 stop all  #中止PM2列表中全部的進程
  2. # pm2 stop 0    #中止PM2列表中進程爲0的進程

5. 重載

 
  1. # pm2 reload all    #重載PM2列表中全部的進程
  2. # pm2 reload 0     #重載PM2列表中進程爲0的進程

6. 重啓

 
  1. # pm2 restart all     #重啓PM2列表中全部的進程
  2. # pm2 restart 0      #重啓PM2列表中進程爲0的進程

7. 刪除PM2進程

 
  1. # pm2 delete 0     #刪除PM2列表中進程爲0的進程
  2. # pm2 delete all   #刪除PM2列表中全部的進程

8. 日誌操做

 
  1. # pm2 logs [--raw]   #Display all processes logs in streaming
  2. # pm2 flush              #Empty all log file
  3. # pm2 reloadLogs    #Reload all logs

9. 升級PM2

 
  1. # npm install pm2@lastest -g   #安裝最新的PM2版本
  2. # pm2 updatePM2                    #升級pm2

10. 更多命令參數請查看幫助

 
  1. # pm2 --help

4、PM2目錄結構

默認的目錄是：當前用於的家目錄下的.pm2目錄（此目錄能夠自定義，請參考：5、自定義啓動文件），詳細信息以下：

 
  1. $HOME/.pm2                   #will contain all PM2 related files
  2. $HOME/.pm2/logs           #will contain all applications logs
  3. $HOME/.pm2/pids           #will contain all applications pids
  4. $HOME/.pm2/pm2.log    #PM2 logs
  5. $HOME/.pm2/pm2.pid    #PM2 pid
  6. $HOME/.pm2/rpc.sock    #Socket file for remote commands
  7. $HOME/.pm2/pub.sock   #Socket file for publishable events
  8. $HOME/.pm2/conf.js       #PM2 Configuration

5、自定義啓動文件

建立一個test.json的示例文件，格式以下：

  1. {
  2.   "apps":
  3.     {
  4.       "name": "test",
  5.       "cwd": "/data/wwwroot/nodejs",
  6.       "script": "./test.sh",
  7.       "exec_interpreter": "bash",
  8.       "min_uptime": "60s",
  9.       "max_restarts": 30,
  10.       "exec_mode" : "cluster_mode",
  11.       "error_file" : "./test-err.log",
  12.       "out_file": "./test-out.log",
  13.       "pid_file": "./test.pid"
  14.       "watch": false
  15.     }
  16. }

說明：

apps：json結構，apps是一個數組，每個數組成員就是對應一個pm2中運行的應用

name：應用程序的名稱

cwd：應用程序所在的目錄

script：應用程序的腳本路徑

exec_interpreter：應用程序的腳本類型，這裏使用的shell，默認是nodejs

min_uptime：最小運行時間，這裏設置的是60s即若是應用程序在60s內退出，pm2會認爲程序異常退出，此時觸發重啓max_restarts設置數量

max_restarts：設置應用程序異常退出重啓的次數，默認15次（從0開始計數）

exec_mode：應用程序啓動模式，這裏設置的是cluster_mode（集羣），默認是fork

error_file：自定義應用程序的錯誤日誌文件

out_file：自定義應用程序日誌文件

pid_file：自定義應用程序的pid文件

watch：是否啓用監控模式，默認是false。若是設置成true，當應用程序變更時，pm2會自動重載。這裏也能夠設置你要監控的文件。

詳細參數列表：見附件八

6、實例

已上面的test.json爲例

 
  1. # cat > /data/wwwroot/nodejs/test.sh << EOF
  2. #!/bin/bash
  3. while :
  4. do
  5.     echo "Test" >> 1.log
  6.     sleep 5
  7. done
  8. EOF
 
  1. # chmod +x test.sh      #添加執行權限
  2. # pm2 start test.json    #啓動，以下圖：
  # pm2 list    #查看pm2進程，以下圖：
 
pm2 啓動項目報錯：

 

 解決方法：

執行了下面的命令將全部node.js和pm2進程都殺掉了

ps -ux | grep pm2        (ps -ux | grep node)

找到對應的pid，而後

kill -9 pid

而後在執行 pm2 start index.js就成功啓動了

 

 

​

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程