pm2---node 進程管理工具

node 進程管理工具比較

  • supervisor:是開發環境用,修改命令後重啓應用,可是關閉控制檯以後,整個進程就掛了
  • forever:管理多個站點,每一個站點訪問量不大,不須要監控。
  • pm2:網站訪問量比較大,須要完整的監控界面。能夠後臺運行,關閉控制檯以後也不影響進程運行。

PM2 使用介紹:

P (rocess) M (anager)2html

  • PM2 是一個帶有負載均衡功能的 Node 應用的進程管理器,利用它來簡化不少node應用管理的繁瑣任務,如性能監控、自動重啓、負載均衡等,並且使用很是簡單
  • 當你要把你的獨立代碼利用所有的服務器上的全部 CPU,並保證進程永遠都活着,0 秒的重載, PM2 是完美的。它很是適合 IaaS 結構,但不要把它用於 PaaS 方案(隨後將開發 Paas 的解決方案)

備註:node

  • SaaS、PaaS 和 IaaS 是雲服務模式
  • SaaS 軟件即服務,例如 Google 的 Gmail 郵箱服務,面向應用型用戶
  • PaaS 平臺即服務,例如 Google 的 GAE,面向開發型用戶
  • IaaS 基礎架構即服務,例如亞馬遜的 AWS,IaaS 對於不知道新推出的應用程序/網站會有多成功的創業公司來講很是有用
  • 參考文檔 通俗易懂版本

PM2的主要特性:

  • 內建負載均衡(使用Node cluster 集羣模塊)
  • 後臺運行
  • 0秒停機重載,我理解大概意思是維護升級的時候不須要停機.?
  • 具備Ubuntu和CentOS 的啓動腳本
  • 中止不穩定的進程(避免無限循環)
  • 控制檯檢測
  • 提供 HTTP API
  • 遠程控制和實時的接口API ( Nodejs 模塊,容許和PM2進程管理器交互 )

準備工做-Express 項目建立 並啓動服務:

* express -e pm2-demo
* npm install
* npm start
複製代碼

安裝

