health_monitor 0.0.1 → 0.1.1

data/README.rdoc

@@ -1,6 +1,10 @@
 = Health Monitor 
 Monitor individual aspects of your rails application's health
 
+
+
+
+
 Most rails applications have many additional moving parts of which the health cannot be assessed with 
 simply pinging the (hopefully page cached) homepage 
 
@@ -20,22 +24,44 @@ to nginx to mongrels must be happily shoving rubies around to get that 200 oh bo
 So ping away, grab a beer and know that hey, you might be too drunk but at least you will know your application 
 is sick before your clients do.
 
-=== Installation
+== Installation
 Install the plugin or gem
   script/plugin install git://github.com/blythedunham/health_monitor
 
-  sudo gem install blythedunham-health_monitor --sources=http://gemcutter
+  sudo gem install health_monitor --source=http://gemcutter.org
 
 Run the generator to create HealthMonitorController
   script/generate health_monitor
 
+
+== Quick Reference
+  # Built in checks to monitor db and schema
+  monitor_health  :schema_check, :database_check
+
+  # Monitor a process
+  monitor_process :monit
+
+  montior_health :mycheck, :description => 'Check blahs' do |controller|
+    ... do something ....
+  end
+
+
+
 === Examples
 
   class HealthMonitorController < ApplicationController
     acts_as_health_monitor
 
-    # montior the database connection
-    monitor_health :database, :description => 'Check database connection'
+    # Built in checks query the database for the schema and make sure
+    # that the database connection
+    monitor_health :schema_check, :database_check, :ey_agent_check
+
+    #monitor specified process
+    monitor_process :monit
+
+    # check database connection by ensuring there is at least one user
+    # calls protected method +user_check+
+    monitor_health :user_check, :description => 'Check database connection'
 
     # Monitor email sending. Fail if it exceeds 4 minutes
     monitor_health :email,
@@ -50,11 +76,26 @@ Run the generator to create HealthMonitorController
     end
 
     protected
-    def database; ActiveRecord::Base.connection; end
+    def user_check; User.first; end
 
   end
 
-=== +monitor_health+ Options
+=== +monitor_process+ Monitor a server process
++process_name+ - name of the process to monitor
+
+==== Options
++sudo+ - (default false) set to true to run pgrep as sudo
++pattern+ - specify a pattern to match (pgrep -f) instead of the process_name
++arguments+ - additional arguments to pgrep "-o root,blah -a"
+
+    monitor_process :monit, :someproc, :sudo => true
+    monitor_process :mongod, :pattern => 'mongodb.*slave'
+
+
+=== +monitor_health+
+Monitor the health of the application
+
+==== Options
 <tt>:description</tt> - description of the task
 <tt>:message</tt> - Defaults to SUCCESS or FAILED!
   Additional information that is either a string or a hash with keys <tt>:success</tt> and <tt>:failure</tt>
@@ -65,6 +106,16 @@ Run the generator to create HealthMonitorController
 <tt>:method</tt> - The name of the method or a Proc to invoke. A block can be given as well.
 Defaults to the method with the feature name
 
+
+=== Built in checks
++schema_check+ and +database_check+ are protected methods.
+
+Check the database connection and report the schema number
+    monitor_health :schema_check
+
+Check for an active database connection
+    monitor_health :database_check
+
 === Monitored Methods
 The proc or method defined should return its status as one of the following:
 * true or false indicating success or failure

data/Rakefile

@@ -16,7 +16,9 @@ begin
     #gem.add_development_dependency('timecop', '0.3.1')
     gem.add_development_dependency('mocha', '>=0.9.8')
     gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
-    
+
+    gem.extra_rdoc_files = ["README.rdoc", "LICENSE"]
+
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.1.1

data/generators/health_monitor/templates/controller.rb

@@ -1,16 +1,20 @@
 class <%= class_name %>Controller < ApplicationController
   acts_as_health_monitor
 
+  # Built in checks
+  monitor_health :schema_check, :database_check, #:ey_agent_check
+
   # Refer to the README at http://github.com/blythedunham/health_monitor
   # for more examples
-
-  #   # montior the database connection
-  #   monitor_health :database, :description => 'Check database connection'
+  #   #Make sure monit and 'myspecial cron task' is running
+  #   monitor_process :monit, :myspecialcrontask
   #
+  #   monitor_health :user_check
   #   # Monitor email sending. Fail if it exceeds 4 minutes
+
   #   monitor_health :email,
-  #   :timeout => 240000 # Fail this test if it exceeds 4 minutes
-  #   :method => lambda{ |controller|  ActionMailer::Base.deliver_my_mail('blah') }
+  #     :timeout => 240000 # Fail this test if it exceeds 4 minutes
+  #     :method => lambda{ |controller|  ActionMailer::Base.deliver_my_mail('blah') }
   #
   #   # Display the results of system df call with the results
   #   monitor_health :check_disk, :description => 'Check Disk status' do |controller|
