エコシステムファイル

設定ファイル

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オプションは、start/restart/stop/deleteでも動作します。

各アプリ名をカンマで区切って指定することで、複数のアプリを操作対象に指定することもできます。

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 [環境名]オプションを指定します。

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）を無効にすることができます。

環境定義

プロセスファイル内で定義された特定の環境を使用するようにpm2に指示するには、--env <環境名>を使用する必要があります。

{
  "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_<名前>が使用されます。ここで、名前はproductionなので、アプリはNODE_ENV=productionで起動します。

特別なext_type

• min_uptime min_uptimeの値は次のとおりです。
  • 数値 例："min_uptime": 3000は3000ミリ秒を意味します。
  • 文字列 設定を簡潔にするために、h、m、sを使用できます。例："min_uptime": "1h"は1時間、"min_uptime": "5m"は5分、"min_uptime": "10s"は10秒を意味します（これらはミリ秒に変換されます）。
• max_memory_restart max_memory_restartの値は次のとおりです。
  • 数値 例："max_memory_restart": 1024は1024バイトを意味します（**ビットではありません**）。
  • 文字列 設定を簡潔にするために、G、M、Kを使用できます。例："max_memory_restart": "1G"は1ギガバイト、"max_memory_restart": "5M"は5メガバイト、"max_memory_restart": "10K"は10キロバイトを意味します（これらはバイトに変換されます）。

• オプション値 たとえば、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"）です。