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

@gopuff/healthz

v0.0.17

Published

Library for creating health check endpoints

Downloads

3

Readme

HealthZ

library for generating standard health check endpoints which return useful stats including host stats and reports of downstream dependencies.

Installation

to install this library, run npm install @gopuff/healthz

Usage

import the HealthZ object and instantiate a new instance

const { HealthZ } = require('@@gopuff/healthz')
const hz = new HealthZ()

Register dependencies by providing a name of the dependency, the function to perform, and the arguments of that function

Example with a raw function

import * as rpn from 'request-promise-native'
import * as https from 'https'

const agent = new https.Agent({ keepAlive: true })
const rp = rpn.defaults({ agent })
hz.registerDep('lorem', rp, 'https://jsonplaceholder.typicode.com/todos/1')

Example with an object function that uses the this context

// Psuedo azure cosmos client object
import { CosmosService } from '../lib/cosmos'
const cosmos = new CosmosService('connection_string', 'collection', 'container')

// Register the dependency with HealthZ
hz.registerDep(
  'cosmos-mycontainer', 
  (query: string) => cosmos.query(query), // need to pass as anonymous or we'll lose this binding
  'Select * from c where c.partitionKey = "my_patition_key"'
)

Generate the health stats to return to the caller

const health = await hz.getHealth()
res.status(hz.status).json(health)

This will return a response object with the status set to 200 if all dependencies are successful and 500 if any are unsuccessful. The object looks like this:

{
  "host": {
    "memoryUsageMB": 40.86183547973633,
    "cpuTime": {
      "user": 327468000,
      "system": 26531000
    },
    "platform": "win32",
    "version": "v12.18.0",
    "uptime": 11230.1285054
  },
  "dependencies": {
    "cosmos": {
      "latency": 52,
      "success": true
    },
    "lorem": {
      "latency": 3,
      "success": true
    }
  }
}

If a dependency is unsuccessful, an error is included in the object like so:

{
  "host": {
    "memoryUsageMB": 40.86183547973633,
    "cpuTime": {
      "user": 327468000,
      "system": 26531000
    },
    "platform": "win32",
    "version": "v12.18.0",
    "uptime": 11230.1285054
  },
  "dependencies": {
    "cosmos": {
      "latency": 52,
      "success": true
    },
    "error-endpoint": {
      "success": false,
      "latency": 78,
      "error": {
        "name": "StatusCodeError",
        "statusCode": 404,
        "message": "404 - \"{}\"",
        "error": "{}",
        "options": {
          ...
        },
        "response": {
          "statusCode": 404,
          "body": "{}",
          "headers": {
            ...
          },
          "request": {
            ...
          },
          "method": "GET",
          "headers": {}
        }
      }
    }
  }
}

Examples

In an express app, we can add a route to /healthcheck with the following controller:

Simple request

It can be useful to chain these if you have multiple services that use the healthz library since the lib will set the status to a 500 if any dependencies are unsuccessful. This way, we can deduce if the service in question is unhealthy or if it is a downstream dependency. This isn't required as any simple request can be used as well which we can do like this:

// Express
import { Router, Request, Response, NextFunction } from 'express'
const router = Router()

// Request client
import * as rpn from 'request-promise-native'
import * as https from 'https'
const agent = new https.Agent({ keepAlive: true })
const rp = rpn.defaults({ agent })

// HealthZ lib
const { HealthZ } = require('@gopuff/healthz')
const hz = new HealthZ()

// Register our service endpoint
hz.registerDep(
  'myservice', 
  rp, 
  'https://myservice.mydomain.com/healthcheck' // uses the healthz lib
)

// Endpoint
router.get('/', async (req: Request, res: Response, next: NextFunction) => {
  try {
    const health = await hz.getHealth()
    res.status(hz.status).json(health)
  } catch (err) {
    console.log(err)
    next(err)
  }
})

export const HealthCheckController: Router = router

Client object that uses this

// Express
import { Router, Request, Response, NextFunction } from 'express'
const router = Router()

// Psuedo Cosmos client
import { CosmosService } from '../lib/cosmos'
const cosmos = new CosmosService('connection_string', 'collection', 'container')

// Instantiate HealthZ and register our Cosmos client
const { HealthZ } = require('@gopuff/healthz')
const hz = new HealthZ()

// Register our Cosmos client
hz.registerDep(
  'cosmos', 
  (query: string) => cosmos.query(query), 
  'Select * from c where c.partitionKey = "my_partition_key"'
)

// Endpoint
router.get('/', async (req: Request, res: Response, next: NextFunction) => {
  try {
    const health = await hz.getHealth()
    res.status(hz.status).json(health)
  } catch (err) {
    console.log(err)
    next(err)
  }
})

export const HealthCheckController: Router = router