labianchin/watchmen repository overview

⁠watchmen: a service monitor for node.js

• watchmen monitors health (outages, uptime, response time warnings, avg. response time, etc) for your servers.
• ping types are pluggable through npm modules. At this time, http-head and http-contains are available. Read more about ping services and how to create one below.
• watchmen provides custom actions through plugins (console outpug, email notifications, etc).
• the code base aims to be simple and easy to understand and modify.

⁠Demo

Check the web interface in action⁠.

⁠Installation

⁠Requirements

Make sure bower is installed globally:

$ npm install -g bower

Get redis from redis.io⁠ and install it.

⁠Install watchmen

git clone [email protected]:iloire/WatchMen.git
cd WatchMen

$ npm install

⁠Running and stopping watchmen

Make sure you have redis-server in your PATH. Then you can run watchmen services:

$ redis-server redis.conf
$ node run-monitor-server.js
$ node run-web-server.js

⁠Managing your node processes with pm2

Install pm2:

$ npm install -g pm2

Configure env variables:

$ export WATCHMEN_WEB_PORT=8080

Run servers:

$ pm2 start run-monitor-server.js
$ pm2 start run-web-server.js

Server list:

$ pm2 list

⁠Configuration

Config is set through env variables.

Have a look at the /config folder for more details, but the general parameters are:

export WATCHMEN_BASE_URL='http://watchmen.letsnode.com'
export WATCHMEN_WEB_PORT='8080'
export WATCHMEN_ADMINS='[email protected]'
export WATCHMEN_GOOGLE_ANALYTICS_ID='your-GA-ID'

⁠Authorization settings (since 2.2.0)

Watchmen uses Google Auth through passportjs for authentication. If your google email is present in WATCHMEN_ADMINS env variable, you will be able to manage services.

Make sure you set the right hostname so the OAuth dance can be negociated correctly:

export WATCHMEN_BASE_URL='http://watchmen.letsnode.com/'

You will also need to set the Google client ID and secret using env variables accordingly. (Login into https://console.developers.google.com/⁠ to create them first)

export WATCHMEN_GOOGLE_CLIENT_ID='<your key>'
export WATCHMEN_GOOGLE_CLIENT_SECRET='<your secret>'

⁠Ping services

⁠Embedded ping services

⁠HTTP-HEAD

https://www.npmjs.com/package/watchmen-ping-http-head⁠

⁠HTTP-CONTAINS

https://www.npmjs.com/package/watchmen-ping-http-contains⁠

⁠Creating your own ping service

Ping services are npm modules with the 'watchmen-ping' prefix.

For example, if you want to create a smtp ping service:

⁠a) create a watchmen-ping-smtp module and publish it. This is how a simple HTTP ping service looks like:

var request = require('request');

function PingService(){}

exports = module.exports = PingService;

PingService.prototype.ping = function(service, callback){
  var startTime = +new Date();
  request.get({ method: 'HEAD', uri: service.url }, function(error, response, body){
    callback(error, body, response, +new Date() - startTime);
  });
};

PingService.prototype.getDefaultOptions = function(){
  return {}; // there is not need for UI confi options for this ping service
}

⁠b) npm install it in watchmen:

     npm install watchmen-ping-smtp

⁠c) create a service that uses that ping service

### Monitor plugins

⁠AWS SES Notifications

https://github.com/iloire/watchmen-plugin-aws-ses⁠

⁠Settings

export WATCHMEN_AWS_FROM='your@email'
export WATCHMEN_AWS_REGION='your AWS region'
export WATCHMEN_AWS_KEY='your AWS Key'
export WATCHMEN_AWS_SECRET='your AWS secret'

⁠Console output

https://github.com/iloire/watchmen-plugin-console⁠

⁠Creating your own plugin

A watchmen instance will be injected through your plugin constructor. Then you can subscribe to the desired events. Best is to show it through an example.

This what the console plugin looks like:

var colors = require('colors');
var moment = require('moment');

