生態系統檔案

設定檔

在使用 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

使用引號來建立 ESC，例如

$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"）