auxesis-flapjack 0.3.8 → 0.4.1

data/README.md

@@ -47,10 +47,13 @@ Install the following software through your package manager or from source:
 Installation
 ------------
 
-From the checked out code, build + install the gem: 
+Add GitHub's RubyGems server to your Gem sources: 
 
-    rake build
-    sudo gem install pkg/flapjack-<latest>.gem
+    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: 
 

data/Rakefile

@@ -63,3 +63,13 @@ if require 'yard'
   end
   
 end
+
+desc "display FIXMEs in the codebase"
+task :fixmes do 
+  output = `grep -nR FIXME lib/* spec/* bin/`
+  output.split("\n").each do |line|
+    parts = line.split(':')
+    puts "#{parts[0].strip} +#{parts[1].strip}"
+    puts "  - #{parts[3].strip}"
+  end
+end

data/TODO.md

@@ -1,10 +1,20 @@
- * daemonise notifier
+ * daemonise notifier - DONE
  * 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
+   * specify which notifier plugins to load - DONE
+   * specify configuration for plugins (from address/xmmp login) - DONE
+ * write init scripts for notifier/worker-manager - DONE
  * hook notifier into web interface
-   * update status of checks
-   * relationships + cascading notifications
+   * update status of checks - DONE
+   * relationships + cascading notifications - DONE
+   * simple graphs
  * package with pallet
  * generate .deb/.rpms
+   * build packages for gem dependencies
+ * provide common interface for loading checks into beanstalk
+ * write check generator
+   * include a collection of common functions 
+     (logging to rrd, retreiving values, executing check)
+ * write zeroconf/avahi notifier
+ * write growl notifier
+ * write way to customise notifier messages (email body, xmpp format)
+ * write sms notifier

data/bin/flapjack-notifier

@@ -10,8 +10,6 @@ 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'
 
@@ -24,15 +22,9 @@ require 'flapjack/cli/notifier'
 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)
+ncli.setup_config(:filename => @options.config_filename)
+ncli.setup_notifier
+ncli.setup_database(:database_uri => @options.database_uri)
 
 begin 
 

data/flapjack.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'flapjack'
-  s.version = '0.3.8'
+  s.version = '0.4.1'
   s.date = '2009-05-26'
   
   s.summary = "a scalable and distributed monitoring system"
@@ -16,10 +16,16 @@ Gem::Specification.new do |s|
   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 = ["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"]
+  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/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/cli/notifier.rb

@@ -5,6 +5,7 @@ require 'ostruct'
 require 'optparse'
 require 'log4r'
 require 'log4r/outputter/syslogoutputter'
+require File.join(File.dirname(__FILE__), '..', 'database')
 
 module Flapjack
   class NotifierOptions
@@ -21,6 +22,12 @@ module Flapjack
         opts.on('-r', '--recipients FILE', 'recipients file') do |recipients|
           options.recipients = recipients.to_s
         end
+        opts.on('-c', '--config FILE', 'config file') do |config|
+          options.config_filename = config.to_s
+        end
+        opts.on('-d', '--database-uri URI', 'location of the checks database') do |db|
+          options.database_uri = db.to_s
+        end
         opts.on_tail("-h", "--help", "Show this message") do
           puts opts
           exit
@@ -43,10 +50,27 @@ module Flapjack
   
       @errors = []
       # check that recipients file exists
-      unless File.exists?(options.recipients.to_s)
-        @errors << "The specified recipients file doesn't exist!"
+      if options.recipients
+        unless File.exists?(options.recipients.to_s)
+          @errors << "The specified recipients file doesn't exist!"
+        end
+      else
+        @errors << "You need to specify a recipients file with [-r|--recipients]."
       end
