PM2文檔
pm2 是一個帶有負載均衡功能的應用進程管理器.
-
首先安裝node
Linux Binaries下載地址：https://nodejs.org/dist/v4.2.1/node-v4.2.1-linux-x64.tar.gz
# wget --no-check-certifi
cate https://nodejs.org/dist/v4.2.1/node-v4.2.1-linux-x64.tar.gz -O /usr/local/src/node-v4.2.1-linux-x64.tar.gz
# tar zxf /usr/local/src/node-v4.2.1-linux-x64.tar.gz
# cp node-v4.2.1-linux-x64/bin/node /usr/local/bin/
# cp -r node-v4.2.1-linux-x64/lib/node_modules /usr/local/lib/
# ln -s /usr/local/lib/node_modules/npm/bin/npm-cli.js /usr/local/bin/npm
# npm install pm2@latest -g
如果你的主機無法連接公網，先找到能連公網的主機安裝上面的方法安裝pm2，然後copy 到你要安裝的主機。copy文件目錄如下：
/usr/local/bin/node
/usr/local/lib/node_modules/
創建相關軟連接
假設你現在已經寫好了一個app.js的文件，需要啟動，你可以使用PM2進行管理
# pm2 start app.js
# pm2 start app.js --name my-api// my-api為PM2進程名稱
# pm2 start app.js -i 0//根據CPU核數啟動進程個數
# pm2 start app.js --watch//實時監控app.js的方式啟動，當app.js文件有變動時，pm2會自動reload
# pm2 list
# pm2 show 0 或者 # pm2 info 0 //查看進程詳細信息，0為PM2進程id
# pm2 monit
# pm2 s
top all//停止PM2列表中所有的進程
# pm2 stop 0//停止PM2列表中進程為0的進程
# pm2 reload all//重載PM2列表中所有的進程
# pm2 reload 0//重載PM2列表中進程為0的進程
# pm2 restart all//重啟PM2列表中所有的進程
# pm2 restart 0//重啟PM2列表中進程為0的進程
# pm2 delete 0//刪除PM2列表中進程為0的進程
# pm2 delete all//刪除PM2列表中所有的進程
# pm2 logs [--raw]//Display all processes logs in streaming
# pm2 flush//Empty all log
file
# pm2 reloadLogs//Reload all logs
# npm install pm2@lastest -g//安裝最新的PM2版本
# pm2 updatePM2//升級pm2
# pm2 --help
默認的目錄是：當前用於的家目錄下的.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
創建一個test.json的示例文件，格式如下：
{
"apps":
{
"name": "test",
"cwd": "/data/release/ygb_nodejs",
"script": "./test.sh",
"exec_interpreter": "bash",
"min_uptime": "60s",
"max_restarts": 30,
"exec_mode" : "cluster_mode",
"error_file" : "./test-err.log",
"out_file": "./test-out.log",
"pid_file": "./test.pid"
"watch": false
}
}
說明：
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為例
# cd /data/release/ygb_nodejs
# cat > test.sh << EOF
> #!/bin/bash
>
> while true
> do
> echo "Test" >> 1.log
> sleep 5
> done
> EOF
#
chmod +x test.sh
# pm2 start test.json //啟動
# pm2 list //查看pm2進程
其他可參數見官網：
http://pm2.keymetrics.io/
Field
Type
Example
Description
name
string
"myAPI"
name your app will have in PM2
script
string
"bin/app.js"
path of your app
args
list
["--enable-logs", "-n", "15"]
arguments given to your app when it is launched
node_args
list
["--harmony", "--max-stack-size=1024"]
arguments given to node when it is launched
cwd
string
"/var/www/app/prod"
the directory from which your app will be launched
exec_mode
string
"cluster"
"fork" mode is used by default, "cluster" mode can be configured with instances field
instances
number
4
number of instances for your clustered app, 0 means as much instances as you have CPU cores. a negative value means CPU cores - value (e.g -1 on a 4 cores machine will spawn 3 instances)
exec_interpreter
string
"node"
defaults to "node". can be "python", "ruby", "bash" or whatever interpreter you wish to use. "none" will execute your app as a binary executable
log_date_format
string
"YYYY-MM-DD HH:mm Z"
format in which timestamps will be displayed in the logs
error_file
string
"/var/log/node-app/node-app.stderr.log"
path to the specified error log file. PM2 generates one by default if not specified and you can find it by typing pm2 desc <app id>
out_file
string
"/var/log/node-app/node-app.stdout.log"
path to the specified output log file. PM2 generates one by default if not specified and you can find it by typing pm2 desc <app id>
pid_file
string
"pids/node-geo-api.pid"
path to the specified pid file. PM2 generates one by default if not specified and you can find it by typing pm2 desc <app id>
merge_logs
boolean
false
defaults to false. if true, it will merge logs from all instances of the same app into the same file
cron_restart
string
"1 0 * * *"
a cron pattern to restart your app. only works in "cluster" mode for now. soon to be avaible in "fork" mode as well
watch
boolean
true
enables the watch feature, defaults to "false". if true, it will restart your app everytime a file change is detected on the folder or subfolder of your app.
ignore_watch
list
["[\/\\]\./", "node_modules"]
list of regex to ignore some file or folder names by the watch feature
min_uptime
number
1000
min uptime of the app to be considered started (i.e. if the app crashes in this time frame, the app will only be restarted the number set in max_restarts (default 15), after that it's errored)
max_restarts
number
10
number of consecutive unstable restarts (less than 1sec interval or custom time via min_uptime) before your app is considered errored and stop being
max_memory_restart
string
"150M"
your app will be restarted by PM2 if it exceeds the amount of memory specified. human-friendly format : it can be "10M", "100K", "2G" and so on...
env
object
{"NODE_ENV": "production", "ID": "42"}
env variables which will appear in your app
autorestart
boolean
false
true by default. if false, PM2 will not restart your app if it crashes or ends peacefully
vizion
boolean
false
true by default. if false, PM2 will start without vizion features (versioning control metadatas)
post_update
list
["npm install", "echo launching the app"]
a list of commands which will be executed after you perform a Pull/Upgrade operation from Keymetrics dashboard
force
boolean
true
defaults to false. if true, you can start the same script several times which is usually not allowed by PM2
next_gen_js
boolean
true
defaults to false. if true, PM2 will launch your app using embedded BabelJS features which means you can run ES6/ES7 javascript code
restart_delay
number
4000
time to wait before restarting a crashed app (in milliseconds). defaults to 0.
