pm2 常用配置及命令

发表于

如果直接通过node app来启动，如果报错了可能直接停在整个运行，supervisor感觉只是拿来用作开发环境的。再网上找到pm2.目前似乎最常见的线上部署nodejs项目的有forever,pm2这两种。
使用场合:

  • supervisor是开发环境用。
  • forever管理多个站点，每个站点访问量不大，不需要监控。
  • nodemon 是开发环境使用，修改自动重启。
  • pm2 网站访问量比较大,需要完整的监控界面。

PM2 是 node 进程管理工具，可以利用它来简化很多 node 应用管理的繁琐任务，如性能监控、自动重启、负载均衡等，而且使用非常简单。本文就 PM2 进行入门性的介绍，基本涵盖了 PM2 的常用的功能和配置。

安装

1
npm install -g pm2

如果你的node项目配置文件和以上代码不一样，，，莫急，pm2 也是有办法可以启动的（个人觉得这是一个万能的启动的方法）：

1
2
pm2 start npm -- run XXX
pm2 start npm --watch --name XXX -- run start

用她替代：npm run dev，就可以写成：pm2 start npm -- run dev，项目启动：

常用命令

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
pm2 start [server.js]
# 启动服务
pm2 list
# 查看当前所跑服务的详情
pm2 show [name]
# 查看更加详细的信息这个命令可查看pm2配置 包括日志文件存放的位置等
pm2 stop [id/name]
# 关闭某个服务
pm2 delete [id/name]
# 删除某个服务
pm2 stop all
# 关闭所有服务
pm2 logs
# 查看实时日志
pm2 restart [name]
# 重新启动服务


$ 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 启动 并 生成一个配置文件

启动

参数说明：

  • --watch：监听应用目录的变化，一旦发生变化，自动重启。如果要精确监听、不见听的目录，最好通过配置文件。
  • -i --instances：启用多少个实例，可用于负载均衡。如果 -i 0 或者 -i max，则根据当前机器核数确定实例数目。
  • --ignore-watch：排除监听的目录/文件，可以是特定的文件名，也可以是正则。比如 --ignore-watch="test node_modules "some scripts""
  • -n --name：应用的名称。查看应用信息的时候可以用到。
  • -o --output <path>：标准输出日志文件的路径。
  • -e --error <path>：错误输出日志文件的路径。

监听

pm2 start ./bin/www --watch
#注意，这里用了--watch参数，意味着当你的应用代码发生变化时，pm2会帮你自动重启服务

配置及部署

部署的配置文件示例

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
{
  // 数组中放的是需要发布的项目一些变量的定义
  "apps": [{
    "name": "xxx", //项目名称
    "script": "server.js", //用来启动的脚本
    // "instances":2,
    // 启动项目所需要的环境变量
    "env": {
      "COMMON_VARIABLE": "true", //设置为true 可以在启动的时传入外部的变量进去
    },
    "env_production": {
      "NODE_ENV": "production"
    }
  }],
  // 部署
  "deploy": {
    "production": {
      "user": "root",
      "host": "0.0.0.0", //可以是数组 部署到多台主机
      "ref": "origin/master", //选择拿哪个个分支的代码
      "repo": "git@github.com:ihoey/hitalk.git", //仓库地址
      "path": "/root/www/hitalk/production", //要发布到服务器上哪个目录下面
      "ssh_options": "StrictHostKeyChecking=no", //避免key验证导致代码更新到远程仓库失败
      "post-deploy": "source ~/.nvm/nvm.sh && pm2 startOrRestart ecosystem.json --env production", //发布之后执行的动作 执行开启或更新pm2运行的服务
      "pre-deploy-local": "echo 'Deploy Done!'", //本地发布之前的动作
      "env": { //指定部署到远程的仓库的环境 是production生产环境
        "NODE_ENV": "production"
      }
    }
  }
}

说明:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
apps:json结构，apps是一个数组，每一个数组成员就是对应一个pm2中运行的应用
name:应用程序名称
cwd:应用程序所在的目录
script:应用程序的脚本路径
log_date_format:
error_file:自定义应用程序的错误日志文件
out_file:自定义应用程序日志文件
pid_file:自定义应用程序的pid文件
instances:
min_uptime:最小运行时间，这里设置的是60s即如果应用程序在60s内退出，pm2会认为程序异常退出，此时触发重启max_restarts设置数量
max_restarts:设置应用程序异常退出重启的次数，默认15次（从0开始计数）
cron_restart:定时启动，解决重启能解决的问题
watch:是否启用监控模式，默认是false。如果设置成true，当应用程序变动时，pm2会自动重载。这里也可以设置你要监控的文件。
merge_logs:
exec_interpreter:应用程序的脚本类型，这里使用的shell，默认是nodejs
exec_mode:应用程序启动模式，这里设置的是cluster_mode（集群），默认是fork
autorestart:启用/禁用应用程序崩溃或退出时自动重启
vizion:启用/禁用vizion特性(版本控制)

fork与cluster启动模式

  • fork模式，单实例多进程，常用于多语言混编，比如php、python等，不支持端口复用，需要自己做应用的端口分配和负载均衡的子进程业务代码。

  • 缺点就是单服务器实例容易由于异常会导致服务器实例崩溃。

  • cluster模式，多实例多进程，但是只支持node，端口可以复用，不需要额外的端口配置，0代码实现负载均衡。
  • 优点就是由于多实例机制，可以保证服务器的容错性，就算出现异常也不会使多个服务器实例同时崩溃。

共同点，由于都是多进程，都需要消息机制或数据持久化来实现数据共享。

pm2启动进程的支持两种模式：fork与cluster，对于了解node的人知道，node的多进程编程api: child_process.fork与cluster。关于pm2的fork与cluster两者的本质区别，个人认为就是node API的child_process.fork与cluster的区别，stackoverflow有关于这个问题的讨论 http://stackoverflow.com/questions/34682035/cluster-and-fork-mode-difference-in-pm2。下面做个粗浅的归纳：

  • cluster是fork的派生，cluster支持所有cluster拥有的特性；

  • fork不支持socket地址端口复用，cluster支持地址端口复用。因为只有node的cluster模块支持socket选项SO_REUSEADDR；

  • fork不可以启动多个实例进程，cluster可以启动多个实例。但node的child_process.fork是可以实现启动多个进程的，但是为什么没有实现呢？就个人理解，node多为提供网络服务，启动多个实例需要地址端口复用，此时便可使用cluster模式实现，但fork模式并不支持地址端口复用，多实例进程启动会产生异常错误。但对于常驻任务脚本而言，不需要提供网络服务，此时多进程启动可以实现，同时也提高了任务处理效率。对于上述需求，可以两种方式实现，一是配置app0,app1,app2方式启动多个进程，二是通过应用实例自身调用child_process.fork多进程编程实现；

  • fork模式可以应用于其他语言，如php,python,perl,ruby,bash,coffee， 而cluster只能应用于node;

  • fork不支持定时重启，cluster支持定时重启。定时重启也就是配置中的cron_restart配置项。github上面有作者关于fork模式下是否需要实现cron-like定时的讨论：

pm2进程管理工具使用总结

初始化配置

第一次部署

pm2 deploy ecosystem.json production setup

部署

pm2 deploy ecosystem.json production

好了，先记录这么多~