首页
/ Node-monitor 技术文档

Node-monitor 技术文档

2024-12-20 23:45:24作者:龚格成

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 文件中的说明。

登录后查看全文
热门项目推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
139
1.91 K
kernelkernel
deepin linux kernel
C
22
6
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
273
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
923
551
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
421
392
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
74
64
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
344
1.3 K
easy-eseasy-es
Elasticsearch 国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
36
8