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

statman

v1.9.1

Published

Package to assist with collection of metrics, including stopwatch functionality

Downloads

8,390

Readme

statman

Node.js CI on npm Known Vulnerabilities Codacy Badge

statman is a set of modules to assist with collection of metrics

Supported metrics

  • gauge: represents a point in time measurement
  • meter: measures flow, including count and average time
  • stopwatch: used to record timings

Install it!

statman is decomposed into several smaller modules. To utilize the metric modules, you have two choices

  • access directly: this is recommended if there is one single metric package. Like if you just want the stopwatch
  • access via statman: this provides some capabilities such as a registry to easily access many metrics

Option 1: access directly

Install using npm:

npm install statman-stopwatch

Reference in your app:

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

Option 2: access from statman

Install using npm:

npm install statman

Reference in your app:

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

Use it!

Registry

statman provides a registry that allow for you to track your metrics.

You can manually add metrics to the registry. For the built in metrics, you can also auto-register those while creating

// register a metric with a key
var metric = { ..some object.. }
statman.register('my metric name', metric)

// register a metric with implicit key = name
var metric2 = { name: 'my second metric' ..some object.. }
statman.register(metric2);

// access metric from registry
statman.registry('my metric name') //return metric

Gauge

For the capabilities of gauge see: https://github.com/jasonray/statman-gauge

The following two approaches are equivalent

Explicit creation of gauge

var gauge = statman.gauge('metric-name');
statman.regiser(gauge);
gauge.set(5);

Create and register a gauge

statman.gauge('metric-name').set(5);   //if gauge by name 'metric-name' does not exist, create one, and set to '5'
statman.gauge('metric-name').value()   //return '5'

Meter

meter

Stopwatch

stopwatch

Extend it!

TODO: how to build a new metric

Build it!

  • Make sure that you have node and npm installed
  • Clone source code to you local machine
  • Setup dependencies: npm install
  • run tests: npm test

Roadmap

  • Add meter
  • Move stopwatch back to its own repo. Sigh.
  • Create reporters to output metrics
  • Provide guidance how to hook with HTTP/TCP/async calls
  • Provide hook to register with express
  • Integrate with visualizations
  • Provide web interface to access metrics