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