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 🙏

© 2021 – Pkg Stats / Ryan Hefner

standard-healthcheck

v1.0.1

Published

Healthcheck endpoint for Express per IETF Standards

Downloads

90

Readme

standard-healthcheck

Build Status Test Coverage Maintainability

This tiny library exposes a health check endpoint in a standard response format per Internet Engineering Task Force (IETF). The proposed standard includes a few properties not included in standard extensions:

  • description
  • version number (important for debugging)
  • uptime
  • details about dependent downstream services

Example Output

Example JSON response from https://nodejs-demo.onazure.io/health

{
  "status": "pass",
  "description": "A multipurpose dummy node.js app for cloud architecture demos",
  "version": "0.2.1",
  "details": {
    "uptime": {
      "component_type": "system",
      "observed_value": 74401.282209224,
      "human_readable": "0 days, 20 hours, 40 minutes, 1 seconds",
      "observed_unit": "s",
      "status": "pass",
      "time": "2020-02-20T13:05:11.307Z"
    },
    "env": {
      "WEBSITE_HOSTNAME": "azure-nodejs-demo.azurewebsites.net",
      "WEBSITE_INSTANCE_ID": "c33cdebf5b0f427fdd331f28322f183c95c5320c0c952d9194ad7ce9867c2eaa"
    }
  }
}

For details about schema, see IETF draft document.

Usage

npm install --save standard-healthcheck

Then import the library in your Express.js application and add the route to your app:

const healthcheck = require('standard-healthcheck')

app.get('/health', healthcheck({
    version: '1.0',
    description: 'My demo app',
    includeEnv: ['NODE_ENV']
})

Optional: Environment variables

The proposed standard because is friendly for debugging. You can ask standard-healthcheck to output some environment variables (not recommended for production!) via the includeEnv optional property.

But it will ignore variables ending with SECRET, PASSWORD, _KEY and _PASS for security reasons.