博客是我工作的好帮手，遇到困难就来博客找资料
分类： 系统运维
2017-07-10 11:37:57
PM2是node进程管理工具，可以利用它来简化很多node应用管理的繁琐任务，如性能监控、自动重启、负载均衡等，而且使用非常简单。
下面就对PM2进行入门性的介绍，基本涵盖了PM2的常用的功能和配置。
全局安装，简直不能更简单。
npm install -g pm2pm2安装好后，会自动创建下面目录。看文件名基本就知道干嘛的了，就不翻译了。
挑我们最爱的express应用来举例。一般我们都是通过npm start启动应用，其实就是调用node ./bin/www。那么，换成pm2就是
注意，这里用了--watch参数，意味着当你的express应用代码发生变化时，pm2会帮你重启服务，多贴心。
pm2 start ./bin/www --watch
入门太简单了，没什么好讲的。直接上官方文档：
参数说明：
完整命令行参数列表：
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
[root@iZ94wb7tioqZ pids]# pm2 describe 0 Describing process with id 0 - name oc-server
┌───────────────────┬──────────────────────────────────────────────────────────────┐
│ status │ online │
│ name │ oc-server │
│ id │ 0 │
│ path │ /data/file/qiquan/over_the_counter/server/bin/www │
│ args │ │
│ exec cwd │ /data/file/qiquan/over_the_counter/server │
│ error log path │ /data/file/qiquan/over_the_counter/server/logs/app-err-0.log │
│ out log path │ /data/file/qiquan/over_the_counter/server/logs/app-out-0.log │
│ pid path │ /root/.pm2/pids/oc-server-0.pid │
│ mode │ fork_mode │
│ node v8 arguments │ │
│ watch & reload │ │
│ interpreter │ node │
│ restarts │ 293 │
│ unstable restarts │ 0 │
│ uptime │ 87m │
│ created at │ 2016-08-26T08:13:43.705Z │
└───────────────────┴──────────────────────────────────────────────────────────────┘
举个简单例子，完整配置说明请参考。
{ "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": { "NODE_ENV": "production", "REMOTE_ADDR": "" }, "env_dev": { "NODE_ENV": "development", "REMOTE_ADDR": "http://wdev.example.com/" }, "env_test": { "NODE_ENV": "test", "REMOTE_ADDR": "" }
假设通过下面启动脚本（开发环境），那么，此时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
运行pm2 --help，可以看到pm2支持的子命令还是蛮多的，这个时候，自动完成的功能就很重要了。
运行如下命令。恭喜，已经能够通过tab自动补全了。细节可参考。
pm2 completion install source ~/.bash_profile
可以通过pm2 startup来实现开机自启动。细节可。大致流程如下
直接上例子，分别是通过命令行和配置文件。
命令行：
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
官方文档：
运行如下命令，查看当前通过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 save # 记得保存进程状态 $ npm install pm2 -g $ pm2 update
无非就是在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 ; proxy_redirect off; proxy_read_timeout 240s;
}
}
官方文档：
如果想把pm2的进程监控，跟其他自动化流程整合起来，pm2的编程接口就很有用了。细节可参考官方文档：
pm2支持第三方扩展，比如常用的log rotate等。可参考。
PS: 如果你的主机无法连接公网，先找到能连公网的主机安装上面的方法安装pm2，然后拷贝到你要安装的主机。拷贝如下目录：
再创建相关软连接
假设你现在已经写好了一个app.的文件，需要启动，你可以使用pm2进行管理
默认的目录是：当前用于的家目录下的.pm2目录（此目录可以自定义，请参考：五、自定义启动文件），详细信息如下：
创建一个test.json的示例文件，格式如下：
说明：
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为例
