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

warden

v0.1.1

Published

A wrapper for Panopticon that makes adding measurements to your codebase simple and efficient.

Downloads

8

Readme

warden

A wrapper for Panopticon that makes adding measurements to your codebase simple and efficient.

Panopticon already makes it easy to sample data and aggregate it over a Node.js cluster. What warden adds is the ability to use require('warden') to gain access to one or more Panopticon instances anywhere in your project. No need to roll your own module to contain panoptica and use awkward path-like requires's to use it.

Setup

You should require warden and call it on both the cluster master and cluster workers of your service. For example:

var cluster = require('cluster');
var warden = require('warden');

// Calling setup before cluster logic is an easy way to call it on all processes.
warden.setup([/* intervals */], { /* Panopticon config */ });

// warden.setup should be run on all processes. Below is how I handle cluster.
if (cluster.isMaster && process.env.NODE_ENV === 'production') {
    require('./master.js'); // Handles all master logic.
} else {
    require('./worker.js'); // Entry point to the service logic.
}

The configuration argument is the same as that of Panopticon, but you should omit the interval field since this is overridden by the intervals argument. It turns out to be useful to have more than one instance of Panopticon with different intervals.

Usage

Once warden.setup has been called, you can simply require warden in any module you want to collect measurements in. The warden has the same measurement methods as Panopticon, and you can even add your own. See the Panopticon documentation for the logger methods. For example, an express middleware that measures response time could look like:

var warden = require('warden');

module.exports = function (req, res, next) {
    'use strict';

    var t0 = process.hrtime();

    res.once('finish', function () {
        // Δt in high resolution. Panopticon has a timedSample method that uses these.
        var t1 = process.hrtime(t0);

        // For grouping related measurements.
        var path = ['webservice', req.route.path, req.route.method];

        warden.timedSample(path, 'responseTime' t1);
    });

    next();
}

Delivery

After each interval elapses, aggregated data is emitted on the delivery event of warden. This emission only happens on master, so you must handle the data in your master process. The form of the data can be customized during setup. See here for information.