nodejs pm2教程(转载)

 

一、简介

pm2是一个带有负载均衡功能的应用进程管理器，类似有Supervisor，forever。

二、安装

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进程，如下图：

七、备注

其他可参数见官网：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.