var eventHandlers = {

  /**
   * On a new outage
   * @param service
   * @param outage
   */

  onNewOutage: function (service, outage) {
    var errorMsg = service.name + ' down!'.red + '. Error: ' + JSON.stringify(outage.error).red;
    console.log(errorMsg);
  },

  /**
   * Failed ping on an existing outage
   * @param service
   * @param outage
   */

  onCurrentOutage: function (service, outage) {
    var errorMsg = service.name + ' is still down!'.red + '. Error: ' + JSON.stringify(outage.error).red;
    console.log(errorMsg);
  },

  /**
   * Warning alert
   * @param service
   * @param data.elapsedTime ms
   */

  onLatencyWarning: function (service, data) {
    var msg = service.name + ' latency warning'.yellow + '. Took: ' + (data.elapsedTime + ' ms.').yellow;
    console.log(msg);
  },

  /**
   * Service is back online
   * @param service
   * @param lastOutage
   */

  onServiceBack: function (service, lastOutage) {
    var duration = moment.duration(+new Date() - lastOutage.timestamp, 'seconds');
    console.log(service.name.white + ' is back'.green + '. Down for '.gray + duration.humanize().white);
  },

  /**
   * Service is responding correctly
   * @param service
   * @param data
   */

  onServiceOk: function (service, data) {
    var serviceOkMsg = service.name + ' responded ' + 'OK!'.green;
    var responseTimeMsg = data.elapsedTime + ' ms.';
    console.log(serviceOkMsg, responseTimeMsg.gray);
  }
};

function ConsolePlugin(watchmen) {
  watchmen.on('new-outage', eventHandlers.onNewOutage);
  watchmen.on('current-outage', eventHandlers.onCurrentOutage);

  watchmen.on('latency-warning', eventHandlers.onLatencyWarning);
  watchmen.on('service-back', eventHandlers.onServiceBack);
  watchmen.on('service-ok', eventHandlers.onServiceOk);
}

exports = module.exports = ConsolePlugin;

⁠Storage providers

⁠Redis

⁠Data schema

service - set with service id's
service:latestOutages - latest outages for all services
service:<serviceId> - hashMap with service details
service:<serviceId>:outages:current - current outage for a service (if any)
service:<serviceId>:outages - sorted set with outages info
service:<serviceId>:latency - sorted set with latency info

⁠Configuration

export WATCHMEN_REDIS_PORT_PRODUCTION=1216
export WATCHMEN_REDIS_DB_PRODUCTION=1

export WATCHMEN_REDIS_PORT_DEVELOPMENT=1216
export WATCHMEN_REDIS_DB_DEVELOPMENT=2

⁠Using fake data for development

cd scripts
sh populate-dummy-data-120days.sh # will populate data for a 120 day period

or

sh populate-dummy-data-30days.sh

etc..

⁠Running with docker

To run with docker, make sure you have docker-compose installed: https://docs.docker.com/compose/install/⁠

Also, have a docker host running. A good way is using docker-machine with a local VM: https://docs.docker.com/machine/get-started/⁠

To build and run Watchmen, run the following:

docker-compose build
docker-compose up

After this Watchmen webserver will be running and exposed in the port 3000 of the docker host.

To configure, please look docker-compose.yml and docker-compose.env.

⁠Tests

$ npm test

⁠Test coverage

$ npm run coverage

Then check the coverage reports:

$ open coverage/lcov-report/lib/index.html

⁠Debugging

watchmen uses debug⁠

set DEBUG=*

⁠TODO

• Define a data expiration period (per service)
• Handle auth in ping services.

⁠Contributions

You can contribute by:

• Addressing one if the items on the TODO list or one of the open issues.
• Creating monitor plugins.
• Creating ping services.
• Reporting bugs.

⁠History

3.0.0

• Watchmen monitor has been refactored. There is not backwards compatibility with previous watchmen databases.
• Pluggable ping services as separate npm modules (http-head and http contains included).
• Plugins for watchmen monitor as separate npm modules (console and AWS SES Notifications included).
• Services are persisted in the database.
• UI panel to add/edit/delete/reset services.
• Store latency points. Latency charts.
• Restricted services to users (by email). Login with Google Auth to access those.

2.5.0

• Rewrite notification system (support for postmark and AWS-SES - it is easy to add new ones).
• Add 'alwaysAlertTo' to notifications.
• Refactor configuration files. IMPORTANT: Please update your configuration files if you are upgrading (host/service config is still the same)!
• Use postmark module instead of custom code for talking to postmark service.
• Add istanbul for test coverage.
• Fix: Cancel timeout to avoid hammering the server when the controller gets called multiple times.
• Add colors to server console output.

