PM2 API

    这个例子展示了如何用一些配置属性来启动app.js。 传递给初始的元素与您可以在生态系统文件中声明的元素相同:

    如果您的脚本不能自行退出,请确保您调用 。

    pm2.connect(errback)pm2.connect(noDaemonMode, errback)

    • noDaemonMode - (默认值:false)如果第一个参数传递为true,那么pm2将不会作为守护进程运行,并在相关脚本退出时停止运行。 如果pm2已经在运行,您的脚本将链接到现有的守护进程,但一旦您的进程退出就会停止运行。
    • errback(error) - 在完成连接或启动pm2守护程序进程时调用。
      要么连接到正在运行的pm2守护进程(“God”),要么启动并守护进程。 一旦启动,pm2进程将在脚本退出后继续运行。

    pm2.disconnect()

    断开与pm2守护进程的连接。

    pm2.killDaemon(errback)

    pm2.start(options, errback)**pm2.start(jsonConfigFile, errback)pm2.start(script, errback)pm2.start(script, options, errback)**pm2.start(script, jsonConfigFile, errback)

    • script - 要运行的脚本路径。
    • jsonConfigFile - JSON文件的路径,它可以包含与options参数相同的选项。
    • errback(err,proc) - 当 script启动时调用errback。proc参数将是一个 pm2 进程对象
    • options - 具有以下选项的一个对象(这些选项的附加说明在):
      pm2.stop(process, errback)**pm2.restart(process, errback)pm2.delete(process, errback)pm2.reload(process, errback)**

    • - 既可以是 pm2.startoptions中给出的name,也可以是进程ID,或者是字符串“all”,以表示应该重启所有脚本。

    • errback(err, proc)
      pm2.list(errback)

    • errback(err, processDescription)

      • name - 原始start命令中给出的名称。
      • pid - 过程中的pid.
      • pm_id - pm2God守护进程的pid
      • monit - 一个包含以下内容的对象:
        • memory - 进程正在使用的字节数。
        • cpu - 此时进程正在使用的CPU百分比。
      • pm2_env - 进程环境中的路径变量列表。 这些变量包括:
        • pm_cwd - 进程的工作目录。
        • - 标准输出流日志文件路径。
        • exec_interpreter - 使用的解释器。
        • pm_uptime - 该进程的正常运行时间。
        • unstable_restarts - 该进程经历的不稳定的重启次数。
        • restart_time
        • status - “在线”,“正在停止”,“已停止”,“启动”,“错误”或“一次启动状态”
        • instances - 运行实例的数量。
        • pm_exec_path - 脚本在此进程中运行的路径。
          pm2.dump(errback)
    • errback(err, result)
      pm2.startup(platform, errback)

    • errback(err, result)
      pm2.flush(process, errback)

    • errback(err, result)
      pm2.reloadLogs(errback) - Rotates 日志文件。 新的日志文件将包含更高的数字(默认格式为 ${process.name}-${out|err}-${number}.log)。

    • errback(err, result)
      pm2.launchBus(errback) - 打开一个消息总线。

    • errback(err, result)