1.0.0 • Published 10 years ago

upmon v1.0.0

Weekly downloads
4
License
ISC
Repository
github
Last release
10 years ago

upmon Build Status Dependency Status Coverage Status Gitter

Super simple service health monitoring.

Upmon sends a HTTP GET request to your configured URLs. It expects a HTTP 200 response. If it gets any other response code it'll send an email. If the service recovers, it'll send another email.

Getting started

  1. npm install -g upmon upmon-mail
  2. Create a new $HOME/.upmonrc file and add config:

    {
      "ping": {
        // Time in ms between pings
        "interval": 5000,
        // URL's of services to ping
        "services": ["http://localhost:8000/"]
      },
      "mail": {
        // Email from address
        "from": "upmon@example.org",
        // Email to address(es)
        "to": ["sysadmin@example.org"],
        // Nodemailer transport options
        // http://www.nodemailer.com/
        "transport": { 
          "service": "",
          "auth": {
            "user": "",
            "pass": ""
          } 
        }
      }
    }
  3. upmon | upmon-mail

SMS

Need a txt message sent to your phone when a service goes down?

  1. npm install -g upmon-sms
  2. Add SMS config to your $HOME/.upmonrc file:

    {
      "sms": {
        // SMS provider config
        // For supported providers see https://github.com/alanshaw/upmon-sms
        "messagebird": {
          "accessKey": "live_hy6ggbrRf4Bvfe48GGip8MtJM",
          "originator": "447000000000",
          "recipients": "447000000000"
        }
      }
    }
  3. upmon | upmon-mail | upmon-sms

Graph

Want to see a pretty graph of your services and their status/round trip time?

  1. npm install -g upmon-graf
  2. Add graf config to your $HOME/.upmonrc file:

    {
      "graf": {
        // Port to run graf server on
        "port": 5000
      }
    }
  3. upmon | upmon-mail | upmon-sms | upmon-graf

Build your own monitor

Want to run upmon from guvnor or pm2?

Create a new project, add a .upmonrc config file, install the upmon modules you need, and pipe them together!

monitor.js

var upmon = require('upmon')
var mail = require('upmon-mail')
var sms = require('upmon-sms')

upmon().pipe(mail()).pipe(sms()).pipe(process.stdout)
pm2 start monitor.js
1.0.0

10 years ago

0.9.1

11 years ago

0.9.0

11 years ago

0.8.0

11 years ago

0.7.0

11 years ago

0.6.0

11 years ago

0.5.1

11 years ago

0.5.0

11 years ago

0.4.0

11 years ago

0.3.1

11 years ago

0.3.0

11 years ago

0.2.2

11 years ago

0.2.1

11 years ago

0.2.0

11 years ago

0.1.0

11 years ago