拥抱 pm2 ，为你的 nodejs 应用助力

2018-08-24 本文已影响23人 zone7_

概述

pm2 与 supervisor 对比
pm2 基础用法
进程清单
Logs 日志
操作
Misc
配置文件
配置文件操作命令
集成 Docker
在线监控

pm2 与 supervisor 小对比

据我所知：
supervisor 可以实现修改命令后重启应用，但是关闭控制台之后，整个进程就挂了。
pm2 则可以后台运行，关闭控制台之后也不影响进程运行，而且有如下众多功能，且听我娓娓道来。

pm2 基础用法

首先是 pm2 的安装

npm install pm2 -g

启动应用：

pm2 start app.js --name myapp

停止应用：

pm2 stop myapp

查看当前启动应用：

pm2 list

查看当前所有启动应用的 log：

pm2 logs

查看某一应用的 log ：

pm2 logs <app_name|app_id>  --> 例：pm2 logs myapp

<h3>基础用法 plus

以下是 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

我们的 log 数据会持久化到 $HOME/.pm2/logs 目录下，如需要查找相关 log 则找到相应的 log 文件即可。

命名应用：

pm2 start app.js --name myapp

文件修改后，自动重启

pm2 start app.js --watch --name myapp

<h3>注意：
如果使用了 --watch 参数，

pm2 stop myapp --> 将不会停止监控
pm2 stop --watch myapp --> 将会停止监控

设置日志时间：（其中 Z 为时区）

pm2 start app.js --log-date-format="YYYY-MM-DD HH:mm Z"

传参给 node v8：

pm2 start app.js --node-args="--debug=7001"

内存超过上限自动重启：

pm2 start app.js --max-memory-restart 1024M

以当前可用 cpu 数量来开启 node 进程数量

pm2 start app.js -i 0        
pm2 start app.js -i max

进程清单

pm2 list               # 展示进程状态
pm2 jlist              # 以原生 json 数据打印进程清单
pm2 prettylist         # 以格式化 json 数据打印进程清单
pm2 describe 0         # Display all informations about a specific process
pm2 monit              # 监控所有进程

Logs 日志

pm2 logs [--raw]       # 以流的方式显示所有日志
pm2 flush              # 清空所有 log 文件
pm2 reloadLogs         # 重载所有 log

操作

pm2 stop all           # 停止所有进程
pm2 restart all        # 重启所有进程

pm2 reload all         # Will 0s downtime reload (for NETWORKED apps)

pm2 stop 0             # 通过进程 ID 来停止某个应用
pm2 restart 0          # 通过进程 ID 来重启某个应用

pm2 delete 0           # 通过进程 ID 来删除某个应用
pm2 delete all         # 删除所有应用

Misc

pm2 reset <process>    # Reset meta data (restarted time...)
pm2 updatePM2          # Update in memory pm2
pm2 ping               # Ensure pm2 daemon has been launched
pm2 sendSignal SIGUSR2 my-app # Send system signal to script
pm2 start app.js --no-daemon
pm2 start app.js --no-vizion
pm2 start app.js --no-autorestart

配置文件

配置文件有 json 和 .yml 文件两种格式。配置文件其实跟普通命令一样，只是将命令写进文件当中，我们可以将参数，环境变量，logs file 写进文件当中。而配置文件对微服务有很好的支持。
json 文件格式：（文件名需要以 .config.js 结尾）

module.exports = {
  apps : [{
    name        : "worker",
    script      : "./worker.js",
    output: './work/logs/out.log',//指定输出 console.log 的位置
    error: './work/logs/error.log',//指定输出 console.error 的位置
    log: './work/logs/combined.outerr.log',
    log_date_format: "YYYY-MM-DD HH:mm Z",
    watch       : true,
    env: {
      "NODE_ENV": "development",
    },
    env_production : {
       "NODE_ENV": "production"
    }
  },{
    name       : "api-app",
    script     : "./api.js",
    instances  : 4,
    exec_mode  : "cluster"
  }]
}

.yml 文件格式：

apps:
  - script   : ./api.js
    name     : 'api-app'
    instances: 4
    exec_mode: cluster
  - script : ./worker.js
    name   : 'worker'
    watch  : true
    env    :
      NODE_ENV: development
    env_production:
      NODE_ENV: production

配置文件操作命令

配置文件修改之后，需要 pm2 delete app 之后，再重新启动，修改的配置才能生效

# 开启配置文件内的所有应用
pm2 start ecosystem.config.js

# 开启配置文件内的所有应用,并配置环境变量 production
pm2 start ecosystem.config.js --env production

# 只启动应用名为：myapp 的应用
pm2 start ecosystem.config.js --only api-app

# 停止配置文件内的所有应用
pm2 stop ecosystem.config.js

# 重启配置文件内的所有应用
pm2 start   ecosystem.config.js
## 或者
pm2 restart ecosystem.config.js

# 重载配置文件内的所有应用
pm2 reload ecosystem.config.js

# 删除配置文件内的所有应用
pm2 delete ecosystem.config.js

# 以下命令对配置文件内的单一应用生效
pm2 start   ecosystem.config.js --only api-app
pm2 restart ecosystem.config.js --only api-app
pm2 reload  ecosystem.config.js --only api-app
pm2 delete  ecosystem.config.js --only api-app

集成 Docker

在 Dockerfile 中运行如下命令，安装 pm2

RUN npm install pm2 -g

CMD ["node", "app.js"]

用下面这行命令替代上面这条命令：

CMD ["pm2-runtime", "app.js"]

在线监控

官网：keymetrics
操作界面如下，看文档操作入门很简单，这里我就不再赘述了。

image.png