flapjack 0.4.10

data/bin/flapjack-worker

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+
+$: << File.dirname(__FILE__) + '/../lib' unless $:.include?(File.dirname(__FILE__) + '/../lib/')
+
+require 'rubygems'
+require 'log4r'
+require 'log4r/outputter/syslogoutputter'
+require 'flapjack/cli/worker'
+
+at_exit do 
+  puts "Shutting down"
+end
+
+trap("INT") do 
+  puts "Caught shutdown signal, cleaning up."
+  exit
+end
+
+@options = Flapjack::WorkerOptions.parse(ARGV)
+@worker = Flapjack::Worker.new(:host => @options.host, 
+                               :port => @options.port,
+                               :checks_directory => @options.check_directory)
+
+begin
+  @worker.process_loop
+rescue Beanstalk::NotConnected
+  puts "Couldn't connect to the beanstalk!"
+ 
+  timeout = 5
+  puts "Retrying in #{timeout} seconds"
+  sleep timeout 
+
+  puts "Retrying..."
+  retry
+end
+

data/bin/flapjack-worker-manager

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+
+$: << File.dirname(__FILE__) + '/../lib' unless $:.include?(File.dirname(__FILE__) + '/../lib/')
+
+require 'rubygems'
+require 'daemons'
+require 'fileutils'
+require 'flapjack/cli/worker_manager'
+require 'flapjack/patches' # for Daemons
+
+# reassign ARGV so we don't mess with it directly
+args = ARGV
+args << '--help' if args.size == 0
+options = WorkerManagerOptions.parse(args)
+
+worker_path = File.join(File.dirname(__FILE__), 'flapjack-worker')
+
+# set up pid dir
+pid_dir = "/var/run/flapjack"
+FileUtils.mkdir_p(pid_dir)
+
+# spin up a number of workers (5 is the default).
+options.workers.times do |n|
+  # we fork for each worker, as Daemons.run backgrounds this script.
+  fork do
+    Daemons.run(worker_path, 
+                :ARGV => (args + %w(-- -b localhost)), 
+                :multiple => true, 
+                :dir_mode => :normal,
+                :dir => pid_dir)
+  end
+  # so we don't try and stop the daemon multiple times
+  break if ARGV[0] == "stop"
+end
+

data/bin/install-flapjack-systemwide

@@ -0,0 +1,58 @@
+#!/usr/bin/env ruby
+
+# 28 05 2009
+# Lindsay Holmwood <lindsay@holmwood.id.au>
+# 
+# Copies various scripts to appropriate places so Flapjack can be 
+# started as a daemon. 
+# 
+# I abhor these sort of scripts. It's only a stopgap until Flapjack
+# gets packaged properly.
+# 
+# If you would like to package, please let me know! Patches welcome.
+# 
+
+unless ENV["USERNAME"] == "root"
+	puts 'You need to be root to run this script'
+	exit 1
+end
+
+# prompt/warn the user what is about to happen
+puts "This script sets up Flapjack to run as a daemon. Specifically it: "
+puts
+puts "  * installs init scripts and configs into /etc"
+puts "  * sets up /var/run/flapjack "
+puts "  * sets Flapjack to run on boot"
+puts 
+puts "It will prompt you if it wants to overwrite an existing file."
+puts 
+print "Do you want to continue? [y/n] "
+continue = gets.strip
+puts 
+
+unless continue == "y"
+  puts "Exiting."
+  exit 
+end
+
+# setup
+system("mkdir -p /var/run/flapjack")
+system("chmod a+rw /var/run/flapjack")
+
+etc_path=`gem contents auxesis-flapjack |grep etc`.split.first.gsub(/etc\/.+/, 'etc').strip
+system("cp -aiv #{etc_path}/* /etc")
+
+# set sequence number to 50 so beanstalkd has a chance to boot
+system("update-rc.d flapjack-workers defaults 50")
+system("update-rc.d flapjack-notifier defaults 50")
+
+puts 
+puts "Setup complete!"
+puts 
+puts "You will want to customise:"
+puts "  * /etc/flapjack/recipients.yaml"
+puts "  * /etc/flapjack/flapjack-notifier.yaml"
+puts 
+puts ".examples of these files exist in /etc/flapjack/'
+
+

data/doc/CONFIGURING.md

@@ -0,0 +1,38 @@
+### Configuring ###
+
+You can configure who receives notifications from `flapjack-notifier` 
+in `/etc/flapjack/recipients.yaml`:
+
+    ---
+    - :name: Jane Doe
+      :email: "jane@doe.com"
+      :phone: "+61 444 222 111"
+      :pager: "61444222111"
+      :jid: "jane@doe.com"
+
+Then you can configure how people are notified in `/etc/flapjack/flapjack-notifier.yaml`: 
+
+    --- 
+    :notifiers: 
+      :mailer: 
+        :from_address: notifications@my-domain.com
+      :xmpp: 
+        :jid: notifications@my-domain.com
+        :password: foo
+    :database_uri: "sqlite3:///var/lib/flapjack/flapjack.db"
+
+Currently there are email and XMPP notifiers. 
+
+The `database_uri` setting must point to the database `flapjack-admin` backs 
+onto. This can be SQLite3, MySQL, or PostgreSQL:
+
+    :database_uri: "mysql://user:password@localhost/flapjack_production"
+    # or
+    :database_uri: "postgres://me:spoons@db.mydomain.com/flapjack_production"
+    
+Now you need to restart the notifier: 
+
+    flapjack-notifier-manager restart --recipients /etc/flapjack/recipients.yaml \
+                                      --config /etc/flapjack/flapjack-notifier.yaml
+
+

data/doc/DEVELOPING.md

@@ -0,0 +1,35 @@
+Developing
+----------
+
+You can write your own notifiers and place them in `lib/flapjack/notifiers/`.
+
+Your notifier just needs to implement the `notify` method, and take in a hash:
+
+    class Sms
+      def initialize(opts={})
+        # you may want to set from address here
+        @from = (opts[:from] || "0431 112 233")
+      end
+
+      def notify(opts={})
+        who = opts[:who]
+        result = opts[:result]
+        # sms to your hearts content
+      end
+    end
+
+
+Testing
+-------
+
+Flapjack is, and will continue to be, well tested. Monitoring is like continuous
+integration for production apps, so why shouldn't your monitoring system have tests?
+
+Testing is done with rspec, and tests live in `spec/`.
+
+To run the tests, check out the code and run:
+
+    $ rake spec
+
+
+

data/doc/INSTALL.md

@@ -0,0 +1,64 @@
+Dependencies
+------------
+
+Before installing Flapjack you will need to setup some dependencies.
+
+### Setup dependencies (Ubuntu Hardy) ###
+
+Add the following lines to `/etc/apt/sources.list`
+
+    deb http://ppa.launchpad.net/ubuntu-ruby-backports/ubuntu hardy main
+    deb http://ppa.launchpad.net/auxesis/ppa/ubuntu hardy main
+
+Add GPG keys for the repos: 
+
+    sudo apt-key adv --recv-keys --keyserver keyserver.ubuntu.com 288BA53BCB7DA731
+
+Update your package list:
+
+    sudo apt-get update 
+
+Install Ruby dependencies: 
+
+    sudo apt-get install build-essential libsqlite3-dev
+
+Install rubygems + beanstalkd:
+
+    sudo apt-get install rubygems beanstalkd
+
+Set `ENABLED=1` in `/etc/default/beanstalkd`.
+
+Start beanstalkd: 
+
+    sudo /etc/init.d/beanstalkd start
+
+
+### Setup dependencies (everyone else) ###
+
+Install the following software through your package manager or from source: 
+
+ - beanstalkd (from [http://xph.us/software/beanstalkd/](http://xph.us/software/beanstalkd/))
+ - libevent (from [http://monkey.org/~provos/libevent/](http://monkey.org/~provos/libevent/))
+ - latest RubyGems (from [http://rubyforge.org/projects/rubygems/](http://rubyforge.org/projects/rubygems/))
+
+
+## Installation ##
+
+Add GitHub's RubyGems server to your Gem sources: 
+
+    sudo gem sources -a http://gems.github.com
+
+Install the Flapjack gem: 
+
+    sudo gem install auxesis-flapjack
+
+Then run the magic configuration script to set up init scripts: 
+
+    sudo install-flapjack-systemwide
+
+The script will prompt you if it wants to do anything destructive. 
+
+## Packages ##
+
+We want to provide native packages for Flapjack (`.deb`, `.rpm`, `.ebuild`). If 
+you'd like to contribute please let us know! 

data/etc/default/flapjack-notifier

@@ -0,0 +1,15 @@
+# Defaults for flapjack-notifier initscript
+# sourced by /etc/init.d/flapjack-notifier
+
+# set enabled to 1 if you want the init script to start flapjack-notifier
+ENABLED=1
+
+# recipients file
+RECIPIENTS=/etc/flapjack/recipients.yaml
+
+# address beanstalkd is bound to
+BEANSTALKD_ADDR=localhost
+
+# port beanstalk is listening on
+BEANSTALKD_PORT=11300
+

data/etc/default/flapjack-workers

@@ -0,0 +1,17 @@
+# Defaults for flapjack-workers initscript
+# sourced by /etc/init.d/flapjack-workers
+
+# set enabled to 1 if you want the init script to start flapjack-workers
+ENABLED=1
+
+# address beanstalkd is bound to
+BEANSTALKD_ADDR=localhost
+
+# port beanstalk is listening on
+BEANSTALKD_PORT=11300
+
+# number of workers to spin up
+WORKERS=5
+
+# location of the checks
+CHECKS_DIRECTORY=/usr/lib/flapjack/checks

data/etc/flapjack/flapjack-notifier.yaml.example

@@ -0,0 +1,8 @@
+--- 
+:notifiers: 
+  :mailer: 
+    :from_address: notifications@my-domain.com
+  :xmpp: 
+    :jid: notifications@my-domain.com
+    :password: foo
+:database_uri: "sqlite3:///var/lib/flapjack/flapjack.db"

data/etc/flapjack/recipients.yaml.example

@@ -0,0 +1,10 @@
+- :name: Jane Doe
+  :email: "jane@doe.com"
+  :phone: "+1 444 333 888"
+  :pager: "1444333888"
+  :jid: "jane@doe.com"
+- :name: John Doe
+  :email: "john@doe.com"
+  :phone: "+1 483 401 501"
+  :pager: "1888777333"
+  :jid: "john@doe.com"

data/etc/init.d/flapjack-notifier

@@ -0,0 +1,47 @@
+#!/bin/bash
+#
+# Copyright (c) 2009 Lindsay Holmwood <lindsay@holmwood.id.au>
+#
+# flapjack-notifier
+# Boots flapjack-notifier, check executors for Flapjack. 
+#
+
+PATH=/sbin:/bin:/usr/sbin:/usr/bin:/usr/local:/usr/local/sbin:/usr/local/bin
+
+if [ -f /etc/default/flapjack-notifier ]; then
+	. /etc/default/flapjack-notifier
+fi
+
+# Default return value
+RETVAL=0
+
+if [ ! $(which flapjack-notifier-manager) ]; then
+	echo "Error: flapjack-notifier-manager isn't on your path."
+	echo "Refusing to start!"
+	exit 1
+fi
+
+# Evaluate command
+case "$1" in
+    start)
+      flapjack-notifier-manager start --recipients $RECIPIENTS \
+          --port $BEANSTALKD_PORT --beanstalk $BEANSTALKD_ADDR
+      RETVAL=$?
+  ;;
+    stop)
+      flapjack-notifier-manager stop --recipients $RECIPIENTS \
+         --port $BEANSTALKD_PORT --beanstalk $BEANSTALKD_ADDR
+      RETVAL=$?
+  ;;
+    restart)
+      flapjack-notifier-manager restart --recipients $RECIPIENTS \
+            --port $BEANSTALKD_PORT --beanstalk $BEANSTALKD_ADDR
+      RETVAL=$?
+  ;;
+    *)
+      echo "Usage: flapjack-notifier {start|stop|restart}"
+      exit 1
+  ;;
+esac
+
+exit $RETVAL

data/etc/init.d/flapjack-workers

@@ -0,0 +1,44 @@
+#!/bin/bash
+#
+# Copyright (c) 2009 Lindsay Holmwood <lindsay@holmwood.id.au>
+#
+# flapjack-workers
+# Boots flapjack-workers, check executors for Flapjack. 
+#
+
+PATH=/sbin:/bin:/usr/sbin:/usr/bin:/usr/local:/usr/local/sbin:/usr/local/bin
+
+if [ -f /etc/default/flapjack-workers ]; then
+  . /etc/default/flapjack-workers
+fi
+
+# Default return value
+RETVAL=0
+
+if [ ! $(which flapjack-worker-manager) ]; then
+	echo "flapjack-worker-manager isn't on your path."
+	echo "Refusing to start."
+	exit 1
+fi
+
+# Evaluate command
+case "$1" in
+    start)
+      flapjack-worker-manager start --workers $WORKERS --checks-directory $CHECKS_DIRECTORY
+      RETVAL=$?
+  ;;
+    stop)
+      flapjack-worker-manager stop
+      RETVAL=$?
+  ;;
+    restart)
+      flapjack-worker-manager restart --workers $WORKERS
+      RETVAL=$?
+  ;;
+    *)
+      echo "Usage: flapjack-workers {start|stop|restart}"
+      exit 1
+  ;;
+esac
+
+exit $RETVAL

data/flapjack.gemspec

@@ -0,0 +1,31 @@
+Gem::Specification.new do |s|
+  s.name = 'flapjack'
+  s.version = '0.4.10'
+  s.date = '2009-07-16'
+  
+  s.summary = "a scalable and distributed monitoring system"
+  s.description = "Flapjack is highly scalable and distributed monitoring system. It understands the Nagios plugin format, and can easily be scaled from 1 server to 1000."
+  
+  s.authors = ['Lindsay Holmwood']
+  s.email = 'lindsay@holmwood.id.au'
+  s.homepage = 'http://flapjack-project.com'
+  s.has_rdoc = false
+
+  s.add_dependency('daemons', '>= 1.0.10')
+  s.add_dependency('beanstalk-client', '>= 1.0.2')
+  s.add_dependency('log4r', '>= 1.0.5')
+  s.add_dependency('xmpp4r-simple', '>= 0.8.8')
+  s.add_dependency('mailfactory', '>= 1.4.0')
+  s.add_dependency('dm-core', '>= 0.9.11')
+  s.add_dependency('dm-timestamps', '>= 0.9.11')
+  s.add_dependency('dm-types', '>= 0.9.11')
+  s.add_dependency('dm-validations', '>= 0.9.11')
+  s.add_dependency('data_objects', '>= 0.9.12')
+  s.add_dependency('do_sqlite3', '>= 0.9.12')
+ 
+  s.bindir = "bin"
+  s.executables = ["flapjack-notifier", "flapjack-notifier-manager", "flapjack-stats", "flapjack-worker", "flapjack-worker-manager", "install-flapjack-systemwide"]
+  s.files = ["LICENCE", "README.md", "Rakefile", "TODO.md", "bin/flapjack-notifier", "bin/flapjack-notifier-manager", "bin/flapjack-stats", "bin/flapjack-worker", "bin/flapjack-worker-manager", "bin/install-flapjack-systemwide", "doc/CONFIGURING.md", "doc/DEVELOPING.md", "doc/INSTALL.md", "etc/default/flapjack-notifier", "etc/default/flapjack-workers", "etc/flapjack/flapjack-notifier.yaml.example", "etc/flapjack/recipients.yaml.example", "etc/init.d/flapjack-notifier", "etc/init.d/flapjack-workers", "flapjack.gemspec", "lib/flapjack/checks/http_content", "lib/flapjack/cli/notifier.rb", "lib/flapjack/cli/notifier_manager.rb", "lib/flapjack/cli/worker.rb", "lib/flapjack/cli/worker_manager.rb", "lib/flapjack/database.rb", "lib/flapjack/models/check.rb", "lib/flapjack/models/check_template.rb", "lib/flapjack/models/node.rb", "lib/flapjack/models/related_check.rb", "lib/flapjack/notifier.rb", "lib/flapjack/notifiers/mailer/init.rb", "lib/flapjack/notifiers/mailer/mailer.rb", "lib/flapjack/notifiers/xmpp/init.rb", "lib/flapjack/notifiers/xmpp/xmpp.rb", "lib/flapjack/patches.rb", "lib/flapjack/result.rb"]
+end
+
+