@@ -20,8 +24,7 @@ class <%= class_name %>Controller < ApplicationController
   #   end
   #
   #   protected
-  #   def database; ActiveRecord::Base.connection; end
-  #
+  #   def user_check; User.first; end
 
   <% for action in actions -%>
   def <%= action %>

data/health_monitor.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{health_monitor}
-  s.version = "0.0.1"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Blythe Dunham"]
-  s.date = %q{2009-12-06}
+  s.date = %q{2009-12-13}
   s.email = %q{blythe@snowgiraffe.com}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -26,8 +26,8 @@ Gem::Specification.new do |s|
      "generators/health_monitor/templates/controller.rb",
      "health_monitor.gemspec",
      "lib/health_monitor.rb",
-     "lib/health_monitoring.rb",
-     "templates/_health_monitor.html.erb",
+     "lib/health_monitor/built_in_checks.rb",
+     "lib/health_monitor/health_monitoring.rb",
      "test/helper.rb",
      "test/test_health_monitor.rb"
   ]

data/lib/health_monitor.rb

@@ -1,2 +1,5 @@
-require File.dirname(__FILE__) + "/health_monitoring"
-ActionController::Base.extend HealthMonitoring::ActsAsHealthMonitor
+
+require File.dirname(__FILE__) + "/health_monitor/built_in_checks"
+require File.dirname(__FILE__) + "/health_monitor/health_monitoring"
+
+ActionController::Base.extend HealthMonitor::HealthMonitoring::ActsAsHealthMonitor

data/lib/health_monitor/built_in_checks.rb

@@ -0,0 +1,77 @@
+module HealthMonitor
+  module BuiltInChecks
+    protected
+
+    # Check the schema version
+    def schema_check
+      version    = ActiveRecord::Base.connection.select_value(
+        'select version from schema_migrations order by version limit 1'
+      )
+
+      {
+        :status       => :success,
+        :message      => "Schema version #{version}",
+        :description  => 'Check database connection and schema'
+      }
+    end
+
+    # Check db connection
+    def database_check
+      {
+        :status => ActiveRecord::Base.connection && ActiveRecord::Base.connection.active?,
+        :description => 'Active Database connection',
+        :message => "DATABASE CHECK #{ActiveRecord::Base.connection.active?}"
+      }
+    end
+
+    # Call ey-agent to return nginx or apache status as well as database status
+    def ey_agent_check
+      results = {
+        :description => 'Run ey-agent to monitor haproxy and monitor'
+      }
+
+      agent_results = JSON.load( `sudo ey-agent` )
+
+      results.update(
+        :message => agent_results.inspect,
+        :status => agent_results && agent_results.any?{|k,v| v == 'down' }
+      )
+    rescue => e
+      return results.update( :status => :failure, :exception => e )
+    end
+
+    # return true if the pid is alive
+    def pid_alive?( pid, options = {} )
+      `#{'sudo' if options[:sudo]} kill -0 #{pid}; echo $?`.chomp.to_i == 0
+    end
+
+    # ideas for this came from the ey-flex gem
+    # +process_name+ - name of the process to monitor
+    # === Options
+    # +sudo+ - (default false) set to true to run pgrep as sudo
+    # +pattern+ - specify a pattern to match (pgrep -f) instead of the process_name
+    # +arguments+ - additional arguments to pgrep "-o root,blah -a"
+    def process_alive?( process_name, options = {})
+      return if process_name == ''
+
+      cmd = []
+      cmd << 'sudo' if options[:sudo]
+      cmd << 'pgrep'
+      cmd << options[:arguments].to_s if options[:arguments]
+      cmd << "-f" if options[:pattern]
+      cmd << (options[:pattern].is_a?( String ) ? options[:pattern] : process_name)
+
+      pids = `#{cmd.join(' ')}`.split("\n")
+      !pids.empty? && pids.all? {|p| pid_alive?( p )}
+    end
+
+    # Return a health monitor hash of status and description for
+    # monitoring the specified process
+    def process_health( process_name, options = {} )
+      {
+        :status => process_alive?( process_name, options ),
+        :description => "Check that process #{process_name} is alive"
+      }
+    end
+  end
+end

data/lib/{health_monitoring.rb → health_monitor/health_monitoring.rb}

@@ -90,10 +90,12 @@
 # To disable and write your own routes, use +route+ option with +acts_as_health_monitor+
 #   acts_as_health_monitor :route => false
 #
+module HealthMonitor
 module HealthMonitoring
   def self.included( base )
     base.class_eval do
       extend HealthMonitoring::ClassMethods
+      include HealthMonitor::BuiltInChecks
       cattr_accessor :monitored_features
       self.monitored_features ||= ActiveSupport::OrderedHash.new
 
@@ -119,7 +121,7 @@ module HealthMonitoring
   #
   module ActsAsHealthMonitor
     def acts_as_health_monitor( options = {} )
-      include HealthMonitoring unless method_defined?( :health_monitor )
+      include HealthMonitor::HealthMonitoring unless method_defined?( :health_monitor )
       
       setup_health_monitor_routes( options.delete( :route ) )
     end
