what 0.0.7 → 0.0.8

data/README.md

@@ -1,7 +1,7 @@
 What? A simple server monitoring tool.
 ======================================
 
-![WHAT !](http://rwfitzge.github.com/what.png)
+<img src="http://rwfitzge.github.com/what.png" title="WHAT !">
 
 What is a modular, easily-extensible server monitoring tool which is still in
 the early stages of development.

data/example/modules/custom_module.rb

@@ -0,0 +1,52 @@
+# This is an example custom module.
+class What::Modules::CustomModule < What::Modules::Base
+  # You can provide defaults for any settings you're expecting the config file
+  # to provide.
+  # (optional)
+  DEFAULTS = {
+    'hello' => 'hello',
+    'world' => 'world'
+  }
+
+  # You can use the initialize method to set up any data structures you'll be
+  # using. If you do write an initialize, make sure to call super to populate
+  # the @config object.
+  # (optional)
+  def initialize
+    super
+    @hellos = 1
+  end
+
+  # The check! method is called every Config['interval'] seconds. It should
+  # collect whatever information is needed and put it into instance vars.
+  # (optional)
+  def check!
+    @hellos = Kernel.rand(4) + 1
+  end
+
+  # The health and details methods are called whenever the server receives
+  # an HTTP request.
+
+  # health should return one of the following symbols:
+  #   :ok         Everything's fine.
+  #   :warning    There's a problem, but it's not critical.
+  #   :alert      I need to get out of bed to fix this.
+  # (mandatory)
+  def health
+    :ok
+  end
+
+  # details can return a hash containing any additional information
+  # that might be interesting to the consumer of the status updates.
+  # (optional)
+  def details
+    greeting = []
+    @hellos.times do
+      greeting << @config['hello']
+    end
+    @hellos.times do
+      greeting << @config['world']
+    end
+    {:greeting => greeting.join(' ') + '!'}
+  end
+end

data/example/what.yml

@@ -3,20 +3,24 @@
 ### Choose between JSON and YAML formatting. (default: json)
 formatter: yaml
 
-### Set the polling interval for all services.
-interval: 10
+### Set the polling interval for all services, in seconds. (default: 10)
+# interval: 10
 
 ### Specify paths containing custom modules to load, relative to this file.
-# module_paths:
-# - modules
+module_paths:
+- modules
 
 ### List all modules to be monitored.
 modules:
 - unicorn
+- custom_module
 #- processes
 
 ### Pass parameters into modules.
 module_config:
+  custom_module:
+    hello: world
+    world: hello
   unicorn:
     # minimum number of workers before warning and alert statuses
     warning: 1

data/lib/what/config.rb

@@ -1,4 +1,13 @@
 class What::Config
+  DEFAULTS = {
+    'interval'      => 10,
+    'formatter'     => 'json',
+    'configs'       => [],
+    'module_paths'  => [],
+    'modules'       => [],
+    'module_config' => {}
+  }
+
   @config = {}
 
   def self.load(fn)
@@ -7,7 +16,7 @@ class What::Config
   end
 
   def self.load_primary(fn)
-    @config = YAML.load_file(fn)
+    @config = DEFAULTS.merge(YAML.load_file(fn))
     @config['base'] ||= File.expand_path(File.dirname(fn))
     @loaded = true
   end
@@ -16,12 +25,17 @@ class What::Config
     return if !fns
 
     fns.each do |fn|
-      path = if fn.match(/^\//)
+      path = if fn.match(%r(^/))
                fn
              else
                File.join(@config['base'], fn)
              end
-      @config.merge!(YAML.load_file(path))
+      begin
+        opts = YAML.load_file(path)
+        @config.merge!(opts)
+      rescue Exception => e
+        puts "Error loading config file #{path}: #{e}"
+      end
     end
   end
 

data/lib/what/formatter.rb

@@ -2,11 +2,11 @@ class What::Formatter
   def self.use(name)
     @formatter = case name
                  when 'json'
-                   What::Formatters::JSON.new
+                   Formatters::JSON.new
                  when 'yaml'
-                   What::Formatters::YAML.new
+                   Formatters::YAML.new
                  else
-                   What::Formatters::JSON.new
+                   raise "Unknown formatter #{name}"
                  end
   end
 

data/lib/what/formatters.rb

@@ -6,9 +6,9 @@ module What::Formatters
 
     globs = [File.join(File.dirname(__FILE__), 'formatters', '*.rb')]
 
-    if What::Config['formatter_paths']
-      What::Config['formatter_paths'].each do |formatter_path|
-        globs << File.join(What::Config['base'], formatter_path, '*.rb')
+    if Config['formatter_paths']
+      Config['formatter_paths'].each do |formatter_path|
+        globs << File.join(Config['base'], formatter_path, '*.rb')
       end
     end
 
@@ -18,6 +18,6 @@ module What::Formatters
       end
     end
 
-    What::Formatter.use(What::Config['formatter'])
+    Formatter.use(Config['formatter'])
   end
 end

data/lib/what/helpers.rb

@@ -1,4 +1,19 @@
 module What::Helpers
+  # Take an array of healths and determine overall health, on
+  # the principle that overall health == the worst sub-health.
+  def self.overall_health(healths)
+    healths.reduce(:ok) do |overall, current|
+      case current
+      when :ok
+        overall
+      when :warning
+        :warning if overall != :alert
+      else
+        :alert
+      end
+    end
+  end
+
   # Stolen from Rails (http://api.rubyonrails.org/classes/ActiveSupport/Inflector.html)
   def self.camelize(lower_case_and_underscored_word, first_letter_in_uppercase = true)
     if first_letter_in_uppercase

data/lib/what/modules/base.rb

@@ -1,10 +1,12 @@
 class What::Modules::Base
+  DEFAULTS = {}
+
   def initialize
-    @config = What::Config['module_config'] && What::Config['module_config'][self.name]
+    @config = DEFAULTS.merge(Config['module_config'][self.name] || {})
   end
 
   def name
-    What::Helpers.underscore(self.class.name.split('::').last)
+    Helpers.underscore(self.class.name.split('::').last)
   end
 
   def check!

data/lib/what/modules/unicorn.rb

@@ -1,4 +1,9 @@
 class What::Modules::Unicorn < What::Modules::Base
+  DEFAULTS = {
+    'warning' => 1,
+    'alert'   => 0
+  }
+
   def initialize
     super
     @unicorns = []

data/lib/what/modules.rb

@@ -4,18 +4,23 @@ module What::Modules
   def self.load_all
     require 'what/modules/base'
 
-    globs = [File.join(File.dirname(__FILE__), 'modules', '*.rb')]
+    default_modules_path = File.join(File.dirname(__FILE__), 'modules')
+    require_dir(included_modules_path)
 
-    if What::Config['module_paths']
-      What::Config['module_paths'].each do |module_path|
-        globs << File.join(What::Config['base'], module_path, '*.rb')
-      end
+    Config['module_paths'].each do |module_path|
+      path = if module_path.match(%r(^/))
+               module_path
+             else
+               File.join(Config['base'], module_path)
+             end
+      require_dir(path)
     end
+  end
 
-    globs.each do |glob|
-      Dir[glob].each do |fn|
+  private
+    def require_dir(path)
+      Dir[File.join(path, '*.rb')].each do |fn|
         require fn
       end
     end
-  end
 end

data/lib/what/monitor.rb

@@ -1,9 +1,9 @@
 class What::Monitor
   # don't worry, these method names are ironic
   def self.go!
-    @modules = What::Config['modules'].map do |m|
-      name = What::Helpers.camelize(m)
-      What::Modules.const_get(name).new
+    @modules = Config['modules'].map do |m|
+      name = Helpers.camelize(m)
+      Modules.const_get(name).new
     end
 
     Thread.abort_on_exception = true
@@ -12,20 +12,14 @@ class What::Monitor
 
   def self.do_it(modules)
     loop do
-      overall = :ok
+      healths = []
       modules.each do |mod|
         mod.check!
-        case mod.health
-          when :ok
-          when :warning
-            overall = :warning if overall != :alert
-          else
-            overall = :alert
-        end
-        What::Status[mod.name] = mod.status
+        healths << mod.health
+        Status[mod.name] = mod.status
       end
-      What::Status[:health] = overall
-      sleep What::Config['interval']
+      Status[:health] = Helpers.overall_health(healths)
+      sleep Config['interval']
     end
   end
 end

data/lib/what/server.rb

@@ -1,15 +1,15 @@
 class What::Server
   def initialize
-    What::Modules.load_all
-    What::Formatters.load_all
-    What::Monitor.go!
+    Modules.load_all
+    Formatters.load_all
+    Monitor.go!
   end
 
   def call(_)
     [
-      What::Status[:health] != :alert ? 200 : 503,
-      {'Content-Type' => What::Formatter.mime},
-      What::Formatter.format(What::Status.all)
+      Status[:health] != :alert ? 200 : 503,
+      {'Content-Type' => Formatter.mime},
+      Formatter.format(Status.all)
     ]
   end
 end

data/lib/what/version.rb

@@ -1,3 +1,3 @@
 module What
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: what
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 15
   prerelease: 
   segments: 
   - 0
   - 0
-  - 7
-  version: 0.0.7
+  - 8
+  version: 0.0.8
 platform: ruby
 authors: 
 - Ryan Lower
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-16 00:00:00 -07:00
+date: 2011-05-17 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -65,6 +65,7 @@ files:
 - README.md
 - Rakefile
 - bin/what
+- example/modules/custom_module.rb
 - example/what.yml
 - lib/what.rb
 - lib/what/config.rb