快速开始

概述

PM2 是一个守护进程管理工具，帮助您管理和守护您的应用程序。它以简单直观的 C​​LI 命令行方式进行工作。

安装

最新的 PM2 版本可以使用 NPM 或 Yarn 安装：

$ npm install pm2@latest -g
# or
$ yarn global add pm2

启动应用

启动、守护和监控应用程序的最简单方法是使用以下命令行：

$ pm2 start app.js

启动 java 应用

普通：

$ java -jar ./demo.jar

pm2：

$ pm2 start -n demo java -- -jar ./demo.jar

带参数：

$ pm2 start -n demo java -- -jar -Dname=tom,age=18 ./demo.jar

danger

警告：上面这种方式仅适用到 linux 系统，window 系统无效且报错

通过 json 文件启动，在 jar 包同级目录创建 app.json ，内容如下：

{
  "apps": {
    "name": "demo", // 应用名称
    "script": "java", // 命令名称
    "error_file": "./log/err.log", // 错误日志
    "out_file": "./log/out.log", // 输出日志
    "log_date_format": "YYYY/MM/DD HH:mm:ss", // 日志日期格式
    "args": [
      "-jar",
      "--Dname=tom,age=18",
      "demo.jar"
    ]
  }
}

启动命令：

$ pm2 start app.json

启动 npm/yarn/pnpm 应用

以 npm 为例：

$ pm2 start -n demo npm -- run dev

danger

警告：上面这种方式仅适用到 linux 系统，window 系统无效且报错

不过 window 系统可以这样

项目根目录创建 ecosystem.config.js 配置：

module.exports = {
  apps: [
    {
      name: "demo",
      cwd: "./",
      script:
        "C:\\Users\\zhangsan\\AppData\\Roaming\\nvm\\v16.16.0\\node_modules\\npm\\bin\\npm-cli.js", // npm-cli.js路径
      args: "run dev",
    },
  ],
};

项目根目录执行命令：

$ pm2 start

另一种方式，不适应所有版本，了解下即可：

项目根目录创建 launch.js 内容：

const exec = require("child_process").exec;
exec("npm run dev", { windowsHide: true });

$ pm2 start ./launch.js

启动 express 应用

$ pm2 start -n demo ./bin/www

加参数（参数需要通过其他依赖捕获，如：commander）：

$ pm2 start -n demo ./bin/www -- -e development

通过JSON文件启动，如新建app.json，然后通过 pm2 start app.json 启动。

{
  "apps": {
    "name": "demo",
    "script": "./bin/www",
    "args": [
      "-e",
      "development"
    ]
  }
}

通过 ecosystem.config.js 文件启动，执行：pm2 start 即可启动。

module.exports = {
  apps : [{
    name: "demo",
    script: "./bin/www",
    args: "-e development"
  }]
}

启动 nuxt.js 应用

项目根目录创建 ecosystem.config.js 配置：

module.exports = {
  apps: [
    {
      name: 'ProjectName',
      script: './node_modules/nuxt/bin/nuxt.js',
      args: 'start -e production'// pm2执行其实就是 `nuxt start -e production`
    }
  ]
}

项目根目录执行命令：

$ pm2 start

启动 python 应用

$ pm2 start python_web.py --interpreter python3

或启动其他应用程序：

$ pm2 start bashscript.sh
$ pm2 start python-app.py --watch
$ pm2 start binary-file -- --port 1520

您可以传递给 CLI 的一些选项：

# 指定应用程序名称
--name <app_name>

# 当文件改变时，观察并重新启动应用程序
--watch

# 设置应用程序重新加载的内存阈值
--max-memory-restart <200MB>

# 指定日志文件
--log <log_path>

# 向脚本传递额外的参数
-- arg1 arg2 arg3

# 自动重启延迟
--restart-delay <delay in ms>

# 使用时间作为日志前缀
--time

# 不自动重启应用程序
--no-autorestart

# 指定cron强制重启
--cron <cron_pattern>

# 附加到应用程序日志
--no-daemon

管理应用

管理应用程序状态很简单，命令如下：