- 
+
+      # check that config file exists
+      if options.config_filename 
+        unless File.exists?(options.config_filename.to_s)
+          @errors << "The specified config file doesn't exist!"
+        end
+      else
+        options.config_filename ||= "/etc/flapjack/flapjack-notifier.yaml"
+        unless File.exists?(options.config_filename.to_s)
+          @errors << "The default config file (#{options.config_filename}) doesn't exist!"
+          @errors << "Set one up, or specify one with [-c|--config]."
+        end
+      end
+
       # if there are errors, print them out and exit
       if @errors.size > 0
         puts "Errors:"
@@ -63,11 +87,13 @@ module Flapjack
   end
   
   class NotifierCLI
-    attr_accessor :log, :recipients, :notifier, :results_queue
+    attr_accessor :log, :recipients, :results_queue, :config
+    attr_accessor :notifier, :notifiers
     attr_accessor :condition
   
-    def initialize
-      @log = Log4r::Logger.new("notifier")
+    def initialize(opts={})
+      @log = opts[:logger]
+      @log ||= Log4r::Logger.new("notifier")
     end
   
     def setup_loggers
@@ -83,11 +109,81 @@ module Flapjack
         opts[:filename] ||= File.join(Dir.pwd, "recipients.yaml")
         yaml = YAML::load(File.read(opts[:filename]))
       end
-  
+ 
+      # FIXME: add error detection for passing in dumb things
+
       @recipients = yaml.map do |r|
         OpenStruct.new(r)
       end
     end
+
+    def setup_config(opts={})
+      if opts[:yaml]
+        yaml = opts[:yaml]
+      else
+        opts[:filename] ||= File.join(Dir.pwd, "flapjack-notifier.yaml")
+        yaml = YAML::load(File.read(opts[:filename]))
+      end
+
+      @config = OpenStruct.new(yaml)
+    end
+
+    def setup_database(opts={})
+      uri = (opts[:database_uri] || @config.database_uri)
+      raise ArgumentError, "database URI wasn't specified!" unless uri
+      DataMapper.setup(:default, uri)
+      validate_database
+    end
+
+    def validate_database
+      begin
+        DataMapper.repository(:default).adapter.execute("SELECT 'id' FROM 'checks';")
+      rescue Sqlite3Error
+        @log.warning("The specified database doesn't appear to have any structure!")
+        @log.warning("You need to investigate this.")
+      end
+      # FIXME: add more rescues in here!
+    end
+
+    def initialize_notifiers(opts={})
+      notifiers_directory = opts[:notifiers_directory] 
+      notifiers_directory ||= File.expand_path(File.join(File.dirname(__FILE__), '..', 'notifiers'))
+
+      raise ArgumentError, "notifiers directory doesn't exist!" unless File.exists?(notifiers_directory)
+      
+      @notifiers = []
+     
+      @config.notifiers.each_pair do |notifier, config|
+        filename = File.join(notifiers_directory, notifier.to_s, 'init')
+        if File.exists?(filename + '.rb')
+          @log.debug("Loading the #{notifier.to_s.capitalize} notifier")
+          require filename
+          @notifiers << Flapjack::Notifiers.const_get("#{notifier.to_s.capitalize}").new(config)
+        else
+          @log.warning("Flapjack::Notifiers::#{notifier.to_s.capitalize} doesn't exist!") 
+        end
+      end
+
+      @notifiers
+    end
+
+    # Sets up notifier to do the grunt work of notifying people when checks 
+    # return badly. 
+    #
+    # Accepts a list of recipients (:recipients) and a logger (:logger) as 
+    # arguments. If neither of these are specified, it will default to an 
+    # existing list of recipients and the current logger.
+    #
+    # Sets up and returns @notifier, an instance of Flapjack::Notifier
+    def setup_notifier(opts={})
+      recipients = (opts[:recipients] || @recipients)
+      log = (opts[:logger] || @log)
+      initialize_notifiers
+      notifiers = @notifiers # should we accept a list of notifiers?
+      @notifier = Flapjack::Notifier.new(:logger => log,
+                                         :notifiers => notifiers,
+                                         :recipients => recipients)
+    end
   
     def process_loop
       @log.info("Processing results...")
@@ -95,18 +191,42 @@ module Flapjack
         process_result
       end
     end
