statman gauge

统计量表

statman-gauge是statman库中的指标之一。松散地基于 Codehale 度量包，仪表是一种瞬时测量度量。这可用于捕获队列大小、处理的消息数量或系统中其他一些有趣的事情。

警告！！如果你看gauge这个词足够长的时间，它看起来拼写错误

安装它！

方式一：直接访问

使用 npm 安装：

npm install statman-gauge

您的应用程序中的参考：

 var Gauge = require ( 'statman-gauge' ) ;
var gauge = Gauge ( 'gauge-name' ) ;

选项 2：从statman访问

使用 npm 安装：

npm install statman

您的应用程序中的参考：

 var statman = require ( 'statman' ) ;
var gauge = statman . Gauge ( 'gauge-name' ) ; 

使用它！

构造函数

• Gauge() => 创建仪表实例
• Gauge(name) => 创建带有名称的仪表实例
• Gauge(name, f()) => 创建具有名称的仪表实例，其中 f 是返回仪表值的函数

增量

• increment() => 将值增加 1
• increment(value) => 按值递增

 gauge . increment ( ) ;  //increment by 1
gauge . increment ( 10 ) ; //increment by 10

递减

• decrement() => 将值减 1
• decrement(value) => 按值递减

 gauge . decrement ( ) ;  //decrement by 1
gauge . decrement ( 10 ) ; //decrement by 10

放

• set(value) => 仪表设定值

 gauge . set ( 5 ) ;

价值

• value() => 获取仪表的值

 gauge . value ( ) ;

例子：

假设我们想要创建一个测量队列大小的计量器。下面说明如何注册。

方法一（直接使用仪表）

 var Gauge = require ( 'statman-gauge' ) ;
var gauge = Gauge ( 'queueSize' ) ;

function enqueue ( message ) {
	data . push ( message ) ;
	gauge . increment ( ) ;
}

function dequeue ( ) {
	data . pop ( message ) ;
	gauge . decrement ( ) ;
} 

方法2（通过statman使用gauge）

 TODO

方法3（使用自定义值函数）

 var Gauge = require ( 'statman-gauge' ) ;
var gauge = Gauge ( 'queueSize' , function ( ) {
	return data . size ( ) ;
} ) ;

function enqueue ( message ) {
	data . push ( message ) ;
}

function dequeue ( ) {
	data . pop ( message ) ;
} 

建造它！

• 确保已安装node和npm
• 将源代码克隆到本地计算机
• 设置依赖项： npm install
• 运行测试： npm test