god 0.1.0

data/History.txt

@@ -0,0 +1,5 @@
+== 1.0.0 / 2007-06-11
+
+* 1 major enhancement
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,37 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/god
+examples/gravatar.god
+examples/local.god
+lib/god.rb
+lib/god/base.rb
+lib/god/behavior.rb
+lib/god/behaviors/clean_pid_file.rb
+lib/god/condition.rb
+lib/god/conditions/always.rb
+lib/god/conditions/cpu_usage.rb
+lib/god/conditions/memory_usage.rb
+lib/god/conditions/process_not_running.rb
+lib/god/conditions/timeline.rb
+lib/god/errors.rb
+lib/god/meddle.rb
+lib/god/reporter.rb
+lib/god/server.rb
+lib/god/system/process.rb
+lib/god/timer.rb
+lib/god/watch.rb
+test/configs/real.rb
+test/helper.rb
+test/suite.rb
+test/test_behavior.rb
+test/test_condition.rb
+test/test_god.rb
+test/test_meddle.rb
+test/test_reporter.rb
+test/test_server.rb
+test/test_system_process.rb
+test/test_timeline.rb
+test/test_timer.rb
+test/test_watch.rb

data/README.txt

@@ -0,0 +1,42 @@
+god
+    by Tom Preston-Werner
+    http://god.rubyforge.org
+
+== DESCRIPTION:
+  
+God is an easy to configure, easy to extend monitoring framework written in Ruby.
+
+Keeping your server processes and tasks running should be a simple part of your deployment process. God aims to be the simplest, most powerful monitoring application available.
+
+== DOCUMENTATION:
+
+See online documentation at http://god.rubyforge.org
+
+== INSTALL:
+
+  $ sudo gem install god
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2007 FIX
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,28 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/god.rb'
+
+Hoe.new('god', God::VERSION) do |p|
+  p.rubyforge_name = 'god'
+  p.author = 'Tom Preston-Werner'
+  p.email = 'tom@rubyisawesome.com'
+  p.url = 'http://god.rubyforge.org/'
+  p.summary = 'Like monit, only awesome'
+  p.description = "God is an easy to configure, easy to extend monitoring framework written in Ruby."
+  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+  p.extra_deps << ['daemons', '>=1.0.7']
+end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -r ./lib/god.rb"
+end
+
+desc "Upload site to Rubyforge"
+task :site do
+  sh "scp -r site/* mojombo@god.rubyforge.org:/var/www/gforge-projects/god"
+end
+
+# vim: syntax=Ruby

data/bin/god

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+
+require 'rubygems'
+require 'daemons'
+require 'optparse'
+require 'god'
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = "Usage: god command [options]"
+
+  opts.on("-cCONFIG", "--config-file CONFIG", "Configuration file") do |x|
+    options[:config] = x
+  end
+end.parse!
+  
+options[:config] = File.expand_path(options[:config]) if options[:config]
+
+# p options
+# p ARGV
+
+Daemons.run_proc('god') do
+  load options[:config]
+end

data/examples/gravatar.god

@@ -0,0 +1,41 @@
+# This is the actual config file used to keep the mongrels of
+# gravatar.com running.
+
+RAILS_ROOT = "/var/www/gravatar2/current"
+
+God.meddle do |god|
+  %w{8200 8201 8202}.each do |port|
+    god.watch do |w|
+      w.name = "gravatar2-mongrel-#{port}"
+      w.interval = 30 # seconds
+      w.start = "mongrel_rails cluster::start --only #{port} -c #{RAILS_ROOT}"
+      w.stop = "mongrel_rails cluster::stop --only #{port} -c #{RAILS_ROOT}"
+      
+      pid_file = File.join(RAILS_ROOT, "log/mongrel.#{port}.pid")
+      
+      w.behavior(:clean_pid_file) do |b|
+        b.pid_file = pid_file
+      end
+
+      w.start_if do |start|
+        start.condition(:process_not_running) do |c|
+          c.pid_file = pid_file
+        end
+      end
+      
+      w.restart_if do |restart|
+        restart.condition(:memory_usage) do |c|
+          c.pid_file = pid_file
+          c.above = (150 * 1024) # 150mb
+          c.times = [3, 5] # 3 out of 5 intervals
+        end
+      
+        restart.condition(:cpu_usage) do |c|
+          c.pid_file = pid_file
+          c.above = 50 # percent
+          c.times = 5
+        end
+      end
+    end
+  end
+end