`npm install -g 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
複製代碼

用法

$ npm install pm2 -g     # 命令行安裝 pm2
$ pm2 start app.js -i 4  # 後臺運行pm2,啓動4個app.js
                         # 也能夠把'max' 參數傳遞給 start
                         # 正確的進程數目依賴於Cpu的核心數目
$ pm2 start app.js --name my-api # 命名進程
$ pm2 list               # 顯示全部進程狀態
$ pm2 monit              # 監視全部進程
$ pm2 logs               # 顯示全部進程日誌
$ pm2 stop all           # 中止全部進程
$ pm2 restart all        # 重啓全部進程
$ pm2 reload all         # 0 秒停機重載進程 (用於 NETWORKED 進程)
$ pm2 stop 0             # 中止指定的進程
$ pm2 restart 0          # 重啓指定的進程
$ pm2 startup            # 產生 init 腳本 保持進程活着
$ pm2 web                # 運行健壯的 computer API endpoint (http://localhost:9615)
$ pm2 delete 0           # 殺死指定的進程
$ pm2 delete all         # 殺死所有進程
複製代碼

運行進程的不一樣方式

$ pm2 start app.js -i max    # 根據有效CPU數目啓動最大進程數目
$ pm2 start app.js -i 3      # 啓動3個進程
$ pm2 start app.js -x        #用fork模式啓動 app.js 而不是使用 cluster
$ pm2 start app.js -x -- -a 23   # 用fork模式啓動 app.js 而且傳遞參數 (-a 23)
$ pm2 start app.js --name serverone  # 啓動一個進程並把它命名爲 serverone
$ pm2 stop serverone       # 中止 serverone 進程
$ pm2 start app.json        # 啓動進程, 在 app.json裏設置選項
$ pm2 start app.js -i max -- -a 23                   #在--以後給 app.js 傳遞參數
$ pm2 start app.js -i max -e err.log -o out.log  # 啓動 並 生成一個配置文件
你也能夠執行用其餘語言編寫的app  ( fork 模式):
$ pm2 start my-bash-script.sh    -x --interpreter bash
$ pm2 start my-python-script.py -x --interpreter python

複製代碼

0 秒停機重載:這項功能容許你從新載入代碼而不用失去請求鏈接python

注意:

  • 僅能用於 web 應用
  • 運行於 Node 0.11.x 版本
  • 運行於 fork 模式(默認模式)

經常使用命令

啓動

參數說明:nginx

  • --watch:監聽應用目錄的變化,一旦發生變化,自動重啓。若是要精確監聽、不見聽的目錄,最好經過配置文件。
  • -i --instances:啓用多少個實例,可用於負載均衡。若是-i 0或者-i max,則根據當前機器核數肯定實例數目。
  • --ignore-watch:排除監聽的目錄/文件,能夠是特定的文件名,也能夠是正則。好比--ignore-watch="test node_modules "some scripts""
  • -n --name:應用的名稱。查看應用信息的時候能夠用到。
  • -o --output :標準輸出日誌文件的路徑。
  • -e --error :錯誤輸出日誌文件的路徑。
  • --interpreter :the interpreter pm2 should use for executing app (bash, python...)。好比你用的coffee script來編寫應用。

完整命令行參數列表:地址web

  • pm2 start app.js --watch -i 2

pm2的fork啓動模式和cluster模式的區別shell

參考文檔 文檔最後數據庫

重啓

  • pm2 restart app.js

中止

中止特定的應用。能夠先經過pm2 list獲取應用的名字(--name指定的)或者進程id。express

  • pm2 stop app_name|app_id

若是要中止全部應用,能夠npm

  • pm2 stop all

刪除

相似pm2 stop,以下編程

  • pm2 delete app_name|app_id
  • pm2 delete all

查看進程狀態

  • pm2 list

查看某個進程的信息

  • pm2 describe 0

配置文件

簡單說明

  • 配置文件裏的設置項,跟命令行參數基本是一一對應的。
  • 能夠選擇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"            // 環境變量,object類型,如{"NODE_ENV":"production", "ID": "42"};
    },
    "instances" : "max",                    // 開啓進程數,可爲數值,也可爲max。與服務器cpu核數相關。應用啓動實例個數,僅在cluster模式有效,默認爲fork;
    "exec_mode" : "cluster"                 // 應用啓動模式,支持fork和cluster模式;cluster(多核推薦)
    "min_uptime": "60s",                    // 應用運行少於時間被認爲是異常啓動;
    "max_restarts": 30,                     // 最大異常重啓次數,即小於min_uptime運行時間重啓次數;
    "max_memory_restart": "300M",           // 最大內存限制數,超出自動重啓;
    "autorestart": true,                    // 默認爲true, 發生異常的狀況下自動重啓;
}
複製代碼

例子

  • 舉個簡單例子,完整配置說明請參考官方文檔。 自定義啓動文件,建立一個test.json的示例文件,格式以下:
{
      "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"  // 環境參數,當前指定爲生產環境
      }
    }
複製代碼

參數說明

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

name:應用程序的名稱

cwd:應用程序所在的目錄

script:應用程序的腳本路徑

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

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

autorestart 默認爲true, 發生異常的狀況下自動重啓;

max_restarts:設置應用程序異常退出重啓的次數,默認15次(從0開始計數)

exec_mode:應用程序啓動模式,這裏設置的是cluster(集羣),默認是fork

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

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

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

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

maxmemoryrestart:當內存超過設置的數量時自動重啓。 若是工程中有比較棘手的內存泄露問題,這個算是一個折中方案。

instances: 啓用多少個實例,可用於負載均衡。僅在cluster模式有效,默認爲fork; cron_restart crontab時間格式,定時重啓應用,目前只支持cluster模式;

自動重啓

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

pm2 start app.js --watch

這裏是監控整個項目的文件,若是隻想監聽指定文件和目錄,建議經過配置文件的watch、ignore_watch字段來設置。

環境切換

在實際項目開發中,咱們的應用常常須要在多個環境下部署,好比開發環境、測試環境、生產環境等。在不一樣環境下,有時候配置項會有差別,好比連接的數據庫地址不一樣等。

對於這種場景,pm2也是能夠很好支持的。首先經過在配置文件中經過env_xx來聲明不一樣環境的配置,而後在啓動應用時,經過--env參數指定運行的環境。

環境配置聲明

首先,在配置文件中,經過env選項聲明多個環境配置。簡單說明下:

  • env爲默認的環境配置(生產環境),envdev、envtest則分別是開發、測試環境。能夠看到,不一樣環境下的NODEENV、REMOTEADDR字段的值是不一樣的。
  • 在應用中,能夠經過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的值就是相應的 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

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

官方文檔

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

Web API

若是你不只僅想監控被pm2管理的進程,還須要監控進程所運行的機器的信息,你可使用下面這個API

$ pm2 web

pm2會啓動一個叫作pm2-http-interface的進程提供web服務。你打開瀏覽器輸入http://127.0.0.1:9615,是否是被看到的結果驚豔到了。

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;
    }
}
複製代碼

pm2編程接口

若是想把pm2的進程監控,跟其餘自動化流程整合起來,pm2的編程接口就頗有用了。細節可參考官方文檔

模塊擴展系統

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

參考文檔

NodeJs之pm2

官網

pm2進程管理工具使用總結

node 版本管理工具nvm

相關文章
相關標籤/搜索