pm2 start命令中的json格式详解

时间:2021-01-16 04:37:46

pm2 start npm -- start这条命令是pm2的万能命令,pm2 start <json>,就是这一系列命令中的最豪华命令。这个json我们可以理解为一个任务参数描述文件。通过这个json文件,我们把在命令行里面不好描述的各种参数放到一个json文件里面来。

pm2 start <json>.json

pm2 start命令中的json格式详解

自定义启动文件,创建一个test.json的示例文件,格式如下:

{ "apps":[ { "name": "test", "cwd": "/data/wwwroot/nodejs", "script": "./test.sh", "exec_interpreter": "bash", "min_uptime": "60s", "max_restarts": 30, "exec_mode" : "cluster_mode", "error_file" : "./test-err.log", "out_file": "./test-out.log", "pid_file": "./test.pid"
      "watch": false } ]}

参数说明:

  • apps:json结构,apps是一个数组,每一个数组成员就是对应一个pm2中运行的应用
  • name:应用程序的名称
  • cwd:应用程序所在的目录
  • script:应用程序的脚本路径
  • exec_interpreter:应用程序的脚本类型,这里使用的shell,默认是nodejs
  • min_uptime:最小运行时间,这里设置的是60s即如果应用程序在60s内退出,pm2会认为程序异常退出,此时触发重启max_restarts设置数量
  • max_restarts:设置应用程序异常退出重启的次数,默认15次(从0开始计数)
  • exec_mode:应用程序启动模式,这里设置的是cluster_mode(集群),默认是fork
  • error_file:自定义应用程序的错误日志文件
  • out_file:自定义应用程序日志文件
  • pid_file:自定义应用程序的pid文件
  • watch:是否启用监控模式,默认是false。如果设置成true,当应用程序变动时,pm2会自动重载。这里也可以设置你要监控的文件。

运行实例:已上面的test.json为例

pm2 start test.json

最精简版本

{ "name": "manage",      //项目名称
    "script": "./bin/www", //要执行的脚本
    "cwd":"./",            //项目所在目录
}

设置文件监控版本,文件变动,就重启服务

{ "name": "manage",      //项目名称
    "script": "./bin/www", //要执行的脚本
    "cwd":"./",            //项目所在目录
    "watch":[  //添加受监控的文件,以便自动更新
        "models", "routes" ], "ignore_watch" : [  //不监视的文件
        "node_modules", "client/img" ], "watch_options": {  //监视配置,具体见 http://pm2.keymetrics.io/docs/usage/watch-and-restart/
      "followSymlinks": false } }

设置log位置

{ "name": "manage",      //项目名称
    "script": "./bin/www", //要执行的脚本
    "cwd":"./",            //项目所在目录
    "log_file": "<yourpath>/combined.outerr.log", "out_file": "<yourpath>/out.log", "error_file": "<yourpath>/err.log", }