statman-gauge is one of the metrics from the statman library. Loosely based upon codehale metric package, a gauge is an instantaneous measurement metric. This can be use to capture things like the size of a queue, number of messages processed, or some other interesting thing within your system.
WARNING!! if you look at the word gauge long enough, it looks misspelled
Install using npm:
npm install statman-gaugeReference in your app:
var Gauge = require('statman-gauge');
var gauge = Gauge('gauge-name');Install using npm:
npm install statmanReference in your app:
var statman = require('statman');
var gauge = statman.Gauge('gauge-name');- Gauge() => create instance of a gauge
- Gauge(name) => create instance of a gauge with name
- Gauge(name, f()) => create instance of a gauge with name, where f is a function that returns the value for the gauge
- increment() => increment value by 1
- increment(value) => increment by value
gauge.increment(); //increment by 1
gauge.increment(10); //increment by 10- decrement() => decrement value by 1
- decrement(value) => decrement by value
gauge.decrement(); //decrement by 1
gauge.decrement(10); //decrement by 10- set(value) => set value of gauge
gauge.set(5);- value() => get the value of the gauge
gauge.value();Suppose that we want to create a gauage that measures that size of a queue. The below indicates how to register this.
var Gauge = require('statman-gauge');
var gauge = Gauge('queueSize');
function enqueue(message) {
data.push(message);
gauge.increment();
}
function dequeue() {
data.pop(message);
gauge.decrement();
}TODO
var Gauge = require('statman-gauge');
var gauge = Gauge('queueSize', function() {
return data.size();
});
function enqueue(message) {
data.push(message);
}
function dequeue() {
data.pop(message);
}- Make sure that you have
nodeandnpminstalled - Clone source code to you local machine
- Setup dependencies:
npm install - run tests:
npm test
![greenkeeper[bot] avatar](https://avatars.githubusercontent.com/in/505?v=4 "greenkeeper[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent