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

health-check-library

v2.0.1

Published

Expose an health-check API to *-worker or a health-check route for already existing API

Downloads

8,344

Readme

health-check-library

Expose an health-check API to *-worker or a health-check route for already existing API

Kubernetes (Google Container Engine, Clever-cloud and so on...) requires every processes to expose an HTTP API so it can ensure the service is up.

Instead of duplicating code everywhere in the code, the health-check-library simply expose a route in a language-agnostic and unified way.

Specification

health-check-library MUST expose a GET /_health route that yield a 200 HTTP status code. health-check-library follows semver so any non-backward-compatible change will be a major release.

Features

  • Language agnostic, if it's not supported in your current language simply send a PR that follows the above conventions
  • Framework agnostic, if the framework you use is not supported simply send a PR that follows the above conventions

Currently supported

JavaScript

JavaScript / pure (without an existing HTTP API)

Use this when your NodeJS process (a.k.a worker) does not currently expose an HTTP API.

// Usage
require('health-check-library')(port [, callback]);

If health-check-library was not able to bind to the specified port it will throw an error and make the worker crash (that's a good thing).

var healthy = require('health-check-library/javascript/pure')(8080, function onListening(){

    // do some initializations
    healthy(true); // you are ready
});

JavaScript / hapi

Use this when your NodeJS process already exposes an HTTP API with HAPI. Please note that HAPI should always* be used in NodeJS, don't forget to document your API with swaggerize-hapi.

If health-check-library was not able to register itself to the HAPI server it will throw an error and will make the process crash (that's a good thing).

var healthy = require('health-check-library').register(server);

// by default GET /health will yield a 500 error

healthy(true);

// now GET /health yield an 200 success
  • always = 99.9% of the time