2.4.0

• Frontend revamp using angularjs.
• Client side pagination using ngTable.
• Client dependencies now managed by bower.
• Extract analytics ID to config.

2.3.0

• Use passport-google-oauth2 as Google authentication strategy.

2.2.0

• Added service/host authorization with passportjs and GoogleStrategy.

2.1.0

• Fix issue #7. Make load_services async so eventually services can be fetched form a database or remote server.

2.0.0

• Upgrade to Express 4 (requires Node 0.10 or later), hence bumping to 2.x.
• Bump ejs
• Remove dynamic helpers

1.1.1

• Persist table sorting options in localStorage.
• Improve styling and responsiveness.
• General code cleanup.
• Display date of oldest event stored in the database in details view.
• Bump redis, moment and ejs.
• Some other minor changes.

1.1.0

• Delete events older than a certain threshold (configurable in a per-host basis)
• Bump jQuery to 1.11.1
• Bump Handlebars to 2.0.0
• Bump bootstrap to 3.2.0
• Responsive design based on bootstrap

1.0.alpha1 Major changes and improvements

• Storages are now pluggable. redis storage is used by default but you can create your own : couchdb, mongodb, text file, etc (see lib/storage).
• Ping services are also pluggable now. So far you can use http and smtp (smtp is just checking tcp connection right now). You can create your own or improve the existent ones easily.
• Watchmen daemon now inherits from events.EventEmitter, so you can instanciate it and subscribe to the events of your choice (service_error, service_back, etc) to implement your custom logic (see server.js).
• Knockout.js⁠ has been removed. Watchmen uses handlebars now instead. Faster, simpler code, and avoids some client side memory leacks.
• Client side is using moment.js⁠ for rendering dates.
• Express.js⁠ routes now are handled on /routes
• Mocha⁠ is used for unit testing. Mocked storages and ping services are used.
• Configuration is now spread in separate files, under the /config directory
• Better reporting web interface. Uptime statistics. Outages count, warnings count.

0.9

• Major refactor, improved performance.
• Added tests and mocked objects for testing.
• Separate files for request, utils and watchmen library.

0.8

• Removed logging to file.
• Bug fixing when storing event. Needed to add port to redis key to make it unique.
• Added callback when sending email to registered problems in delivery.

0.7

• Targets node 0.6.x
• Added knockoutjs⁠ for view model binding.
• Auto async refresh main page.
• Filter by name in main page.
• Added counter (hosts up and down).
• UI Improvements.
• Tablesorter sorts status and time tags.
• Added Google Analytics.

0.6

• Added current status info (site is up or down) to database.
• Added icons to display status (disable, error or ok).
• TableSorter jQuery plugin orders by status by default.

0.5

• Added expiration time to event records.
• Stores avg response time for each url.
• Warns if response time > limit.
• Multiple recipients in notifications.
• Removed "retry_in" option. Watchmen works in a smarter way now.
• REDIS backend.
• Web UI to display reports (express.js app using REDIS backend).

0.4

• Be able to disable entries in config file at url level
• When site is back, displays and logs information about how long the site has been down.

0.3

• Logs "site down" and "site back up" messages to a file (logs in a different file per host)
• Fix bug when reading url_conf.attempts on site back.

0.2

• Allow POST method (for testing forms).
• Added Marak/colors.js to output success and error messages.
• Displays request duration time.
• Refactoring.

0.1

• First release.

⁠Contributors

• Iván Loire⁠
• Oden⁠
• Tom Atkinson⁠
• Martin Bučko⁠
• Eric Elliott⁠

⁠TODO

• Event pagination in service details
• Twitter integration (pipe events to a twitter account)
• Security (authentication for accesing the web UI and or editing stuff)
• Google charts
• Change configuration from control panel
• Reset stats from control panel
• Regular expressions support
• Reset warning and error counter according to event expiration.

⁠Third party attribution

• Bootstrap - http://getbootstrap.com/⁠
• "Font Awesome by Dave Gandy - http://fortawesome.github.com/Font-Awesome⁠"
• C3 charts - http://c3js.org/⁠
• ngTable - http://ng-table.com/⁠

(see package.json and bower.json for a complete list of libraries and dependencies)

⁠License

Copyright (c) 2012 - 2015 Iván Loire

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.