Configuration

配置文件

在使用 PM2 管理多个应用程序时，使用一个 JS 配置文件来组织它们。

生成配置

要生成示例配置文件，您可以键入以下命令：

这将生成一个示例 ecosystem.config.js：

module.exports = {
  apps: [{
    name: 'app1',
    script: './app.js'
  }]
}

如果您正在创建自己的配置文件，请确保它以 .config.js 结尾，以便 PM2 能够将其识别为配置文件。

作用于配置文件

与对应用程序进行操作相比，您可以无缝地启动/停止/重新启动/删除配置文件中包含的所有应用程序：

# 启动所有应用程序
pm2 start ecosystem.config.js

# 全部停止
pm2 stop ecosystem.config.js

# 重启所有
pm2 restart ecosystem.config.js

# 全部重新加载
pm2 reload ecosystem.config.js

# 删除所有
pm2 delete ecosystem.config.js

作用于特定过程

您还可以通过使用其名称和选项--only <app_name>来对特定应用程序进行操作：

$ pm2 start ecosystem.config.js --only api-app

您甚至可以通过指定以逗号分隔的每个应用程序名称来指定要操作的多个应用程序：

$ pm2 start ecosystem.config.js --only "api-app,worker-app"

切换环境

您可以通过 env_* 选项指定不同的环境变量集。

例子：

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

现在要在不同环境中的变量之间切换，请指定 --env [env name] 选项：

$ pm2 start process.json --env production
$ pm2 restart process.json --env development

可用的属性

可以使用以下属性微调应用程序行为和配置：

常规的

高级功能

日志文件

控制流

部署

注意事项

使用 JSON 应用程序声明时传递的所有命令行选项都将被删除，即

CWD

cwd: 您的 JSON 声明不需要与您的脚本一起驻留。 如果您希望在脚本以外的位置维护 JSON(例如，/etc/pm2/conf.d/node-app.json)，您将需要使用 cwd 功能(注意， 这对于使用符号链接的 capistrano 风格的目录结构非常有用)。 文件可以是相对于 cwd 目录的，也可以是绝对的(参见下面的示例)。

CLI/JSON 选项

所有键都可以在 JSON 配置文件中使用，但在命令行上几乎保持不变，例如：

exec_mode         -> --execute-command
max_restarts      -> --max-restarts
force             -> --force

使用引号转译特殊字符，例如：

$ pm2 start test.js --node-args "port=3001 sitename='first pm2 app'"

nodeArgs 参数将被解析为

[
  "port=3001",
  "sitename=first pm2 app"
]

但不是

[
  "port=3001",
  "sitename='first",
  "pm2",
  "app'"
]

禁用日志

您可以将 /dev/null 传递给 error_file 或 out_file 以禁用日志保存。 注意：启动 PM2 2.4.0、/dev/null 或 NULL 独立于平台禁用日志。

日志后缀

您可以通过启用选项 merge_logs: true 来禁用日志上的自动 ID 后缀(例如 app-name-ID.log)

环境定义

您需要使用 --env <envname> 来告诉 pm2 使用进程文件中定义的特定环境：

{
  "apps": [{
    "name": "worker-app",
    "script": "./worker.js",
    "watch": true,
    "env": {
      "NODE_ENV": "development"
    },
    "env_production": {
      "NODE_ENV": "production"
    }
  }, {
    "name": "api-app",
    "script": "./api.js",
    "instances": 4,
    "exec_mode": "cluster"
  }]
}

在此示例中，您将运行pm2 start ecosystem.json，它将使用默认环境(在开发中)启动您的应用程序。

然后你使用 pm2 start ecosystem.json --env production 它将使用属性 env_<name>， 这里的 name 是 production，所以它会使用 NODE_ENV=production 启动你的应用程序。

特殊的 ext_type

• min_uptime: min_uptime 的值可以是：
  • 号码 例如 "min_uptime": 3000 表示 3000 毫秒。
  • String 因此，我们使其简短且易于配置：h、m 和 s，例如："min_uptime"："1h" 表示一小时，"min_uptime"： "5m" 表示五分钟，"min_uptime": "10s" 表示十秒(它们将转换为毫秒)。
• max_memory_restart的值可以是：
  • 号码 例如 "max_memory_restart": 1024 表示 1024 字节(不是位)。
  • String 因此，我们使其简短且易于配置：G、M 和 K，例如：
    "max_memory_restart": "1G" 表示 1 GB，
    "max_memory_restart": "5M" 表示 5 MB，
    "max_memory_restart": "10K" 表示 10 KB(它们将被转换为字节)。
• 可选值 例如 exec_mode 可以将 cluster (cluster_mode) 或 fork (fork_mode) 作为可能的值。
• 须知
  • "instances": 0 表示 PM2 将根据 CPU 的数量启动尽可能多的进程(集群模式)
  • 数组 args、node_args 和 ignore_watch 可以是 Array 的类型
    (例如："args": ["--toto=heya coco", "-d", "1"])或 string
    (例如："args": "--to='heya coco' -d 1")