自定义指标

暴露指标

通过将自定义指标插入到您的代码中，您将能够实时监控代码中的值。

快速入门

首先安装 tx2 模块

$ npm install tx2

然后创建一个名为 monit.js 的应用程序

const tx2 = require('tx2')
const http = require('http')

let meter = tx2.meter({
  name      : 'req/sec',
  samples   : 1,
  timeframe : 60
})

http.createServer((req, res) => {
  meter.mark()
  res.writeHead(200, {'Content-Type': 'text/plain'})
  res.write('Hello World!')
  res.end()
}).listen(6001)

并使用 PM2 启动它

$ pm2 start monit.js

现在使用以下命令显示指标

$ pm2 show [app]
# pm2 show monit

注意：指标位于“自定义指标”部分。

或者您可以使用基于终端的界面

$ pm2 monit

指标助手可用

然后，您可以编写自己的指标来跟踪重要信息。可以使用 4 种不同的探针

  • 简单指标：可以立即读取的值
    • 例如，监控变量值
  • 计数器：递增或递减的值
    • 例如，正在处理的下载量，连接的用户数
  • 仪表：作为事件/间隔测量的值
    • 例如，HTTP 服务器每分钟的请求数
  • 直方图：保留一个统计相关的数值库，偏向于最后 5 分钟，以探索它们的分布
    • 例如，监控数据库查询执行的平均值

API 文档

注意：请参阅 TX2 API 文档

示例

简单指标：简单值报告

这允许公开可以立即读取的值。

const tx2 = require('tx2')

// Here the value function will be called each second to get the value
var metric = tx2.metric({
  name    : 'Realtime user',
  value   : function() {
    return Object.keys(users).length
  }
})

// Here we are going to call valvar.set() to set the new value
var valvar = tx2.metric({
  name    : 'Realtime Value'
})

valvar.set(23)

计数器：顺序值更改

递增或递减的值。

计算活动 HTTP 请求数的示例

const tx2 = require('tx2')
var http = require('http')

var counter = tx2.counter({
  name : 'Active requests'
})

http.createServer(function (req, res) {
  counter.inc()

  req.on('end', function() {
    // Decrement the counter, counter will eq 0
    counter.dec()
  })
  res.writeHead(200, {'Content-Type': 'text/plain'})
  res.write('Hello World!')
  res.end()
}).listen(6001)

仪表：平均计算值

作为事件/间隔测量的值。

计算每秒查询数的示例

const tx2 = require('tx2')
var http = require('http')

var meter = tx2.meter({
  name      : 'req/sec',
  samples   : 1,
  timeframe : 60
})

http.createServer(function (req, res) {
  meter.mark()
  res.writeHead(200, {'Content-Type': 'text/plain'})
  res.write('Hello World!')
  res.end()
}).listen(6001)
选项

samples 选项是速率单位。默认为 1 秒。timeframe 选项是分析事件的时间范围。默认为 60 秒。

直方图

保留一个统计相关的数值库，偏向于最后 5 分钟，以探索它们的分布。

const tx2 = require('tx2')

var histogram = tx2.histogram({
  name        : 'latency',
  measurement : 'mean'
})

var latency = 0

setInterval(function() {
  latency = Math.round(Math.random() * 100)
  histogram.update(latency)
}, 100)
为此页面做出贡献