statman gauge

jauge statman

statman-gauge est l'une des métriques de la bibliothèque statman . Librement basée sur le package métrique Codehale, une jauge est une métrique de mesure instantanée. Cela peut être utilisé pour capturer des éléments tels que la taille d'une file d'attente, le nombre de messages traités ou toute autre chose intéressante au sein de votre système.

AVERTISSEMENT!! si vous regardez le mot gauge assez longtemps, il semble mal orthographié

Installez-le !

Option 1 : accéder directement

Installez à l'aide de npm :

npm install statman-gauge

Référence dans votre application :

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

Option 2 : accès depuis statman

Installez à l'aide de npm :

npm install statman

Référence dans votre application :

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

Utilisez-le !

Constructeur

• Gauge() => créer une instance d'une jauge
• Gauge(name) => créer une instance d'une jauge avec un nom
• Gauge(name, f()) => créer une instance d'une jauge avec un nom, où f est une fonction qui renvoie la valeur de la jauge

Incrément

• incrément() => incrémente la valeur de 1
• incrément(valeur) => incrément de valeur

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

Décrémenter

• decrement() => décrémenter la valeur de 1
• décrémenter(valeur) => décrémenter de valeur

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

Ensemble

• set(value) => définir la valeur de la jauge

 gauge . set ( 5 ) ;

Valeur

• value() => obtenir la valeur de la jauge

 gauge . value ( ) ;

Exemple:

Supposons que nous souhaitions créer un indicateur mesurant cette taille de file d’attente. Ce qui suit indique comment l'enregistrer.

Méthode 1 (utiliser la jauge directement)

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

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

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

Méthode 2 (utiliser la jauge via statman)

 TODO

Méthode 3 (utiliser la fonction de valeur personnalisée)

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

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

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

Construisez-le !

• Assurez-vous que node et npm sont installés
• Cloner le code source sur votre ordinateur local
• Dépendances d'installation : npm install
• exécuter des tests : npm test