pm2 的功能介绍

pm2 的功能介绍

前言

学习这篇文章,你将可以学到以下几点内容

  • pm2 是什么?
  • pm2 的主要特性是什么,带来的优势。
  • 知道 pm2 的安装,配置文件,命令操作等。
  • pm2 的高阶应用

PM2 -> Node应用进程管理器

pm2 是 node 进程管理工具,可以利用它来简化很多 node 应用管理的繁琐任务,如性能监控、自动重启、负载均衡等,因为在工作中遇到服务器重启后,需要一个个去重新启动每个服务,这样不仅繁琐、效率低,而且容易遗忘开启一些服务。

PM2 的主要特性

  • 内建负载均衡(使用 Node cluster 集群模块)
  • 后台运行
  • 0 秒停机重载
  • 查阅和管理日志
  • 具有 Ubuntu 和 CentOS 的启动脚本
  • 停止不稳定的进程(避免无限循环)
  • 控制台检测
  • 配合Nginx 进行生产设置
  • 提供 HTTP API
  • 远程控制和实时的接口 API ( Nodejs 模块,允许和 PM2 进程管理器交互 )

1. 安装

1
npm install -g pm2

检验安装是否生效

image.png

2. 常用命令

  1. 启动
1
pm2 start index.js

image.png

  1. 命令行参数

我们可以在最基本的启动命令后面,添加一些参数选项,去满足我们的需求,常用的参数选项如下所示:

  • –watch:监听应用目录的变化,一旦发生变化,自动重启。
  • -i or –instance:启用多少个实例,可用于负载均衡,如果 -i 0 或者 -i max,则根据当前机器核数确定实例数目。
  • –ignore-watch:排除监听的目录或文件,可以是特定的文件名,也可以是正则。
    我们在启动命令后面加入以上的一些参数,完整的启动命令如下所示:

image.png

启动成功后的截图如下,我们通过截图可以看到启动的应用名称变为 jiaming,然后启动12个进程,说明我们在启动命令后面添加的参数已经起作用。

  1. 重启
    1
    pm2 restart index.js
  2. 停止

停止特定的应用,可以通过 pm2 list 先获取应用的名字或者进程的 id,然后再调用以下命令停止相应的应用;

1
$ pm2 stop app_name | app_id

如果需要停止全部的应用,则使用以下命令:

1
pm2 stop all
  1. 删除

删除特定的应用,可以通过 pm2 list 先获取应用的名字或者进程的 id,然后再调用以下命令删除相应的应用;

1
pm2 delete app_name | app_id

如果需要删除全部的应用,则使用以下命令:

1
如果需要删除全部的应用,则使用以下命令:
  1. 查看有哪些进程
1
pm2 list

3. 配置文件

如果我们使用命令行参数定义一些选项,那么每次启动进程时,都需要敲上一大堆的命令,非常繁琐;所以我们可以使用配置文件来将命令行参数进行配置,配置文件里的配置项跟命令行参数是基本一致的;如下所示 pm2 的配置文件 pm2.json ,然后在 package.json 文件中配置启动命令 “pm2”: “pm2 start pm2.json” ,这样我们只需要运行 npm run pm2 就可以使用 pm2 启动我们的 express 项目,并且相关运行参数直接在 pm2.json 中配置好了。相关配置项表示的意义在下面文件中都已经注释说明

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
{
"apps": {
"name": "express_project", // 项目名
"script": "app.js", // 执行文件
"cwd": "./", // 根目录
"args": "", // 传递给脚本的参数
"interpreter": "", // 指定的脚本解释器
"interpreter_args": "", // 传递给解释器的参数
"watch": true, // 是否监听文件变动然后重启
"ignore_watch": [ // 不用监听的文件
"node_modules",
"public"
],
"exec_mode": "cluster_mode", // 应用启动模式,支持 fork 和 cluster 模式
"instances": "max", // 应用启动实例个数,仅在 cluster 模式有效 默认为 fork
"error_file": "./logs/app-err.log", // 错误日志文件
"out_file": "./logs/app-out.log", // 正常日志文件
"merge_logs": true, // 设置追加日志而不是新建日志
"log_date_format": "YYYY-MM-DD HH:mm:ss", // 指定日志文件的时间格式
"min_uptime": "60s", // 应用运行少于时间被认为是异常启动
"max_restarts": 30, // 最大异常重启次数
"autorestart": true, // 默认为 true, 发生异常的情况下自动重启
"restart_delay": "60" // 异常重启情况下,延时重启时间
"env": {
"NODE_ENV": "production", // 环境参数,当前指定为生产环境
"REMOTE_ADDR": ""
},
"env_dev": {
"NODE_ENV": "development", // 环境参数,当前指定为开发环境
"REMOTE_ADDR": ""
},
"env_test": { // 环境参数,当前指定为测试环境
"NODE_ENV": "test",
"REMOTE_ADDR": ""
}
}
}

4. 高阶应用

  1. 负载均衡

可以使用 -i 参数配置集群数,实现负载均衡,相关命令如下,可以查看 官网章节

1
2
pm2 start app.js -i 3 // 开启三个进程
pm2 start app.js -i max // 根据机器CPU核数,开启对应数目的进程
  1. 日志查看

我们可以通过打开日志文件查看日志外,还可以通过 pm2 logs 来查看实时日志,这点有对于线上问题排查;日志查看命令如下:

1
pm2 logs

image.png

  1. 监控

我们可以使用以下命令,查看当前通过 pm2 运行的进程的状态;

1
pm2 monit

image.png

作者

jiaming

发布于

2022-09-18

更新于

2023-04-28

许可协议

评论