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

@trussle/tricorder

v1.0.2

Published

Express middleware to provide basic metrics to Prometheus

Downloads

31

Readme

Tricorder

Build Status Maintainability Test Coverage

Maintained by @jonnyarnold

Express middleware to provide basic metrics to Prometheus.

Prometheus is an open source monitoring solution that obtains metrics from servers by querying against the /metrics endpoint upon them.

Once instrumented, Tricorder automatically serves response duration metrics, nodejs system and garbage collection metrics on the /metrics endpoint ready to be consumed by Prometheus.

The inbuilt metrics are the basics you'll need to gain insight into your application and conforming to best practise.

Installation and Setup

npm install @trussle/tricorder --save

Installation into an express application;

const express = require("express");
const tricorder = require("@trussle/tricorder");
const app = express();

tricorder.instrument(app);

API

Tricorder exposes;

  • instrument(Express, options) - used to add metrics to your express server
  • client() - expose prom-client for use throughout your application

Options

The options object supports the following properties;

  • url - metrics url defaults to /metrics

Metrics

Http

  • http_requests_processing (gauge)
  • http_requests_total{labels} (counter)
  • http_request_duration_seconds{labels} (histogram) - count duration in prom-client default buckets

When labels are indicated as in included they will be as follows;

  • status: the http status code of the response, e.g. 200, 500
  • method: the http method of the request, e.g. put, post.
  • path: the path of the request. Note that /users/freddie is labelled /users/:id so not to create a large number of timeseries

System

These are metrics provided by prom-client that instrument the nodejs heap/rss usage and cpu usage etc.

Garbage Collection

These are metrics provided by prometheus-gc-stats that instrument the nodejs gc.

Why

The node/express eco-system already has a collection of Prometheus middleware implementations which don't all conform to best practise making metrics hard to consume and use to drive alerting.

Tricorder is designed to be the swiss army knife of metrics providing everything you need to get started in an easy to consume package.