@@ -134,17 +136,8 @@ module HealthMonitoring
         :show
       end
 
-
       ActionController::Routing::Routes.draw do |map|
         map.resource controller_name, :controller => controller_name, :only => base_methods, :member => { :monitor_health => :get }
-        #map.named_route controller_name, controller_name + '.:format', :conditions => {:method => :get}, :controller => controller_name, :action => 'monitor_health'
-        #map.named_route "monitor_health_#{controller_name}", "#{controller_name}/monitor_health.:format", :conditions => {:method => :get}, :controller => controller_name, :action => 'monitor_health'
-        
-        #map.resource controller_name, :controller => controller_name, :only => :none, :member => { :monitor_health => :get } do |r|
-        #  r.named_route '', '.:format', :conditions => {:method => :get}, :controller => controller_name, :action => 'monitor_health'
-        #end
-        #map.named_route route_name, route_path, :controller => controller_name, :action => 'health', :method => :get
-        #map.connect "#{controller_name}", :controller => controller_name, :action => 'health'
       end
     end
   end
@@ -156,6 +149,31 @@ module HealthMonitoring
       options[:method] = block if block_given?
       features.each {|name|  self.monitored_features[ name.to_sym ] = options }
     end
+
+    # Monitor a server process
+    # +process_name+ - name of the process to monitor
+    # === Options
+    # +sudo+ - (default false) set to true to run pgrep as sudo
+    # +pattern+ - specify a pattern to match (pgrep -f) instead of the process_name
+    # +arguments+ - additional arguments to pgrep "-o root,blah -a"
+    # === Examples
+    #   monitor_process :monit, :someproc, :sudo => true
+    #   monitor_process :mongod, :pattern => 'mongodb.*slave'
+    def monitor_process( *processes )
+      options = processes.extract_options!
+      options.symbolize_keys!
+
+      processes.each do |process_name|
+        monitor_name = "check_process_#{process_name.to_s.underscore}".to_sym
+        class_eval <<-END_SRC, __FILE__, __LINE__
+def #{monitor_name}
+  process_health( #{process_name.inspect}, monitored_features[#{monitor_name.inspect}] )
+end
+END_SRC
+
+        monitor_health monitor_name, options
+      end
+    end
   end
 
   # Show a status page showing the health of monitored features
@@ -174,7 +192,6 @@ module HealthMonitoring
   end
 
   protected
-
   def monitor_health_of( feature_name )
     feature_status = { :name => feature_name }
     result = nil
@@ -189,6 +206,11 @@ module HealthMonitoring
     else send( method )
     end
   rescue => e
+    logger.error(
+      "Health Monitor Error for feature '#{feature_name}': " +
+      " ##{e.inspect}\n #{e.backtrace.join("\n")}"
+    ) if defined?( logger ) && logger
+
     return { :status => :failure, :exception => e }
   end
 
@@ -205,7 +227,7 @@ module HealthMonitoring
   def on_unhealthy() end
 
   def health_check_template
-    File.join( File.dirname(__FILE__), "/../generators/health_monitor/templates/_health_monitor.html.erb" )
+    File.join( File.dirname(__FILE__), "/../../generators/health_monitor/templates/_health_monitor.html.erb" )
   end
 
   def health_response_code
@@ -304,3 +326,4 @@ module HealthMonitoring
     set_default_health_status!( feature_status )
   end
 end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: health_monitor
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Blythe Dunham
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-06 00:00:00 -08:00
+date: 2009-12-13 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -72,8 +72,8 @@ files:
 - generators/health_monitor/templates/controller.rb
 - health_monitor.gemspec
 - lib/health_monitor.rb
-- lib/health_monitoring.rb
-- templates/_health_monitor.html.erb
+- lib/health_monitor/built_in_checks.rb
+- lib/health_monitor/health_monitoring.rb
 - test/helper.rb
 - test/test_health_monitor.rb
 has_rdoc: true

data/templates/_health_monitor.html.erb

@@ -1,29 +0,0 @@
-
-<h1>Health O Meter</h1>
-<h2><%= healthy? ?  "OK" : "FAIL" %></h2>
-
-<table border="1" width="90%">
-  <tr>
-    <th></th>
-    <th>Name</th>
-    <th>Result</th>
-    <th>Time (s)</th>
-    <th>Description</th>
-  </tr>
-  <% monitored_features.each do |name, options| %>
-  <tr>
-    <td style="background-color:<%= status_color( name )%>">
-      <%= h status_text( name ) %>
-    </td>
-    <td><%= h name.to_s.titleize %></td>
-    <td><%= monitored_message( name ) %></td>
-    <td><%= monitored_timing( name ) %></td>
-    <td><%= monitored_description( name ) %></td>
-  </tr>
-  <% end %>
-</table>
-
-<br>
-<b>Total: </b><%= total_time %> <br>
-<b>PID: </b><%= $$ %><br>
-<b>host: </b><%= request.host %>