-  
+
+    def save_result(result)
+      if check = Check.get(result.id)
+        check.status = result.retval
+        check.save
+      else
+        @log.error("Got result for check #{result.id}, but it doesn't exist!")
+      end
+    end
+
+    def any_parents_warning_or_critical?(result)
+      if check = Check.get(result.id)
+        check.worst_parent_status > 0 ? true : false 
+      else
+        @log.error("Got result for check #{result.id}, but it doesn't exist!")
+      end
+    end
+
     def process_result
       @log.debug("Waiting for new result...")
-      result_job = @results_queue.reserve
+      result_job = @results_queue.reserve # blocks until a job is reserved
       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)
+        if any_parents_warning_or_critical?(result)
+          @log.info("Not notifying on check '#{result.id}' as parent is failing.")
+        else
+          @log.info("Notifying on check '#{result.id}'")
+          @notifier.notify!(result)
+        end
       end
 
+      @log.info("Storing status of check in database")
+      save_result(result)
+
       @log.debug("Deleting result for check '#{result.id}' from queue")
       result_job.delete
     end

data/lib/flapjack/cli/worker.rb

@@ -116,7 +116,8 @@ module Flapjack
     def get_check
       @log.debug("Waiting for check...")
       job = @jobs.reserve
-      check = Check.new(YAML::load(job.body))
+      # FIXME: maybe wrap Result as Job now that Check is reserved?
+      check = Result.new(YAML::load(job.body))
       @log.info("Got check with id #{check.id}")
 
       return job, check

data/lib/flapjack/database.rb

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby 
+
+require 'dm-core'
+require 'dm-validations'
+require 'dm-types'
+require 'dm-timestamps'
+
+Dir.glob(File.join(File.dirname(__FILE__), 'models', '*.rb')).each do |model|
+  require model
+end

data/lib/flapjack/models/check.rb

@@ -0,0 +1,91 @@
+class Check
+  include DataMapper::Resource
+
+  timestamps :at
+
+  has n, :related_checks, :child_key => [:child_id, :parent_id]
+
+  #has n, :parent_checks, :through => :related_checks, 
+  #       :child_key => :child_id,  :class_name => "Check"
+  #has n, :child_checks,  :through => :related_checks, 
+  #       :child_key => :parent_id, :class_name => "Check"
+
+  belongs_to :node
+  belongs_to :check_template
+
+  property :id, Serial, :key => true
+  property :command, Text, :nullable => false
+  property :params, Yaml
+  property :name, String, :nullable => false
+  property :enabled, Boolean, :default => false
+  property :status, Integer, :default => 0
+
+  # dm-timestamps
+  property :created_at, DateTime
+  property :updated_at, DateTime
+  property :deleted_at, ParanoidDateTime
+
+  # copy command onto check
+  before :valid? do 
+    if self.check_template && self.command.blank?
+      self.command = self.check_template.command
+      self.name = self.check_template.name
+      self.params = (self.check_template.params || {})
+    end
+  end
+
+  def parameters_and_values
+    names = parameter_names_from_command
+    hash = {}
+    names.each { |name| hash[name] = params ? params[name] : "" }
+    hash["$FQDN"] = self.node_fqdn # pkey of node check belongs to
+    hash
+  end
+
+  def parameter_names_from_command
+    self.command.split.grep(/\$\w/)
+  end
+
+  def executed_command
+    c = self.command
+    parameters_and_values.each_pair do |param, value|
+      value = value.to_s
+      c.gsub!(param, value)
+    end
+    return c
+  end
+
+  # FIXME: this should work through related checks association, but doesn't
+  def parent_checks
+    RelatedCheck.all(:child_id => self.id).map {|rc| rc.parent_check}
+  end
+
+  def child_checks
+    RelatedCheck.all(:parent_id => self.id).map {|rc| rc.child_check}
+  end
+
+  def worst_parent_status
+    if parent_checks.size > 0
+      self.parent_checks.map { |parent| parent.status }.sort.pop
+    else
+      0
+    end
+  end
+
+
+  GOOD = 0
+  BAD  = 1
+  UGLY = 2
+  
+  def pretty_print_status
+    case self.status
+    when GOOD
+      "good"
+    when BAD
+      "bad"
+    when UGLY
+      "ugly"
+    end
+  end
+
+end

