pm2入门

Posted 2022-02-02 dadonggg

简介

PM2是node进程管理工具，可以利用它来简化很多node应用管理的繁琐任务，如性能监控、自动重启、负载均衡等，而且使用非常简单。

安装

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

npm install -g pm2

 

目录介绍

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

 

常用命令总结：

 

启动

参数说明：

--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来编写应用。

 

完整命令行参数列表：

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
?

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

 

在实际项目开发中，我们的应用经常需要在多个环境下部署，比如开发环境、测试环境、生产环境等。在不同环境下，有时候配置项会有差异，比如链接的数据库地址不同等。

对于这种场景，pm2也是可以很好支持的。首先通过在配置文件中通过env_xx来声明不同环境的配置，然后在启动应用时，通过--env参数指定运行的环境。

环境配置声明

首先，在配置文件中，通过env选项声明多个环境配置。简单说明下：

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

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

  "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/"

  

 

启动指明环境

假设通过下面启动脚本（开发环境），那么，此时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

 

指令tab补全

运行pm2 --help，可以看到pm2支持的子命令还是蛮多的，这个时候，自动完成的功能就很重要了。

运行如下命令。恭喜，已经能够通过tab自动补全了。细节可参考这里。

pm2 completion install
source ~/.bash_profile

 

监控(monitor)

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

pm2 monit

 

内存使用超过上限自动重启

如果想要你的应用，在超过使用内存上限后自动重启，那么可以加上--max-memory-restart参数。（有对应的配置项）

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

更新pm2

官方文档：http://pm2.keymetrics.io/docs/usage/update-pm2/#updating-pm2

$ pm2 save # 记得保存进程状态
$ npm install pm2 -g
$ pm2 update

pm2 + nginx

无非就是在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 http://my_nodejs_upstream/;

        proxy_redirect off;

        proxy_read_timeout 240s;
?

    

 

http://pm2.keymetrics.io/docs/tutorials/pm2-nginx-production-setup