Bruce Chen's Blog

quick notes

0%

pm2常用的命令用法介绍

发表于 分类于

pm2 是一个带有负载均衡功能的 Node 应用的进程管理器.当你要把你的独立代码利用全部的服务器上的所有 CPU,并保证进程永远都活着,0 秒的重载, PM2 是完美的,下面我们来看 pm2 常用的命令用法介绍吧。

PM2 （github 上的源码）是开源的基于 Nodejs 的进程管理器，包括守护进程，监控，日志的一整套完整的功能，基本是 Nodejs 应用程序不二的守护进程选择，事实上它并不仅仅可以启动 Nodejs 的程序，只要是一般的脚本的程序它同样可以胜任。

以下是 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
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
$ pm2 start app.js              # 启动app.js应用程序

$ pm2 start app.js -i 4         # cluster mode 模式启动4个app.js的应用实例     # 4个应用程序会自动进行负载均衡

$ pm2 start app.js --name="api" # 启动应用程序并命名为 "api"

$ pm2 start app.js --watch      # 当文件变化时自动重启应用

$ pm2 start script.sh           # 启动 bash 脚本


$ pm2 list                      # 列表 PM2 启动的所有的应用程序

$ pm2 monit                     # 显示每个应用程序的CPU和内存占用情况

$ pm2 show [app-name]           # 显示应用程序的所有信息


$ pm2 logs                      # 显示所有应用程序的日志

$ pm2 logs [app-name]           # 显示指定应用程序的日志

$ pm2 flush


$ pm2 stop all                  # 停止所有的应用程序

$ pm2 stop 0                    # 停止 id为 0的指定应用程序

$ pm2 restart all               # 重启所有应用

$ pm2 reload all                # 重启 cluster mode下的所有应用

$ pm2 gracefulReload all        # Graceful reload all apps in cluster mode

$ pm2 delete all                # 关闭并删除所有应用

$ pm2 delete 0                  # 删除指定应用 id 0

$ pm2 scale api 10              # 把名字叫api的应用扩展到10个实例

$ pm2 reset [app-name]          # 重置重启数量


$ pm2 startup                   # 创建开机自启动命令

$ pm2 save                      # 保存当前应用列表

$ pm2 resurrect                 # 重新加载保存的应用列表

$ pm2 update                    # Save processes, kill PM2 and restore processes

$ pm2 generate                  # Generate a sample json configuration file


$ pm2 deploy app.json prod setup    # Setup "prod" remote server

$ pm2 deploy app.json prod          # Update "prod" remote server

$ pm2 deploy app.json prod revert 2 # Revert "prod" remote server by 2


$ pm2 module:generate [name]    # Generate sample module with name [name]

$ pm2 install pm2-logrotate     # Install module (here a log rotation system)

$ pm2 uninstall pm2-logrotate   # Uninstall module

$ pm2 publish                   # Increment version, git push and npm publish

一.安装

全局安装，简直不能更简单。

1
​npm install -g pm2

pm2 安装好后，会自动创建下面目录。看文件名基本就知道干嘛的。

1
2
3
4
5
6
7
8
$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

二.入门教程

挑我们最爱的 express 应用来举例。一般我们都是通过 npm start 启动应用，其实就是调用 node ./bin/www。那么，换成 pm2 就是

1
pm2 start ./bin/www –watch

注意，这里用了–watch 参数，意味着当你的 express 应用代码发生变化时，pm2 会帮你重启服务，多贴心。

参数说明：

1
2
3
4
5
6
7
--watch：监听应用目录的变化，一旦发生变化，自动重启。如果要精确监听、不监听的目录，最好通过配置文件。
-i --instances：启用多少个实例，可用于负载均衡。如果-i 0或者-i max，则根据当前机器核数确定实例数目。
--ignore-watch：排除监听的目录/文件，可以是特定的文件名，也可以是正则。比如--ignore-watch="test node_modules "some scripts""
-n --name：应用的名称。查看应用信息的时候可以用到。
-o --output <path>：标准输出日志文件的路径。
-e --error <path>：错误输出日志文件的路径。
--interpreter <interpreter>：the interpreter pm2 should use for executing app (bash, python...)。比如你用的coffee script来编写应用。

三.重启

1
pm2 restart app.js

四.停止

停止特定的应用。可以先通过 pm2 list 获取应用的名字（–name 指定的）或者进程 id。

1
pm2 stop app_name|app_id

如果要停止所有应用，可以

1
pm2 stop all

五.查看进程状态

1
pm2 list

六.配置文件

配置文件里的设置项，跟命令行参数基本是一一对应的。可以选择 yaml 或者 json 文件，就看个人喜好了。json 格式的配置文件，pm2 当作普通的 js 文件来处理，所以可以在里面添加注释或者编写代码，这对于动态调整配置很有好处。
　　如果启动的时候指定了配置文件，那么命令行参数会被忽略。（个别参数除外，比如–env）

举个简单例子，完整配置说明请参考官方文档。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
{
  “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 选项声明多个环境配置如下：

1
2
3
“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/” }

env 为默认的环境配置（生产环境），env_dev、env_test 则分别是开发、测试环境。可以看到，不同环境下的 NODE_ENV、REMOTE_ADDR 字段的值是不同的。

在应用中，可以通过 process.env.REMOTE_ADDR 等来读取配置中声明的变量。

假设通过下面启动脚本（开发环境），那么，此时 process.env.REMOTE_ADDR 的值就是相应的 http://wdev.example.com/。

1
pm2 start app.js –env dev

九.负载均衡

命令如下，表示开启三个进程。如果-i 0，则会根据机器当前核数自动开启尽可能多的进程。

1
2
pm2 start app.js -i 3 # 开启三个进程
​pm2 start app.js -i max # 根据机器CPU核数，开启对应数目的进程

十.日志查看

除了可以打开日志文件查看日志外，还可以通过 pm2 logs 来查看实时日志。这点对于线上问题排查非常重要。

比如某个 node 服务突然异常重启了，那么可以通过 pm2 提供的日志工具来查看实时日志，看是不是脚本出错之类导致的异常重启。

十一.开机自动启动

可以通过 pm2 startup 来实现开机自启动。细节可参考。大致流程如下：

  1. 通过 pm2 save 保存当前进程状态。
  2. 通过 pm2 startup [platform]生成开机自启动的命令。（记得查看控制台输出）
  3. 将步骤 2 生成的命令，粘贴到控制台进行，搞定。

假设是在 centos 下，那么运行如下命令，搞定。强烈建议运行完成之后，重启机器，看是否设置成功。

1
2
3
4
5
6
7
8
9
10
[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

十二.监控(monitor)

运行如下命令，查看当前通过 pm2 运行的进程的状态。

1
pm2 monit

看到类似输出

1
2
3
4
5
6
7
8
9
10
[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 参数。（有对应的配置项）

1
pm2 start big-array.js –max-memory-restart 20M

十四.pm2 + nginx

无非就是在 nginx 上做个反向代理配置，直接贴配置。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
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 Hostproxy_add_x_forwarded_for;
    proxy_set_header Hosthttp_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;
  }
}

官方文档：http://pm2.keymetrics.io/docs/tutorials/pm2-nginx-production-setup