drulia / node-site-monitor Goto Github PK

#--- Currently not being maintained ---

#Node Site Monitor

A simple node server that will check the status of any number of websites and alert any number of users in different ways.

##Why do this??

Well, we wanted a free distributed system for monitoring our websites. We can easily do that with various free node hosting solutions. The different alert types are free and therefore the entire end-to-end check doesn't cost a thing.

##Install

npm install site-monitor

OR

git clone git://github.com/hootware/node-site-monitor.git

##Usage

###Command line

This will use the config.json file

node site-monitor

###Code

You can optionally give all the options in the monitor method, or it will use the default config.json

var monitor = require('site-monitor');
monitor(opts) //see sample-config.json for options.

##Check types

The different ways that are checked to see the status of a site

• Check if host is reachable
• Check HTTP status code
• Check for connect timeouts
• Check to see if text on the page matches what is expected

##Alert types

The different ways of sending alerts to users. Users can have multiple methods, each with different "availability windows"

• E-mail:
  • GMail is the only service available at the moment
  • Other providers/SMTP setup coming soon
• MQTT - MQ Telemetry Transport
  • Supply an array of brokers to connect to
  • Supply a different topic for each user
• (future) Twitter DM (free SMS!)
• (future) Twitter mention
• (future) Custom POST request
• Make your own... just extend the base communication class lib/communication/base.js

##Storage types

The different ways to store the site check data and what

• stdout (console.log)
• (future) file
• (future) MySQL
• (future) MongoDB
• Make your own... just extend the base communication class lib/storage/base.js

##Setup This is all done in a simple config file. As long as you match the format in the config.json example it will work fine. The arrays in the config don't have any soft limits, so the only limits will be in node or hardware. Let us know if you have any issues. If you want to change the config, you need to restart the application.

Copy the sample-config.json and rename to config.json then start the application.