npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

metrics-server

v0.2.2

Published

Basic metrics server and client.

Downloads

14

Readme

metrics-server

metrics-server is a basic metrics server and client. The client uses UDP to send metric to the server. The server stores all metric into a mongodb database.

examples

var usage = require('usage');

var udpServer = require('./lib/udpserver').createServer({
	host : '127.0.0.1',
	port : 4001,
	mongodb : {
		host : '127.0.0.1'
	}
});

var webServer = require('./lib/webserver').createServer({
	udp : udpServer,
	host : '127.0.0.1',
	port : 4002,
	mongodb : {
		host : '127.0.0.1'
	}
});

var memory = require('./lib/metric').createMetric({
	host : '127.0.0.1',
	port : 4001
});

var cpu = require('./lib/metric').createMetric({
	host : '127.0.0.1',
	port : 4001
});

memory.interval = cpu.interval = false;
memory.token = cpu.token = 'random-token';

memory.name = 'memory';
cpu.name = 'cpu';

var pid = process.pid;
setInterval(function() {

	usage.lookup(pid, {
		keepHistory : true
	}, function(err, result) {
		memory.cb(result.memory);
		cpu.cb(result.cpu);
	});
}, 1000);

webServer.start();
udpServer.start();
memory.start();
cpu.start();

Methods

var Metrics = require('metrics-server')

var udpserver = Metrics.udpserver.createServer(opts);

To create the UDP server. This is used to recive metrics from the clients. Options to pass in are

{
	host : '127.0.0.1',
	port : 4001,
	mongodb : {
		host : '127.0.0.1',
		port : 27017,
		path : '/data/db'
	}
}

udpserver.start()

Call udpserver.start to start the server

var webserver = Metrics.webserver.createServer(opts);

To create the UDP server. This is used to recive metrics from the clients. Options to pass in are

{
	host : '127.0.0.1',
	port : 4002,
	mongodb : {
		host : '127.0.0.1',
		port : 27017,
		path : '/data/db'
	}
}

webserver.start()

Call webserver.start to start the server

var metric = Metrics.metric.createMetric(opts)

This is used to send metrics to the server.

{
	host : '127.0.0.1',//use the udp server host
	port : 4002//use the udp server port
}

metric.token = uuid()

metric.token is used to group metrics together. The token should non guessable string.

metric.name = 'cpu'

metric.name is the name of the metrics type

metric.interval = 5000

metric.interval is the interval in milliseconds between calls to metric.run() If you set this to false then you can manually call metric.cb(metricValue)

metric.run = function(cb){}

metric.run is the function that is called when using metric.interval

metric.run = function(cb){
	setTimeout(function(){
		cb(Math.floor((Math.random() * 100) + 1));
	},100);
}

metric.cb(value)

metric.cb is used when metric.interval is set to false You would call it directly when you dont want call metric.run

setInterval(function(){
	metric.cb(Math.floor((Math.random() * 100) + 1));
},1000);

metric.start()

Call metric.start to start collection metrics

##API Metrics.webserver is used to recive metric from the database.

GET /metric/:token

Called to recive metrics from the DB

query name=cpu

Query the database for e certen metrics name.

query from=2014-05-08T00:04:56.656Z

Query the database from a certain time.

query to=2014-05-08T00:04:56.656Z

Query the database to a certain time. Must include from.

query limit=500

Query the database and pull out 500. Defaults to 1000, MAX is 10000.

GET /metric/:token/count

Count the metrics in the DB. Same query params can be sent as /metric/:token