简介
Simple Metric Server 是一款 Node.js 的简单实用的指标监控系统,它可以以简单的方式帮助你监视你的 Node.js 应用的性能状况。
安装
在终端命令行输入以下命令进行安装:
--- ------- --------------------
使用
在你的 Node.js 代码中引入 Simple Metric Server 模块,然后像下面这样使用:
----- - ------------ - - -------------------------------- ----- ------------ - --- -------------- ----- ---- --- ----- ------- - ----------------------------------------- --------------- ----- ----- - ------------------------------------- ------------- ----- --------- - --------------------------------------------- ---------------------
API
MetricServer
MetricServer
类是 Simple Metric Server 的核心类,它是将您的指标存储在内存中,并启动一个 HTTP 服务器,以便您可以通过浏览器查看指标数据。
构造函数参数:
port
{number} HTTP 服务器端口号,默认为3000
。
方法:
createCounter(name: string, [helpText: string]): Counter
创建一个名为name
的计数器,并返回Counter
实例。createGauge(name: string, [helpText: string]): Gauge
创建一个名为name
的样本,它会被记录为特定值,并返回Gauge
实例。createHistogram(name: string, [helpText: string]): Histogram
创建一个名为name
的时间序列样本,并返回Histogram
实例。middleware() => (req, res, next) -> void
请求中间件,用于将/metrics
端点映射到当前服务器的指标数据。
Counter
Counter
类代表一个计数器,您可以通过调用 inc
方法来增加它的值。
方法:
inc(amount: number = 1): void
将计数器增加amount
。
Gauge
Gauge
类代表一个样本,它会被记录为特定值。您可以调用 set
方法来为样本设置一个新值。
方法:
set(value: number): void
为样本设置一个新值。
Histogram
Histogram
类代表一个时间序列样本,您可以使用 observe
方法将值添加到样本中。
方法:
observe(value: number): void
将值添加到样本中。
示例
以下是一个简单的 Node.js 应用程序,它使用 Simple Metric Server 来记录一个简单的计数器和一个简单的样本值,并在控制台中输出一些信息:
----- - ------------ - - -------------------------------- ----- ------------ - --- -------------- ----- ---- --- ----- ------- - ---------------------------------------- ----- -- - ------ ---------- ----- ----- - ------------------------------------ ----- -- - ------ -------- -------------- -- - --------------- ----------------------- - ----- -- ------ ------------------- ------ ------ -- ------- -- ------------------------
这个应用每秒钟增加一次计数器值,同时每秒钟产生一个随机数来更新样本值。控制台中将输出一条消息,告诉您应用正在运行。
现在您可以打开浏览器并访问 http://localhost:8000/metrics
来查看指标数据。
来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/60066b5751ab1864dac66da2