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

rtp-monitoring-metrics

v0.1.0

Published

Monitoring and metrics endpoints for node.js applications

Downloads

6

Readme

RTP monitoring and metrics

This module is intended to be used with node.js web apps using Express. It exports an express router which provides useful endpoints.

Endpoints provided

The following endpoints are provided:

GET /metrics

This will return metrics in the following JSON format, with HTTP 200:

{
  "cpu": 5.5,
  "memory": {
    "rss": 92643328,
    "heapTotal": 71131392,
    "heapUsed": 40280776
  }
}

Note: if an error occurs attempting to generate the metrics HTTP 500 will be returned with JSON containing the error

GET /healthz

This will check that a session store is available and return HTTP 200 all is ok. The JSON response will be in the following format:

{
  "app": "OK",
  "session": "OK"
}

If the request to the endpoint times out then the app is not alive. Also if there is not a session store available HTTP 500 will be returned and it will state "unavailable".

GET /readiness

The readiness endpoint operates exactly the same as the /healthz endpoint.

How to use

  1. Add this module to your application using npm install --save rtp-monitoring-metrics
  2. Add the exported router to you app: app.use(require('rtp-monitoring-metrics'));

Additional configuration

If you would like to mount the middleware functions under a sub-route, you can do so using express out the box

app.use('/path-to-mount-at', require('rtp-monitoring-metrics'));