碼上歡樂
相關內容    簡體    繁體

pm2 ——帶有負載均衡功能的Node應用的進程管理器

本文轉載自   查看原文   2020-04-17 15:40   722 

pm2常用的命令用法介紹

 

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

 

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

 

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

簡介

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

查看某個進程的信息

  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" // 環境參數，當前指定為生產環境 } }

自動重啟

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

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

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等。可參考官方文檔。
​
​
​
​

二、安裝

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

再創建相關軟連接

三、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

四、PM2目錄結構

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

 
  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

五、自定義啟動文件

創建一個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會自動重載。這里也可以設置你要監控的文件。

詳細參數列表：見附件八

六、實例

已上面的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    #啟動，如下圖：
 
  1. # pm2 list    #查看pm2進程，如下圖：
 

 

# dockerfile示例

COPY package.json /app/package.json
RUN yarn config set registry https://registry.npm.taobao.org \
&& yarn config set sass_binary_site http://cdn.npm.taobao.org/dist/node-sass \
&& yarn install \
&& yarn global add pm2

COPY . /app
# ENV NODE_PATH=/app/node_modules
# ENV PATH=/app/node_modules/.bin:$PATH
RUN yarn build

　　

 

​


免責聲明！

本站轉載的文章為個人學習借鑒使用，本站對版權不負任何法律責任。如果侵犯了您的隱私權益，請聯系本站郵箱yoyou2525@163.com刪除。



猜您在找 nodeJS進程管理器pm2 pm2使用 node 進程管理 使用pm2進行進程管理 使用 PM2 管理nodejs進程 使用 PM2 管理nodejs進程 pm2 代替 Supervisor 管理進程 使用pm2管理nodejs應用 NLB網路負載均衡管理器詳解 pm2好用的node進程管理工具，監控進程開機自啟動,java進程配置，安裝Nodejs環境 Node之pm2
 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM