auxesis-flapjack 0.3.8

data/README.md

@@ -0,0 +1,186 @@
+Flapjack
+========
+
+Flapjack is highly scalable and distributed monitoring system. 
+
+It understands the Nagios plugin format, and can easily be scaled 
+from 1 server to 1000. 
+
+
+
+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 aptitude update 
+
+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/)
+ - libevent (from http://monkey.org/~provos/libevent/)
+
+
+Installation
+------------
+
+From the checked out code, build + install the gem: 
+
+    rake build
+    sudo gem install pkg/flapjack-<latest>.gem
+
+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. 
+
+
+Running 
+-------
+
+Make sure beanstalkd is running.
+
+You'll want to set up `/etc/flapjack/recipients.yaml` so notifications can be sent via 
+`flapjack-notifier`: 
+
+    - :name: Jane Doe
+      :email: "jane@doe.com"
+      :phone: "+61 444 222 111"
+      :pager: "61444222111"
+      :jid: "jane@doe.com"
+
+Start up a cluster of workers: 
+
+    flapjack-worker-manager start
+
+This will spin up 5 workers in the background. You can specify how many workers 
+to start: 
+
+    flapjack-worker-manager start --workers=10
+
+Each of the `flapjack-worker`s will output to syslog (check in /var/log/messages).
+
+Start up the notifier: 
+
+    flapjack-notifier --recipients /etc/flapjack/recipients.yaml
+
+Currently there are email and XMPP notifiers. 
+
+You'll want to get a copy of (http://github.com/auxesis/flapjack-admin/)[flapjack-admin]
+to set up some checks, then run its' populator to get them into Flapjack. 
+
+What things do 
+--------------
+
+  * `flapjack-worker` => executes checks, reports results  
+  * `flapjack-worker-manager` => starts/stops a cluster of `flapjack-worker`
+  * `flapjack-notifier` => gets results, notifies people if necessary  
+  * `flapjack-stats` => gets stats from beanstalkd tubes (useful for benchmarks + performance analysis)  
+
+
+init scripts
+------------
+
+You can use the provided init scripts to start Flapjack on boot. 
+
+To start: 
+
+    /etc/init.d/flapjack-workers start
+    /etc/init.d/flapjack-notifier start
+
+To set Flapjack to start on boot (Ubuntu): 
+
+    sudo update-rc.d flapjack-workers defaults
+    sudo update-rc.d flapjack-notifier defaults
+
+Config for the init scripts can be found in `/etc/defaults`.
+
+
+
+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
+      end
+
+      def notify(opts={})
+        who = opts[:who]
+        result = opts[:result]
+        # sms to your hearts content
+      end
+    end
+
+
+Testing
+-------
+
+Tests are in `spec/`.
+
+To run tests:
+
+    $ rake spec
+
+
+Architecture
+------------
+
+           -------------------
+           | web interface / |
+           | dsl / flat file |
+           -------------------
+          /
+          |
+          |
+    -------------                  ------------
+    | populator |---          -----| notifier |
+    -------------  |          |    ------------
+                   |          |
+                  --------------
+                  | beanstalkd |
+                  --------------
+                        |
+       -----------------------------------
+       |                |                |
+    ----------      ----------       ----------
+    | worker |      | worker |       | worker |
+    ----------      ----------       ----------
+
+
+- populator determines checks that need to occur, and puts checks onto `jobs` tube
+  - populator fetches jobs from a database 
+  - populator can be swapped out to get checks from a dsl or flat files
+- workers pop a check off the beanstalk, perform check, put result onto `results` tube, 
+  re-add check to `jobs` tube with a delay. 
+- notifier pops results off `results` tube, notifies as necessary
+
+

data/Rakefile

@@ -0,0 +1,65 @@
+#!/usr/bin/env ruby 
+
+require 'rubygems'
+require 'fileutils'
+require 'spec/rake/spectask'
+
+
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ["--options", "spec/spec.opts"]
+end
+
+
+desc "freeze deps"
+task :deps do 
+
+  deps = {'beanstalk-client' => ">= 1.0.2",
+          'log4r' => ">= 1.0.5",
+          'xmpp4r-simple' => ">= 0.8.8",
+          'mailfactory' => ">= 1.4.0"}
+
+  puts "\ninstalling dependencies. this will take a few minutes."
+
+  deps.each_pair do |dep, version|
+    puts "\ninstalling #{dep} (#{version})"
+    system("gem install #{dep} --version '#{version}' -i gems --no-rdoc --no-ri")
+  end
+
+end
+
+desc "generate list of files for gemspec"
+task "gengemfiles" do 
+  executables = `git ls-files bin/*`.split.map {|bin| bin.gsub(/^bin\//, '')}             
+  files = `git ls-files`.split.delete_if {|file| file =~ /^(spec\/|\.gitignore)/}
+  puts
+  puts "Copy and paste into flapjack.gemspec:"
+  puts
+  puts "    s.executables = #{executables.inspect}"
+  puts "    s.files = #{files.inspect}"
+  puts
+  puts
+end
+
+desc "build gem"
+task :build do 
+  system("gem build flapjack.gemspec")
+  
+  FileUtils.mkdir_p('pkg')
+  puts
+  puts "Flapjack gems:"
+  Dir.glob("flapjack-*.gem").each do |gem|
+    dest = File.join('pkg', gem)
+    FileUtils.mv gem, dest
+    puts "  " + dest
+  end
+end
+
+
+if require 'yard'
+  
+  YARD::Rake::YardocTask.new do |t|
+    t.files   = ['lib/**/*.rb']
+    t.options = ['--output-dir=doc/', '--readme=README.md']
+  end
+  
+end

data/TODO.md

@@ -0,0 +1,10 @@
+ * daemonise notifier
+ * provide config file for notifier
+   * specify which notifier plugins to load
+   * specify configuration for plugins (from address/xmmp login)
+ * write init scripts for notifier/worker-manager
+ * hook notifier into web interface
+   * update status of checks
+   * relationships + cascading notifications
+ * package with pallet
+ * generate .deb/.rpms

data/bin/flapjack-notifier

@@ -0,0 +1,54 @@
+#!/usr/bin/env ruby
+
+$: << File.dirname(__FILE__) + '/../lib' unless $:.include?(File.dirname(__FILE__) + '/../lib/')
+
+require 'rubygems'
+require 'beanstalk-client'
+require 'ostruct'
+require 'optparse'
+require 'log4r'
+require 'log4r/outputter/syslogoutputter'
+require 'flapjack/result'
+require 'flapjack/notifier'
+require 'flapjack/notifiers/mailer'
+require 'flapjack/notifiers/xmpp'
+require 'daemons'
+require 'flapjack/patches'
+
+# command line options are in here
+require 'flapjack/cli/notifier'
+
+# boot up the notifier
+@options = Flapjack::NotifierOptions.parse(ARGV)
+
+ncli = Flapjack::NotifierCLI.new
+ncli.setup_loggers
+ncli.setup_recipients(:filename => @options.recipients)
+
+ncli.log.debug("Loading Mailer notifier")
+mailer = Flapjack::Notifiers::Mailer.new
+ncli.log.debug("Loading XMPP notifier")
+xmpp = Flapjack::Notifiers::Xmpp.new(:jid => "flapjack-test@jabber.org", :password => "test")
+ncli.log.debug("Bringing up notifier subsystem")
+ncli.notifier = Notifier.new(:logger => ncli.log, 
+                             :notifiers => [mailer], #, xmpp], 
+                             :recipients => ncli.recipients)
+
+begin 
+
+  ncli.results_queue = Beanstalk::Pool.new(["#{@options.host}:#{@options.port}"], 'results')
+  ncli.log.info("established connection to beanstalkd on #{@options.host}...")
+
+  # process results
+  ncli.process_loop
+
+rescue Beanstalk::NotConnected
+  ncli.log.error("Couldn't connect to the Beanstalk!")
+
+  timeout = 5 
+  ncli.log.error("Retrying in #{timeout} seconds.")
+  sleep timeout
+
+  ncli.log.error("Retrying...")
+  retry
+end

data/bin/flapjack-notifier-manager

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+
+$: << File.dirname(__FILE__) + '/../lib' unless $:.include?(File.dirname(__FILE__) + '/../lib/')
+
+require 'rubygems'
+require 'daemons'
+require 'fileutils'
+require 'flapjack/cli/notifier_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 = Flapjack::NotifierManagerOptions.parse(args)
+
+worker_path = File.join(File.dirname(__FILE__), 'flapjack-notifier')
+
+# set up pid dir
+pid_dir = "/var/run/flapjack"
+FileUtils.mkdir_p(pid_dir)
+
+daemon_args = (args + ['--', '--beanstalk', options.host, 
+                       '--port', options.port.to_s,
+                       '--recipients', options.recipients])
+
+Daemons.run(worker_path, :ARGV => daemon_args,
+                         :multiple => false, 
+                         :dir_mode => :normal,
+                         :dir => pid_dir)
+

data/bin/flapjack-stats

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'beanstalk-client'
+
+begin 
+  beanstalk = Beanstalk::Pool.new(['localhost:11300'])
+  loop do 
+    time = Time.now
+    beanstalk.list_tubes['localhost:11300'].each do |tube_name|
+      next if tube_name == 'default'
+      stats = beanstalk.stats_tube(tube_name)
+      puts "#{time.to_i} [#{tube_name}] total: #{stats['total-jobs']}, waiting: #{stats['current-waiting']}, ready: #{stats['current-jobs-ready']}"
+    end
+    sleep 1
+  end
+rescue Beanstalk::NotConnected
+  puts "beanstalk isn't up!"
+  exit 2
+end
+  
+

data/bin/flapjack-worker

@@ -0,0 +1,34 @@
+#!/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)
+
+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,33 @@
+#!/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
+end
+

data/bin/install-flapjack-systemwide

@@ -0,0 +1,54 @@
+#!/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 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 may want to customise /etc/flapjack/recipients.yaml"
+
+

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,14 @@
+# 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

data/etc/flapjack/recipients.yaml

@@ -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
+      RETVAL=$?
+  ;;
+    stop)
+      flapjack-worker-manager stop --workers $WORKERS
+      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,25 @@
+Gem::Specification.new do |s|
+  s.name = 'flapjack'
+  s.version = '0.3.8'
+  s.date = '2009-05-26'
+  
+  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.bindir = "bin"
+  s.executables = ["flapjack-notifier", "flapjack-notifier-manager", "flapjack-stats", "flapjack-worker", "flapjack-worker-manager", "install-flapjack-systemwide"]
+  s.files = ["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", "etc/default/flapjack-notifier", "etc/default/flapjack-workers", "etc/flapjack/recipients.yaml", "etc/init.d/flapjack-notifier", "etc/init.d/flapjack-workers", "flapjack.gemspec", "lib/flapjack/cli/notifier.rb", "lib/flapjack/cli/notifier_manager.rb", "lib/flapjack/cli/worker.rb", "lib/flapjack/cli/worker_manager.rb", "lib/flapjack/notifier.rb", "lib/flapjack/notifiers/mailer.rb", "lib/flapjack/notifiers/xmpp.rb", "lib/flapjack/patches.rb", "lib/flapjack/result.rb"]
+end
+
+

data/lib/flapjack/cli/notifier.rb

@@ -0,0 +1,116 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'ostruct'
+require 'optparse'
+require 'log4r'
+require 'log4r/outputter/syslogoutputter'
+
+module Flapjack
+  class NotifierOptions
+    def self.parse(args)
+      options = OpenStruct.new
+      opts = OptionParser.new do |opts|
+        # the available command line options
+        opts.on('-b', '--beanstalk HOST', 'location of the beanstalkd') do |host|
+          options.host = host
+        end
+        opts.on('-p', '--port PORT', 'beanstalkd port') do |port|
+          options.port = port.to_i
+        end
+        opts.on('-r', '--recipients FILE', 'recipients file') do |recipients|
+          options.recipients = recipients.to_s
+        end
+        opts.on_tail("-h", "--help", "Show this message") do
+          puts opts
+          exit
+        end
+      end
+
+      # parse the options
+      begin
+        opts.parse!(args)
+      rescue OptionParser::MissingArgument => e
+        # if an --option is missing it's argument
+        puts e.message.capitalize + "\n\n"
+        puts opts
+        exit 1
+      end
+ 
+      # default the host + port
+      options.host ||= 'localhost'
+      options.port ||= 11300
+  
+      @errors = []
+      # check that recipients file exists
+      unless File.exists?(options.recipients.to_s)
+        @errors << "The specified recipients file doesn't exist!"
+      end
+ 
+      # if there are errors, print them out and exit
+      if @errors.size > 0
+        puts "Errors:"
+        @errors.each do |error|
+          puts "  - #{error}"
+        end
+        puts
+        puts opts
+        exit 2
+      end
+  
+      options
+    end
+  end
+  
+  class NotifierCLI
+    attr_accessor :log, :recipients, :notifier, :results_queue
+    attr_accessor :condition
+  
+    def initialize
+      @log = Log4r::Logger.new("notifier")
+    end
+  
+    def setup_loggers
+      @log.add(Log4r::StdoutOutputter.new('notifier'))
+      @log.add(Log4r::SyslogOutputter.new('notifier'))
+    end
+  
+    def setup_recipients(opts={})
+  
+      if opts[:yaml]
+        yaml = opts[:yaml]
+      else
+        opts[:filename] ||= File.join(Dir.pwd, "recipients.yaml")
+        yaml = YAML::load(File.read(opts[:filename]))
+      end
+  
+      @recipients = yaml.map do |r|
+        OpenStruct.new(r)
+      end
+    end
+  
+    def process_loop
+      @log.info("Processing results...")
+      loop do
+        process_result
+      end
+    end
+  
+    def process_result
+      @log.debug("Waiting for new result...")
+      result_job = @results_queue.reserve
+      result = Result.new(YAML::load(result_job.body))
+      
+      @log.info("Processing result for check '#{result.id}'")
+      if result.warning? || result.critical?
+        @log.info("Notifying on check '#{result.id}'")
+        @notifier.notify!(result)
+      end
+
+      @log.debug("Deleting result for check '#{result.id}' from queue")
+      result_job.delete
+    end
+  
+  end
+  
+end

data/lib/flapjack/cli/notifier_manager.rb

@@ -0,0 +1,64 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'ostruct'
+require 'optparse' 
+
+module Flapjack
+  class NotifierManagerOptions
+    def self.parse(args)
+      options = OpenStruct.new
+      opts = OptionParser.new do |opts|
+        opts.banner = "Usage: flapjack-notifier-manager <command> [options]"
+        opts.separator " "
+        opts.separator "  where <command> is one of:"
+        opts.separator "     start            start a worker"
+        opts.separator "     stop             stop all workers"
+        opts.separator "     restart          restart workers"
+        opts.separator " "
+        opts.separator "  and [options] are:"
+  
+        opts.on('-b', '--beanstalk HOST', 'location of the beanstalkd') do |host|
+          options.host = host
+        end
+        opts.on('-p', '--port PORT', 'beanstalkd port') do |port|
+          options.port = port.to_s
+        end
+        opts.on('-r', '--recipients FILE', 'recipients file') do |recipients|
+          options.recipients = File.expand_path(recipients.to_s)
+        end
+      end
+  
+      begin
+        opts.parse!(args)
+      rescue => e
+        puts e.message.capitalize + "\n\n"
+        puts opts
+        exit 1
+      end
+  
+      # defaults
+      options.host ||= "localhost"
+      options.port ||= 11300
+
+      unless options.recipients =~ /.+/
+        puts "You must specify a recipients file!\n\n"
+        puts opts
+        exit 2
+      end
+  
+      unless File.exists?(options.recipients)
+        puts "The specified recipients file doesn't exist!"
+        exit 2
+      end
+  
+      unless %w(start stop restart).include?(args[0])
+        puts opts
+        exit 1
+      end
+  
+      options
+    end
+  end
+
+end

data/lib/flapjack/cli/worker.rb

@@ -0,0 +1,128 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'beanstalk-client'
+require 'ostruct'
+require 'optparse'
+require 'log4r'
+require 'log4r/outputter/syslogoutputter'
+require 'flapjack/result'
+require 'flapjack/patches'
+
+module Flapjack
+  class WorkerOptions
+    def self.parse(args)
+      options = OpenStruct.new
+      opts = OptionParser.new do |opts|
+        # the available command line options
+        opts.on('-b', '--beanstalk HOST', 'location of the beanstalkd') do |host|
+          options.host = host
+        end
+        opts.on('-p', '--port PORT', 'beanstalkd port') do |port|
+          options.port = port.to_i
+        end
+        opts.on_tail("-h", "--help", "Show this message") do
+          puts opts
+          exit
+        end
+      end
+
+      # parse the options
+      begin
+        opts.parse!(args)
+      rescue OptionParser::MissingArgument => e
+        # if an --option is missing it's argument
+        puts e.message.capitalize + "\n\n"
+        puts opts
+        exit 1
+      end
+ 
+      # default the port
+      options.host ||= 'localhost'
+      options.port ||= 11300
+  
+      options
+    end
+  end
+ 
+  class Worker
+    
+    attr_accessor :jobs, :results, :log
+
+    def initialize(opts={})
+      @jobs    = Beanstalk::Pool.new(["#{opts[:host]}:#{opts[:port]}"], 'jobs')
+      @results = Beanstalk::Pool.new(["#{opts[:host]}:#{opts[:port]}"], 'results')
+
+      if opts[:logger]
+        @log = opts[:logger]
+      else
+        @log = Log4r::Logger.new('worker')
+        @log.add(Log4r::StdoutOutputter.new('worker'))
+        @log.add(Log4r::SyslogOutputter.new('worker'))
+      end
+    end
+    
+    def process_loop
+      @log.info("Booting main loop...")
+      loop do 
+        process_check
+      end
+    end
+
+    def process_check
+      # get next check off the beanstalk
+      job, check = get_check()
+
+      # do the actual check
+      result, retval = perform_check(check.command)
+
+      # report the results of the check
+      report_check(:result => result, :retval => retval, :check => check)
+     
+      # create another job for the check, delete current job
+      cleanup_job(:job => job, :check => check)
+    end
+
+    def perform_check(cmd)
+      command = "sh -c '#{cmd}'"
+      @log.debug("Executing check: \"#{command}\"")
+      result = `#{command}`
+      retval = $?.exitstatus
+
+      return result, retval
+    end
+
+    def report_check(opts={})
+      raise ArgumentError unless (opts[:result] && opts[:retval] && opts[:check])
+
+      @log.debug "Reporting results for check id #{opts[:check].id}."
+      @results.yput({:id => opts[:check].id, 
+                     :output => opts[:result], 
+                     :retval => opts[:retval].to_i})
+    end
+
+    def cleanup_job(opts={})
+      raise ArgumentError unless (opts[:job] && opts[:check])
+
+      # add job back onto stack
+      @log.debug("Putting check back onto beanstalk.")
+      @jobs.yput(opts[:check].to_h, 65536, opts[:check].frequency)
+        
+      # once we're done, clean up
+      @log.debug("Deleting job.")
+      opts[:job].delete
+    end
+
+    def get_check
+      @log.debug("Waiting for check...")
+      job = @jobs.reserve
+      check = Check.new(YAML::load(job.body))
+      @log.info("Got check with id #{check.id}")
+
+      return job, check
+    end
+
+  end
+
+end
+

data/lib/flapjack/cli/worker_manager.rb

@@ -0,0 +1,44 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'ostruct'
+require 'optparse' 
+
+class WorkerManagerOptions
+  def self.parse(args)
+    options = OpenStruct.new
+    opts = OptionParser.new do |opts|
+      opts.banner = "Usage: flapjack-worker-manager <command> [options]"
+      opts.separator " "
+      opts.separator "  where <command> is one of:"
+      opts.separator "     start            start a worker"
+      opts.separator "     stop             stop all workers"
+      opts.separator "     restart          restart workers"
+      opts.separator " "
+      opts.separator "  and [options] are:"
+
+      opts.on('-w', '--workers N', 'number of workers to spin up') do |workers|
+        options.workers = workers.to_i
+      end
+    end
+
+    begin
+      opts.parse!(args)
+    rescue
+      puts e.message.capitalize + "\n\n"
+      puts opts
+      exit 1
+    end
+
+    options.workers ||= 5
+
+    unless %w(start stop restart).include?(args[0])
+      puts opts
+      exit 1
+    end
+
+    options
+  end
+end
+
+

data/lib/flapjack/notifier.rb

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+
+require 'ostruct'
+
+class Notifier
+ 
+  attr_reader :recipients, :log
+
+  def initialize(opts={})
+    @log = opts[:logger]
+    raise "you have to specify a logger" unless @log
+    @recipients = (opts[:recipients] || [])
+    
+    @notifiers = []
+    if opts[:notifiers]
+	    opts[:notifiers].each do |n|
+	      @notifiers << n
+	      @log.info("using the #{n.class.to_s.split("::").last} notifier")
+	    end
+    else
+      @log.warning("there are no notifiers")
+    end
+  end
+  
+  def notify!(result)
+    @notifiers.each do |n|
+      @recipients.each do |recipient|
+        @log.info("Notifying #{recipient.name} via #{n.class} about check #{result.id}")
+        n.notify(:result => result, :who => recipient)
+      end
+    end
+  end
+end
+

data/lib/flapjack/notifiers/mailer.rb

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'net/smtp'
+require 'mailfactory'
+
+module Flapjack
+  module Notifiers
+
+    class Mailer
+    
+      def notify(opts={})
+        raise unless (opts[:who] && opts[:result])
+    
+        mail = MailFactory.new
+        mail.to = opts[:who].email
+        mail.from = "notifications@flapjack-project.com"
+        mail.subject = "Check: #{opts[:result].id}, Status: #{opts[:result].status}"
+        mail.text = <<-DESC
+          Check #{opts[:result].id} returned the status "#{opts[:result].status}".
+          
+          Here was the output: 
+            #{opts[:result].output}
+    
+          You can respond to this issue at:
+            http://localhost:4000/issue/#{opts[:result].object_id * -1}
+        DESC
+    
+        Net::SMTP.start('localhost') do |smtp|
+          smtp.sendmail(mail.to_s, mail.from, mail.to)
+        end
+      end
+    
+    end
+  end
+end

data/lib/flapjack/notifiers/xmpp.rb

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+
+require 'xmpp4r-simple'
+
+module Flapjack
+  module Notifiers
+    class Xmpp
+    
+      def initialize(opts={})
+    
+        @jid = opts[:jid]
+        @password = opts[:password]
+        unless @jid && @password 
+          raise ArgumentError, "You have to provide a username and password"
+        end
+        @xmpp = Jabber::Simple.new(@jid, @password)
+    
+      end
+    
+      def notify(opts={})
+    
+        raise unless opts[:who] && opts[:result]
+    
+        message = <<-DESC
+          Check #{opts[:result].id} returned the status "#{opts[:result].status}".
+            http://localhost:4000/checks/#{opts[:result].id}
+        DESC
+    
+        @xmpp.deliver(opts[:who].jid, message)
+    
+      end
+    
+    end
+  end
+end
+

data/lib/flapjack/patches.rb

@@ -0,0 +1,17 @@
+require 'ostruct'
+require 'daemons'
+
+class OpenStruct
+  def to_h
+    @table
+  end
+end
+
+module Daemons
+  class PidFile 
+    # we override this method so creating pid files is fork-safe
+    def filename 
+      File.join(@dir, "#{@progname}#{Process.pid}.pid")
+    end
+  end
+end

data/lib/flapjack/result.rb

@@ -0,0 +1,47 @@
+#!/usr/bin/env ruby
+
+require 'ostruct'
+
+##
+# Representation of a check result, as it's popped off the beanstalk.
+# 
+# Provides several convience methods for querying the status of a result. 
+#
+# Convenience methods are used by the Notifier to determine whether a 
+# notification needs to be sent out.
+class Result < OpenStruct
+
+  # Whether a check returns an ok status. 
+  def ok?
+    self.retval == 0
+  end
+
+  # Whether a check has a warning status.
+  def warning?
+    self.retval == 1
+  end
+
+  # Whether a check has a critical status.
+  def critical?
+    self.retval == 2
+  end
+
+  # Human readable representation of the check's return value.
+  def status
+    case self.retval
+    when 0 ; "ok"
+    when 1 ; "warning"
+    when 2 ; "critical"
+    end
+  end
+
+  # The id of a check result.
+  def id
+    # openstruct won't respond, so we have to manually define it
+    @table[:id]
+  end
+
+end
+
+class Check < Result
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification 
+name: auxesis-flapjack
+version: !ruby/object:Gem::Version 
+  version: 0.3.8
+platform: ruby
+authors: 
+- Lindsay Holmwood
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-26 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: daemons
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.10
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: beanstalk-client
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: log4r
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.5
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: xmpp4r-simple
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.8.8
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mailfactory
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.4.0
+    version: 
+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.
+email: lindsay@holmwood.id.au
+executables: 
+- flapjack-notifier
+- flapjack-notifier-manager
+- flapjack-stats
+- flapjack-worker
+- flapjack-worker-manager
+- install-flapjack-systemwide
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- 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
+- etc/default/flapjack-notifier
+- etc/default/flapjack-workers
+- etc/flapjack/recipients.yaml
+- etc/init.d/flapjack-notifier
+- etc/init.d/flapjack-workers
+- flapjack.gemspec
+- lib/flapjack/cli/notifier.rb
+- lib/flapjack/cli/notifier_manager.rb
+- lib/flapjack/cli/worker.rb
+- lib/flapjack/cli/worker_manager.rb
+- lib/flapjack/notifier.rb
+- lib/flapjack/notifiers/mailer.rb
+- lib/flapjack/notifiers/xmpp.rb
+- lib/flapjack/patches.rb
+- lib/flapjack/result.rb
+has_rdoc: false
+homepage: http://flapjack-project.com
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: a scalable and distributed monitoring system
+test_files: []
+