PM2 开源项目安装与使用指南

一、项目的目录结构及介绍

当你通过 git clone https://github.com/Unitech/pm2.git 克隆了PM2项目之后，你会看到以下主要目录和文件：

• bin/
  这个目录包含了用于全局调用的命令行脚本。例如，pm2 脚本是PM2核心功能的核心。

• lib/
  这个目录中存储的是PM2的主要代码库，包括各个功能模块。它涵盖了从初始化环境到管理进程的所有操作逻辑。

• doc/ 或 docs/ (可能因版本而异)
  提供了有关PM2详细使用说明和技术细节的文档，这对于深入理解PM2的工作原理非常有帮助。

• test/
  这是一系列自动化测试案例，确保PM2在各种条件下都能正确运行。

• package.json
  这是NPM包配置文件，定义了项目的元数据以及开发和运行时依赖项。

• README.md
  该项目的根目录中的README文件通常提供关于如何构建和运行项目的最简要的信息。

• .gitignore 定义了哪些文件或目录应被Git忽略，防止敏感信息意外提交。

• LICENSE 指定项目的许可证类型，确定版权归属和分发条款。

二、项目的启动文件介绍

PM2的核心启动文件位于bin目录下，名为pm2。这是一个Node.js脚本，通过执行它，你可以访问所有可用的PM2命令。为了方便在系统范围内调用PM2，推荐将此文件添加到系统的PATH环境变量中。

常用命令示例:

• pm2 start [app.js]: 启动应用程序。
• pm2 restart [app.js]: 重启应用程序。
• pm2 stop [app.js]: 停止应用程序。
• pm2 delete [app.js]: 删除已注册的应用程序。
• pm2 flushlogs: 清空日志文件。
• pm2 log [name_of_app]: 显示特定应用的日志。
• pm2 list: 列出所有托管的服务。
• pm2 monit: 监控并显示所有进程的状态。
• pm2 save: 保存当前状态以便重启机器后恢复。

三、项目的配置文件介绍

PM2使用JSON格式的配置文件来指定运行时的各种参数。该配置文件可以让你更精细地控制应用程序的部署方式，以及PM2守护进程的行为。默认情况下，PM2寻找ecosystem.config.js或者.pm2.yml（YAML格式）作为配置文件。

配置文件的基本结构：

{
    "apps" : [{
        "script" : "your-app-file.js",
        
        // "args": "-v", 
        // "cwd" : "/path/to/project/directory",
        // "instances" : "max",
        // "exec_mode" : "cluster_mode",
        // "env" : {
        //     "NODE_ENV" : "development"
        // },
        // "env_production" : {
        //     "NODE_ENV" : "production"
        // },
        // "log_type" : "json",
        // "error_file" : "/var/log/myapp/error.log",
        // "out_file" : "/var/log/myapp/out.log",
        // "merge_logs" : true,
        // "log_date_format" : "YYYY-MM-DD HH:mm Z",
        // "autorestart" : true,
        // "watch" : false,
        // "watch_options" : {
        //     "polling" : false
        // },
        // "watch_restart" : 1000,
        // "custom_var_1" : "foo",
        // "custom_var_2" : {"bar":"baz"}
    }]
}

主要字段解释：

• script: 应用程序的主入口点，通常是你的主要JavaScript文件。
• args: 指定传递给应用程序的任何额外命令行参数。
• cwd: 指定应用程序的当前工作目录，默认为应用程序所在的目录。
• instances: 设置要创建的应用实例数，“max”表示自动检测CPU核心数以并行化负载。
• exec_mode: 进程执行模式，可选值有“fork”或“cluster”，分别对应单线程和多线程模式。
• env 和 env_production: 定义环境变量，在不同环境中有不同的配置。
• log_type, error_file, out_file: 日志设置选项。
• autorestart: 若设为true，则会在应用程序崩溃后自动重启。
• watch: 对指定文件夹进行监视并在文件改变时自动重启应用。

通过编辑和自定义这些选项，你可以使PM2更加符合你的具体需求，从而提升应用程序的稳定性和性能。