auxesis-flapjack 0.4.2 → 0.4.5

data/README.md

@@ -22,7 +22,11 @@ Add GPG keys for the repos:
 
 Update your package list:
 
-    sudo aptitude update 
+    sudo apt-get update 
+
+Install Ruby dependencies: 
+
+    sudo apt-get install build-essential libsqlite3-dev
 
 Install rubygems + beanstalkd:
 
@@ -70,12 +74,24 @@ 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"
 
+You also need to set up `/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"
+
 Start up a cluster of workers: 
 
     flapjack-worker-manager start
@@ -89,7 +105,7 @@ 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
+    flapjack-notifier-manager start --recipients /etc/flapjack/recipients.yaml
 
 Currently there are email and XMPP notifiers. 
 

data/TODO.md

@@ -7,6 +7,9 @@
    * update status of checks - DONE
    * relationships + cascading notifications - DONE
    * simple graphs
+ * documentation!
+   * user
+   * developer
  * package with pallet
  * generate .deb/.rpms
    * build packages for gem dependencies

data/bin/flapjack-worker

@@ -17,7 +17,9 @@ trap("INT") do
 end
 
 @options = Flapjack::WorkerOptions.parse(ARGV)
-@worker = Flapjack::Worker.new(:host => @options.host, :port => @options.port)
+@worker = Flapjack::Worker.new(:host => @options.host, 
+                               :port => @options.port,
+                               :checks_directory => @options.check_directory)
 
 begin
   @worker.process_loop

data/bin/install-flapjack-systemwide

@@ -39,7 +39,7 @@ end
 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
+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
@@ -49,6 +49,10 @@ system("update-rc.d flapjack-notifier defaults 50")
 puts 
 puts "Setup complete!"
 puts 
-puts "You may want to customise /etc/flapjack/recipients.yaml"
+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/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/flapjack.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'flapjack'
-  s.version = '0.4.2'
+  s.version = '0.4.5'
   s.date = '2009-06-30'
   
   s.summary = "a scalable and distributed monitoring system"
@@ -25,7 +25,7 @@ Gem::Specification.new do |s|
  
   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", "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/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"]
+  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
 
 

data/lib/flapjack/checks/http_content

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require 'open-uri'
+
+page = ARGV[0]
+string = ARGV[1]
+
+exit 2 unless page && string
+
+body = open(page).read
+if body =~  /#{string}/
+  exit 0
+else
+  exit 2
+end

data/lib/flapjack/cli/notifier.rb

@@ -192,6 +192,7 @@ module Flapjack
       end
     end
 
+    # FIXME: we're doing a lookup twice - optimise out
     def save_result(result)
       if check = Check.get(result.id)
         check.status = result.retval
@@ -201,6 +202,7 @@ module Flapjack
       end
     end
 
+    # FIXME: we're doing a lookup twice - optimise out
     def any_parents_warning_or_critical?(result)
       if check = Check.get(result.id)
         check.worst_parent_status > 0 ? true : false 

data/lib/flapjack/cli/worker.rb

@@ -21,6 +21,9 @@ module Flapjack
         opts.on('-p', '--port PORT', 'beanstalkd port') do |port|
           options.port = port.to_i
         end
+        opts.on('-c', '--checks-directory DIR', 'sandboxed check directory') do |dir|
+          options.checks_directory = dir.to_s
+        end
         opts.on_tail("-h", "--help", "Show this message") do
           puts opts
           exit
@@ -40,6 +43,7 @@ module Flapjack
       # default the port
       options.host ||= 'localhost'
       options.port ||= 11300
+      options.checks_directory ||= File.join(File.dirname(__FILE__), '..', 'checks')
   
       options
     end
@@ -52,6 +56,7 @@ module Flapjack
     def initialize(opts={})
       @jobs    = Beanstalk::Pool.new(["#{opts[:host]}:#{opts[:port]}"], 'jobs')
       @results = Beanstalk::Pool.new(["#{opts[:host]}:#{opts[:port]}"], 'results')
+      @sandbox = (opts[:check_directory] || File.expand_path(File.join(File.dirname(__FILE__), '..', 'checks')))
 
       if opts[:logger]
         @log = opts[:logger]
@@ -84,7 +89,7 @@ module Flapjack
     end
 
     def perform_check(cmd)
-      command = "sh -c '#{cmd}'"
+      command = "sh -c '#{@sandbox}/#{cmd}'"
       @log.debug("Executing check: \"#{command}\"")
       result = `#{command}`
       retval = $?.exitstatus

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: auxesis-flapjack
 version: !ruby/object:Gem::Version 
-  version: 0.4.2
+  version: 0.4.5
 platform: ruby
 authors: 
 - Lindsay Holmwood
@@ -146,12 +146,17 @@ files:
 - 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/recipients.yaml
+- 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