Node's Package Magician

    @todotoit/healthcheck

    1.0.9 • Public • Published

    HealthCheck

    Simple utility class to setup periodic http pings to an endpoint. Used to monitor an app uptime and report errors.

    Install

    npm install @todotoit/healthcheck
    

    Usage

    import HealthCheck from '@todotoit/healthcheck'
    const hc = new HealthCheck({options})
    
    hc.start()  // starts a timer - called by default when calling new HealthCheck() without autorun: false;
    hc.stop()   // stops a running timer
    hc.error()  // makes an http request to the configured fail endpoint

    Error reporting

    const hc = new HealthCheck({fail: 'YOUR_FAIL_ENDPOINT'})
    
    doSomething()
      .then(...)
      .catch(e => {
        hc.error()
      })

    Options

    {
      url: '...',         // the url for the http request
      interval: 3600,     // default: pings every hour - can be a later time string eg. "every 6 hours"
      autorun: true,      // by default, the timer starts when the class is instantiated, you can set this to false to start it programmatically using hc.start()
      fail: '/fail'       // alternative url to call when reporting errors - absolute if it starts with the protocol (http:// or https://), appended to the default url if not
      callback: false     // a callback to be called each time the healthcheck runs - it receives the response text as an argument
    }

    Development

    1. Build the library
    • Run npm install to get the project's dependencies
    • Run npm run build to produce minified version of the library.
    1. Development mode
    • Having all the dependencies installed run npm run dev. This command will generate an non-minified version of the library and will run a watcher so you get the compilation on file change.

    Keywords

    none

    Install

    npm i @todotoit/healthcheck

    DownloadsWeekly Downloads

    2

    Version

    1.0.9

    License

    MIT

    Unpacked Size

    47.8 kB

    Total Files

    11

    Last publish

    Collaborators

    • ebondioli