生态系统文件

配置文件

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

生成配置

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

$ pm2 init simple

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

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

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

对配置文件进行操作

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

# Start all applications
pm2 start ecosystem.config.js

# Stop all
pm2 stop ecosystem.config.js

# Restart all
pm2 restart ecosystem.config.js

# Reload all
pm2 reload ecosystem.config.js

# Delete all
pm2 delete ecosystem.config.js

对特定进程进行操作

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

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

注意：--only 选项也适用于启动/重启/停止/删除

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

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 毫秒。
  • 字符串 因此，我们使其配置起来简短易懂：h、m 和 s，例如："min_uptime": "1h" 表示一小时，"min_uptime": "5m" 表示五分钟，"min_uptime": "10s" 表示十秒（这些将被转换为毫秒）。
• max_memory_restart max_memory_restart 的值可以是
  • 数字 例如 "max_memory_restart": 1024 表示 1024 字节（不是位）。
  • 字符串 因此，我们使其配置起来简短易懂：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"）