statman gauge

スタットマンゲージ

statman-gauge statmanライブラリのメトリクスの 1 つです。コードヘイル メトリック パッケージに大まかに基づいたゲージは、瞬間的な測定メトリックです。これは、キューのサイズ、処理されたメッセージの数、システム内のその他の興味深い情報などをキャプチャするために使用できます。

警告！！ gauge単語を長く見ると、スペルが間違っているように見えます

インストールしてください！

オプション 1: 直接アクセス

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 ずつインクリメントします
• インクリメント(値) => 値ごとにインクリメント

 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 ( ) ;

例：

キューのサイズを測定するゲージを作成するとします。以下に登録方法を示します。

方法1（ゲージを直接使用する）

 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 (スタットマン経由でゲージを使用)

 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