data/lib/flapjack/models/check_template.rb

@@ -0,0 +1,18 @@
+class CheckTemplate
+  include DataMapper::Resource
+
+  has n, :checks
+
+  property :id,      Serial
+  property :command, Text, :nullable => false
+  property :name,    String, :nullable => false
+  property :params,  Yaml
+
+  validates_is_unique :command, :name
+
+  def name_for_select
+    cmd = (self.command.size > 30 ? "#{self.command[0..50]}..." : self.command)
+    "#{self.name} (#{cmd})"
+  end
+
+end

data/lib/flapjack/models/node.rb

@@ -0,0 +1,16 @@
+class Node
+  include DataMapper::Resource
+
+  has n, :checks
+
+  property :fqdn, String, :key => true
+
+  validates_is_unique :fqdn
+  validates_format :fqdn, :with => /^[0-9|a-z|A-Z|\-|\.]*$/, 
+                          :message => "not a RFC1035-formatted FQDN (see section 2.3.1)"
+
+  def hostname
+    self.fqdn.split('.').first
+  end
+
+end

data/lib/flapjack/models/related_check.rb

@@ -0,0 +1,13 @@
+class RelatedCheck
+  include DataMapper::Resource
+ 
+  belongs_to :parent_check, :class_name => "Check", :child_key => [:parent_id]
+  belongs_to :child_check, :class_name => "Check", :child_key => [:child_id]
+
+  property :id,        Serial, :key => true
+  #property :parent_check_id, Integer, :nullable => false
+  #property :child_check_id,  Integer, :nullable => false
+
+
+
+end

data/lib/flapjack/notifier.rb

@@ -2,33 +2,34 @@
 
 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
+module Flapjack
+  class Notifier
+   
+    attr_reader :recipients, :log
   
-  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)
+    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
 end
-

data/lib/flapjack/notifiers/mailer/init.rb

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require File.join(File.dirname(__FILE__), 'mailer')

data/lib/flapjack/notifiers/{mailer.rb → mailer/mailer.rb}

@@ -8,13 +8,17 @@ module Flapjack
   module Notifiers
 
     class Mailer
-    
+
+      def initialize(opts={})
+        @from_address = opts[:from_address]
+      end
+
       def notify(opts={})
         raise unless (opts[:who] && opts[:result])
     
         mail = MailFactory.new
         mail.to = opts[:who].email
-        mail.from = "notifications@flapjack-project.com"
+        mail.from = @from_address
         mail.subject = "Check: #{opts[:result].id}, Status: #{opts[:result].status}"
         mail.text = <<-DESC
           Check #{opts[:result].id} returned the status "#{opts[:result].status}".

data/lib/flapjack/notifiers/xmpp/init.rb

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby 
+
+require File.join(File.dirname(__FILE__), 'xmpp')

data/lib/flapjack/result.rb

@@ -43,5 +43,3 @@ class Result < OpenStruct
 
 end
 
-class Check < Result
-end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: auxesis-flapjack
 version: !ruby/object:Gem::Version 
-  version: 0.3.8
+  version: 0.4.1
 platform: ruby
 authors: 
 - Lindsay Holmwood
@@ -62,6 +62,66 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.4.0
     version: 
+- !ruby/object:Gem::Dependency 
+  name: dm-core
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.11
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: dm-timestamps
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.11
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: dm-types
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.11
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: dm-validations
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.11
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: data_objects
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.12
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: do_sqlite3
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.12
+    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: 
@@ -95,9 +155,16 @@ files:
 - 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.rb
-- lib/flapjack/notifiers/xmpp.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
 has_rdoc: false