$ pm2 restart app_name
$ pm2 reload app_name
$ pm2 stop app_name
$ pm2 delete app_name

指令范围：

• all 所有
• id 特定id

进程检查

现在你已经启动了这个应用程序，你可以检查它的状态、日志、指标，甚至可以使用pm2.io获取在线监控面板。

列出应用程序

列出 PM2 管理的所有应用程序的状态：

$ pm2 [list|ls|status]

查看日志

查看实时日志：

$ pm2 logs

指定日志行数：

$ pm2 logs --lines 200

查看监控信息

$ pm2 monit

pm2.io：监控和诊断 Web 界面

基于 Web 的仪表板，带有诊断系统的跨服务器：

$ pm2 plus

负载均衡

PM2 内置自动负载均衡器，它将在每个进程之间共享所有 HTTP[s]/Websocket/TCP/UDP 连接。

在集群模式下启动应用程序：

$ pm2 start app.js -i max

在此处阅读有关集群模式的更多信息。

ecosystem配置文件

您还可以创建一个名为 Ecosystem File 的配置文件来管理多个应用程序。

$ pm2 ecosystem

这将生成一个 ecosystem.config.js 文件：

module.exports = {
  apps : [{
    name: "app",
    script: "./app.js",
    env: {
      NODE_ENV: "development",
    },
    env_production: {
      NODE_ENV: "production",
    }
  }, {
    name: 'worker',
    script: 'worker.js'
  }]
}

启动：

$ pm2 start process.yml

在此处阅读有关应用程序声明的更多信息。

开机启动

启动：

$ pm2 startup

保存：

$ pm2 save

在此处阅读有关启动脚本的更多信息。

应用监听

--watch选项很简单：

$ cd /path/to/my/app
$ pm2 start env.js --watch --ignore-watch="node_modules"

这将在当前目录 + 所有子文件夹中的任何文件更改时监视并重新启动应用程序，并且它将忽略 node_modules 文件夹中的任何更改--ignore-watch="node_modules"。

然后，您可以使用pm2 logs来检查重新启动的应用程序日志。

更新PM2

全局安装新最版本的PM2：

$ npm install pm2@latest -g

然后更新内存中的 PM2 ：

$ pm2 update

命令列表

# Fork 模式
pm2 start app.js --name my-api # 程序名

# Cluster 模式
pm2 start app.js -i 0        # 将根据可用的 CPU 使用 LB 启动最大进程
pm2 start app.js -i max      # 和上面一样，但是不推荐使用。
pm2 scale app +3             # Scales `app` up by 3 workers
pm2 scale app 2              # Scales `app` up or down to 2 workers total

# Listing

pm2 list               # 显示所有进程状态
pm2 jlist              # 以原始JSON格式打印进程列表
pm2 prettylist         # 以美化的JSON格式打印进程列表

pm2 describe 0         # 显示指定进程的所有信息

pm2 monit              # 监控所有进程

# Logs

pm2 logs [--raw]       # 在流中显示所有进程日志
pm2 flush              # 清空所有日志文件
pm2 reloadLogs         # 重新加载所有日志

# Actions

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

pm2 reload all         # 将 0s 宕机机时间重新加载（对于 NETWORKED 应用程序）

pm2 stop 0             # 停止指定进程id
pm2 restart 0          # 重启指定进程id

pm2 delete 0           # 将进程从pm2列表中删除
pm2 delete all         # 将从pm2列表中删除所有进程

# Misc

pm2 reset <process>    # 重置元数据(重启时间…)
pm2 updatePM2          # 在内存中更新pm2
pm2 ping               # 确保pm2守护进程已经启动
pm2 sendSignal SIGUSR2 my-app # 向脚本发送系统信号
pm2 start app.js --no-daemon
pm2 start app.js --no-vizion
pm2 start app.js --no-autorestart

进一步了解

了解如何将应用程序的所有选项声明到JSON 配置文件中。

了解如何进行通过脚本停止和重新启动应用程序以提高可靠性。

了解如何轻松部署和更新生产应用程序。

使用PM2.io监控您的生产应用程序。