Azure App Services 配合 PM2 使用说明

简介

Azure App Services 是 Azure 平台上提供的云托管服务，可以轻松部署 Web 应用。PM2 是一个面向 Node.js 应用的进程管理工具，可以帮助管理 Node.js 应用的生命周期。这篇文档将介绍如何将这两个工具结合使用，使得 Node.js 应用更加稳定可靠。

使用步骤

1. 准备工作

首先，需要将应用代码上传至 Azure App Services 中。可以使用任意方式上传，比如使用 Azure Portal 或者通过 Git 仓库。具体步骤可参考 Azure 文档。

2. 安装 PM2

在 App Services 中，可以通过 Kudu 工具（即 https://.scm.azurewebsites.net）进入 App Services 的虚拟机，并在虚拟机中安装 PM2。

# 安装 PM2
$ npm install -g pm2

3. 配置 PM2 运行应用

需要在应用代码根目录下创建一个名为 ecosystem.config.js 的文件，用于指定运行时参数。

// ecosystem.config.js
module.exports = {
  apps: [
    {
      name: "app",
      script: "index.js",
      instances: "max",
      exec_mode: "cluster",
      log_date_format: "YYYY-MM-DD HH:mm:ss",
      error_file: "err.log",
      out_file: "out.log",
      merge_logs: true,
      log_type: "json",
    }
  ]
}

具体说明：

• name，应用名称；
• script，应用入口文件路径；
• instances，运行实例数，建议设为 "max"；
• exec_mode，运行模式，建议设为 "cluster"；
• log_date_format，日志输出时间格式；
• error_file，错误日志文件名；
• out_file，输出日志文件名；
• merge_logs，是否将输出日志和错误日志合并为一个文件；
• log_type，输出日志格式。

4. 启动 PM2

在应用代码根目录下，使用 PM2 启动应用。

# 使用 PM2 启动应用
$ pm2 start ecosystem.config.js

5. 测试应用

在浏览器中访问应用的 URL，检查应用是否正常工作。

6. 其他命令

以下是一些常用的 PM2 命令。

# 查看运行状态
$ pm2 status

# 查看应用日志
$ pm2 log

# 重启应用
$ pm2 restart app

# 停止应用
$ pm2 stop app

# 删除应用
$ pm2 delete app

参考资料

• Azure App Service 文档
• PM2 官方文档