模块系统 Module System

由 PM2 运行的独立 Node.JS 应用程序

PM2 模块

PM2 模块是由 PM2 安装和管理的独立软件。这些软件是从 NPM 存储库中提取的，并作为 NPM 上的通用 Javascript 库发布。

任何人都可以创建和发布模块。一个模块可以是一个日志轮换模块，一个独立的http代理，负载均衡器、基于 Node.js 的维基百科、DNS 服务器或任何类型的实用程序。你的创造力是极限！

管理模块

管理模块很简单：

bash

# 安装
pm2 install <module-name>

# 更新模块
pm2 install <module-name>

# 从 GitHub(用户名/存储库)安装模块
pm2 install pm2-hive/pm2-docker

# 强制模块重启
pm2 restart <module-name>

# 获取更多信息
pm2 describe <module-name>

# 从本地文件夹以开发模式安装模块
pm2 install .

# 生成模块样板
pm2 module:generate <module-name>

# 卸载模块
pm2 uninstall <module-name>

# 发布新模块(Inc Semver + Git push + NPM publish)
pm2 publish

创建模块

要生成模块示例：

bash

pm2 module:generate <module-name>

现在让我们用 PM2 运行这个模块：

bash

cd <module-name>
pm2 install .

您现在可以编辑源代码，当您更改某些内容时，PM2 将自动重启模块(watch 选项已激活)。

显示模块日志：

bash

$ pm2 logs <module-name>

要删除模块：

bash

$ pm2 uninstall <module-name>

Package.json的增强

可以将补充信息添加到 package.json 文件中。

您可以在 config 属性和模块行为下定义配置值，如常见的 pm2 托管进程。

例子：

{
  "name": "pm2-logrotate",  // Used as the module name
  "version": "1.0.0",       // Used as the module version
  "description": "my desc", // Used as the module comment
  "dependencies": {
    "pmx": "latest"
  },
  "config": {              // Default configuration values
                           // These values can be overridden with `pm2 set <module-name>:<attr> <val>`
     "days_interval" : 7,  // These value is returned once you call pmx.initModule()
     "max_size" : 5242880
  },
  "apps" : [{              // Module behavior options
    "script"             : "index.js",
    "merge_logs"         : true,
    "max_memory_restart" : "200M"
  }],
  "author": "Gataca Sanders",
  "license": "MIT"
}

模块入口点

在您的主模块入口点，调用 pmx.initModule(opts, fn(){}); 来初始化您的模块：

const pmx = require('pmx')

const conf = pmx.initModule({
  // Override PID to be monitored
  pid: pmx.resolvePidPaths(['/var/run/redis.pid']),
}, (err, conf) => {
  // Now the module is initialized
  require('./business_logic.js')(conf)
})

额外显示

安装模块后，您可以更改其行为以显示包含所需内容的表格，而不是 PM2 列出您的进程。

要启用此行为，请编辑 package.json 并添加 env 部分并将 PM2_EXTRA_DISPLAY 设置为 true：

package.json

json

{
  [...]
  "apps" : [{
    "script" : "index.js",
    "env"    : {
      "PM2_EXTRA_DISPLAY" : "true"
    }
  }],
  [...]
}

然后在你的代码中：

const pmx = require('pmx')

pmx.configureModule({
  human_info: [
    ['Status', 'Module ready'],
    ['Comment', 'This is a superb comment the user should see'],
    ['IP', 'my machine ip!']
  ]
})

安装模块后，您将能够看到这种表格！

额外模块显示。

模块配置

在 package.json 中，您可以在属性 config 下声明模块中可访问的默认选项。这些值可以被 PM2 或 Keymetrics 覆盖。

默认值

在 package.json 的config属性下添加默认配置值：

json

{
 [...]
 "config": {             // Default configuration value
    "days_interval" : 7,  // -> returned from var ret = pmx.initModule()
    "max_size" : 5242880  // -> e.g. ret.max_size
 }
 [...]
}

然后可以通过 pmx.initModule() 返回的数据访问这些值。

例子：

var conf = pmx.initModule({[...]}, function(err, conf) {
  // 现在我们可以读取这些值
  console.log(conf.days_interval);
});

更改值

更改模块的默认值很简单，只需执行以下操作：

bash

pm2 set module_name:option_name <new_value>

Example:

bash

pm2 set server-monitoring:days_interval 2

NOTE1: 这些变量写在~/.pm2/module_conf.json中，您也可以手动编辑
注意 2：您可以通过 pm2 conf [module-name] 显示配置变量
NOTE3: 当你设置一个新值时，目标模块会自动重启
注意 4：类型转换是自动的(布尔值、数字、字符串)

发布模块

更新或发布模块非常简单。 pm2 publish 命令将增加模块的次要版本，git add . ; git commit -m “版本”； git push origin master 然后它将npm publish。

bash

cd my-module
pm2 publish

Modules <3 Keymetrics

使用 Keymetrics，您可以创建自定义界面使用指标监控和远程操作 .

这会给你这样的结果：

Keymetrics接口说明 pm2-mongodb module

Keymetrics接口说明 pm2-server-monit-module

Options with pmx.initModule

var pmx     = require('pmx');

var conf    = pmx.initModule({

    [...]

    // 自定义此模块的外观
    widget : {
      // 徽标显示在左上角块(必须是 https)
      logo  : 'https://image.url',
      theme : ['#9F1414', '#591313', 'white', 'white'],

      // 切换主小部件上方的水平块
      el : {
        probes : false,
        actions: false
      },

      block : {
        // 显示远程操作块
        actions : true,

        // 显示 CPU / 内存
        cpu     : true,
        mem     : true,

        // 问题计数显示
        issues  : true,

        // 显示元块
        meta    : true,

        // 显示有关探测器的元数据(重启 nb、解释器...)
        meta_block : true,

        // 要显示为“主要指标”的自定义指标的名称
        main_probes : ['Processes']
      },
    },
}, function(err, conf) {
  /**
   * Main module entry
   */
  console.log(conf);
  // Do whatever you need
  require('./business_logic.js')(conf);
});

更改配置值

在主要的 Keymetrics 仪表板中，模块将有一个名为“配置”的按钮。单击它后，您将能够访问或/和修改 package.json 上公开的所有配置变量！

想分享你的模块吗？

如果您构建了模块，请给我们发送电子邮件，我们将推广您的模块并将其添加到 Keymetrics：https://keymetrics.io/contact/

玩得开心！