Node-monitor 技术文档

1. 安装指南

首先，确保你的环境中已经安装了 Node.js。然后，在你的项目服务器目录中，运行以下命令来安装 node-monitor：

$ npm install monitor

接下来，在你的应用程序引导代码中添加以下代码行，并重启服务器：

require('monitor').start();

2. 项目使用说明

node-monitor 是一个用于远程监控和操控 Node.js 应用服务器的库。它提供了多种通用监控工具，并允许你为你的应用创建自定义监控。

使用 REPL 控制台监控应用

你可以使用 REPL 控制台进行临时监控。首先启动 REPL，然后获取 Monitor 类：

$ node

在控制台中运行以下代码：

> var Monitor = require('monitor');

现在，你可以连接到应用服务器上的一个探测器。这里有一些内置探测器，你也可以为你的应用或 npm 模块构建自定义探测器。以下是一个监控 "Process" 探测器的示例：

> var processMonitor = new Monitor({probeClass:'Process'});
> processMonitor.connect();

探测器是一个 Backbone.js 数据模型，它会实时更新，你可以使用 toJSON() 方法获取所有字段：

> processMonitor.get('freemem');

当你监控的数据发生变化时，它会发出 'change' 事件：

> processMonitor.on('change', function() {
... console.log(processMonitor.get('freemem'));
... });

使用自定义脚本监控应用

你可以使用 Node.js 作为脚本语言，编写执行任何 Node.js 可以执行的自定义监控。以下是一个当可用内存低于特定阈值时输出警告信息的示例。

将以下代码保存为 low-memory-warn.js 文件，并运行 node low-memory-warn：

// 低内存警告监控
var Monitor = require('monitor');
var LOW_MEMORY_THRESHOLD = 100000000;

var options = {
  hostName: 'localhost',
  probeClass: 'Process',
  initParams: {
    pollInterval: 10000
  }
}
var processMonitor = new Monitor(options);

processMonitor.on('change', function() {
  var freemem = processMonitor.get('freemem');
  if (freemem < LOW_MEMORY_THRESHOLD) {
    console.log('低内存警告: ' + freemem);
  }
});

processMonitor.connect(function(error) {
  if (error) {
    console.error('连接到进程探测器时出错: ', error);
    process.exit(1);
  }
});

在浏览器中监控应用

上述脚本同样适用于服务器中的 HTML <script> 标签。例如，将 var Monitor = require('monitor'); 替换为以下代码：

<script src="/path/to/monitor/dist/monitor-all.min.js"></script>

浏览器分布版本包含在 node-monitor 中，会将单个变量 Monitor 导出到全局命名空间，并且可以像 var Monitor = require('monitor'); 那样使用。

请注意，你的浏览器需要指向 localhost 或者位于防火墙后面，以便能够连接到配置的监控端口。参见下文的 “安全注意事项”。

在仪表盘中监控应用

monitor-dashboard 应用程序允许你在仪表盘中可视化你的监控。

$ npm install monitor-dashboard
$ npm start monitor-dashboard

3. 项目 API 使用文档

请访问 API 文档 来获取 node-monitor 的 JavaScript 文档。

4. 项目安装方式

项目的安装方式已在 “安装指南” 部分说明。通过 npm 安装 node-monitor 模块，并在应用引导代码中启动它。

---

请注意，出于安全考虑，默认情况下监控服务器只监听 localhost 的连接。如果你需要在多台机器之间进行监控，你需要更改默认配置以便监听非 localhost 地址。在更改配置之前，请确保了解相关风险，并采取外部措施以防止未授权访问。有关更多信息，请参见 config/external.js 文件中的说明。