data/examples/local.god

@@ -0,0 +1,60 @@
+# This example shows how you might keep a local development Rails server up
+# and running on your Mac.
+
+# Run with:
+# god local.god
+
+RAILS_ROOT = "/Users/tom/dev/powerset/querytopia"
+
+God.meddle do |god|
+  god.interval = 5 # seconds
+  
+  god.watch do |w|
+    w.name = "local-3000"
+    w.start = "mongrel_rails start -P ./log/mongrel.pid -c #{RAILS_ROOT} -d"
+    w.stop = "mongrel_rails stop -P ./log/mongrel.pid -c #{RAILS_ROOT}"
+    w.grace = 5
+    
+    pid_file = File.join(RAILS_ROOT, "log/mongrel.pid")
+    
+    # clean pid files before start if necessary
+    w.behavior(:clean_pid_file) do |b|
+      b.pid_file = pid_file
+    end
+  
+    # start if process is not running
+    w.start_if do |start|
+      start.condition(:process_not_running) do |c|
+        c.pid_file = pid_file
+      end
+    end
+    
+    # restart if memory or cpu is too high
+    w.restart_if do |restart|
+      restart.condition(:memory_usage) do |c|
+        c.pid_file = pid_file
+        c.above = (50 * 1024) # 50mb
+        c.times = [3, 5]
+      end
+      
+      restart.condition(:cpu_usage) do |c|
+        c.pid_file = pid_file
+        c.above = 10 # percent
+        c.times = [3, 5]
+      end
+    end
+  end
+  
+  # clear old session files
+  god.watch do |w|    
+    w.name = "local-session-cleanup"
+    w.cwd = File.join(RAILS_ROOT, 'tmp/sessions')
+    w.start = lambda do
+      Dir['ruby_sess.*'].select { |f| File.mtime(f) < Time.now - (7 * 24 * 60 * 60) }.each { |f| File.delete(f) }
+    end
+    
+    w.start_if do |start|
+      start.condition(:always)
+    end
+  end
+end

data/lib/god.rb

@@ -0,0 +1,35 @@
+$:.unshift File.dirname(__FILE__)     # For use/testing when no gem is installed
+
+# internal requires
+require 'god/base'
+require 'god/errors'
+
+require 'god/system/process'
+
+require 'god/behavior'
+require 'god/behaviors/clean_pid_file'
+
+require 'god/condition'
+require 'god/conditions/timeline'
+require 'god/conditions/process_not_running'
+require 'god/conditions/memory_usage'
+require 'god/conditions/cpu_usage'
+require 'god/conditions/always'
+
+require 'god/reporter'
+require 'god/server'
+require 'god/timer'
+
+require 'god/watch'
+require 'god/meddle'
+
+module God
+  VERSION = '0.1.0'
+  
+  def self.meddle(options = {})
+    m = Meddle.new(options)
+    yield m
+    m.monitor
+    m.timer.join
+  end  
+end

data/lib/god/base.rb

@@ -0,0 +1,13 @@
+module God
+  
+  class Base
+    def abort(msg)
+      Kernel.abort(msg)
+    end
+    
+    def self.abort(msg)
+      Kernel.abort(msg)
+    end
+  end
+  
+end

data/lib/god/behavior.rb

@@ -0,0 +1,67 @@
+module God
+  
+  class Behavior < Base
+    # Generate a Behavior of the given kind. The proper class if found by camel casing the
+    # kind (which is given as an underscored symbol).
+    #   +kind+ is the underscored symbol representing the class (e.g. foo_bar for God::Behaviors::FooBar)
+    def self.generate(kind)
+      sym = kind.to_s.capitalize.gsub(/_(.)/){$1.upcase}.intern
+      God::Behaviors.const_get(sym).new
+    rescue NameError
+      raise NoSuchBehaviorError.new("No Behavior found with the class name God::Behaviors::#{sym}")
+    end
+    
+    # Override this method in your Behaviors (optional)
+    #
+    # Called once after the Condition has been sent to the block and attributes have been
+    # set. Do any post-processing on attributes here
+    def prepare
+      
+    end
+    
+    # Override this method in your Behaviors (optional)
+    #
+    # Called once during evaluation of the config file. Return true if valid, false otherwise
+    #
+    # A convenience method 'complain' is available that will print out a message and return false,
+    # making it easy to report multiple validation errors:
+    #
+    #   def valid?
+    #     valid = true
+    #     valid &= complain("You must specify the 'pid_file' attribute for :memory_usage") if self.pid_file.nil?
+    #     valid &= complain("You must specify the 'above' attribute for :memory_usage") if self.above.nil?
+    #     valid
+    #   end
+    def valid?
+      true
+    end
+    
+    #######
+    
+    def before_start
+    end
+    
+    def after_start
+    end
+    
+    def before_restart
+    end
+    
+    def after_restart
+    end
+    
+    def before_stop
+    end
+    
+    def after_stop
+    end
+    
+    protected
+    
+    def complain(text)
+      puts text
+      false
+    end
+  end
+  
+end

data/lib/god/behaviors/clean_pid_file.rb

@@ -0,0 +1,23 @@
+module God
+  module Behaviors
+    
+    class CleanPidFile < Behavior
+      attr_accessor :pid_file
+    
+      def initialize
+        self.pid_file = nil
+      end
+  
+      def valid?
+        valid = true
+        valid &= complain("You must specify the 'pid_file' attribute for :clean_pid_file") if self.pid_file.nil?
+        valid
+      end
+  
+      def before_start
+        File.delete(self.pid_file) rescue nil
+      end
+    end
+  
+  end
+end

data/lib/god/condition.rb

@@ -0,0 +1,48 @@
+module God
+  
+  class Condition < Behavior
+    # Generate a Condition of the given kind. The proper class if found by camel casing the
+    # kind (which is given as an underscored symbol).
+    #   +kind+ is the underscored symbol representing the class (e.g. foo_bar for God::Conditions::FooBar)
+    def self.generate(kind)
+      sym = kind.to_s.capitalize.gsub(/_(.)/){$1.upcase}.intern
+      cond = God::Conditions.const_get(sym).new
+      
+      unless cond.kind_of?(PollCondition) || cond.kind_of?(EventCondition)
+        abort "Condition '#{cond.class.name}' must subclass either God::PollCondition or God::EventCondition" 
+      end
+      
+      cond
+    rescue NameError
+      raise NoSuchConditionError.new("No Condition found with the class name God::Conditions::#{sym}")
+    end
+  end
+  
+  class PollCondition < Condition
+    # all poll conditions can specify a poll interval 
+    attr_accessor :interval
+    
+    # Override this method in your Conditions (optional)
+    def before
+    end
+    
+    # Override this method in your Conditions (mandatory)
+    #
+    # Return true if the test passes (everything is ok)
+    # Return false otherwise
+    def test
+      raise AbstractMethodNotOverriddenError.new("Condition#test must be overridden in subclasses")
+    end
+    
+    # Override this method in your Conditions (optional)
+    def after
+    end
+  end
+  
+  class EventCondition < Condition
+    def register
+      
+    end
+  end
+  
+end

data/lib/god/conditions/always.rb

@@ -0,0 +1,11 @@
+module God
+  module Conditions
+
+    class Always < PollCondition
+      def test
+        false
+      end
+    end
+  
+  end
+end