god 0.2.0 → 0.3.0

data/History.txt

@@ -1,10 +1,34 @@
-== 0.2.0
+== 0.3.0 / 2007-08-17
+
+* Fix netlink header problem on Ubuntu Edgy [Dan Sully]
+* Add uid/gid setting for processes [kevinclark]
+* Add autostart flag for watches so they don't necessarily startup with god [kevinclark]
+* Change command line call options for god binary to accommodate watch start/stop functionality
+* Add individual start/stop/restart grace periods for finer grained control
+* Change default DRb port to 17165 ('god'.to_i(32))
+* Implement command line control to start/restart/stop/monitor/unmonitor watches/groups by name
+* Watches can now belong to a group that can be controlled as a whole
+* Allow god to be installed (sans events) on systems that don't support events
+* Daemonize and handle PID files for non-daemonizing scripts [kevinclark]
+* Fix simple mode lifecycle gap
+* Remove necessity to specify pid_file for conditions
+* Change config file to use God.init and God.watch directly instead of God.meddle block
+* Move god binary command logic to main library
+* Enhance god binary with better reporting
+* Fix synchronization bug in Timer (reported by Srini Panguluri)
+* Add Lambda condition for easy custom conditions [Mike Mintz]
+* Add sugar for numerics (seconds, minutes, kilobytes, megabytes, percent, etc)
+* Add optional PID and log file generation to god binary for daemon mode
+* Add God.load to do glob enabled loading
+* Add -V option to god binary for detailed version/build info
+
+== 0.2.0 / 2007-07-18
 
 * Rewrote innards to use a state and event based lifecycle
 * Basic support for events via kqueue (bsd/darwin) and netlink/pec (linux) [kevinclark]
 * Added advanced syntax (simple syntax calls advanced api underneath)
 * Condition returns have changed meaning. With simple syntax, a true return activates block
-* Updated http://god.rubygorge.org with updated simple config and new advanced config
+* Updated http://god.rubyforge.org with updated simple config and new advanced config
 
 == 0.1.0 / 2007-07-07
 

data/Manifest.txt

@@ -3,46 +3,60 @@ Manifest.txt
 README.txt
 Rakefile
 bin/god
+examples/events.god
 examples/gravatar.god
-examples/local.god
-ext/god/Makefile
 ext/god/extconf.rb
 ext/god/kqueue_handler.c
 ext/god/netlink_handler.c
 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/lambda.rb
 lib/god/conditions/memory_usage.rb
 lib/god/conditions/process_exits.rb
 lib/god/conditions/process_running.rb
 lib/god/conditions/timeline.rb
 lib/god/errors.rb
 lib/god/event_handler.rb
+lib/god/event_handlers/dummy_handler.rb
 lib/god/event_handlers/kqueue_handler.rb
 lib/god/event_handlers/netlink_handler.rb
 lib/god/hub.rb
-lib/god/meddle.rb
 lib/god/metric.rb
+lib/god/process.rb
+lib/god/registry.rb
 lib/god/reporter.rb
 lib/god/server.rb
+lib/god/sugar.rb
 lib/god/system/process.rb
 lib/god/timer.rb
 lib/god/watch.rb
+test/configs/child_events/child_events.god
+test/configs/child_events/simple_server.rb
+test/configs/child_polls/child_polls.god
+test/configs/child_polls/simple_server.rb
+test/configs/daemon_events/daemon_events.god
+test/configs/daemon_events/simple_server.rb
 test/configs/real.rb
 test/configs/test.rb
 test/helper.rb
 test/suite.rb
 test/test_behavior.rb
 test/test_condition.rb
+test/test_conditions_process_running.rb
+test/test_event_handler.rb
 test/test_god.rb
-test/test_meddle.rb
+test/test_handlers_kqueue_handler.rb
+test/test_hub.rb
 test/test_metric.rb
+test/test_process.rb
+test/test_registry.rb
 test/test_reporter.rb
 test/test_server.rb
+test/test_sugar.rb
 test/test_system_process.rb
 test/test_timeline.rb
 test/test_timer.rb

data/Rakefile

@@ -3,7 +3,7 @@
 require 'rubygems'
 require 'hoe'
 
-Hoe.new('god', '0.2.0') do |p|
+Hoe.new('god', '0.3.0') do |p|
   p.rubyforge_name = 'god'
   p.author = 'Tom Preston-Werner'
   p.email = 'tom@rubyisawesome.com'
@@ -11,7 +11,7 @@ Hoe.new('god', '0.2.0') do |p|
   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']
+  # p.extra_deps << ['daemons', '>=1.0.7']
   p.spec_extras = {:extensions => ['ext/god/extconf.rb']}
 end
 
@@ -25,4 +25,9 @@ task :site do
   sh "scp -r site/* mojombo@god.rubyforge.org:/var/www/gforge-projects/god"
 end
 
+desc "Upload site to Rubyforge"
+task :site_edge do
+  sh "scp -r site/* mojombo@god.rubyforge.org:/var/www/gforge-projects/god/edge"
+end
+
 # vim: syntax=Ruby

data/bin/god

@@ -3,24 +3,144 @@
 $:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
 
 require 'rubygems'
-require 'daemons'
 require 'optparse'
-require 'god'
+require 'drb'
+
+options = {:daemonize => true, :port => 17165}
 
-options = {}
 OptionParser.new do |opts|
-  opts.banner = "Usage: god command [options]"
+  opts.banner = <<-EOF
+Usage: god [command] [options]
+
+  Commands:
+    start <watch or group name>
+    stop <watch or group name>
+    monitor <watch or group name>
+    unmonitor <watch or group name>
+
+  Options:
+EOF
 
   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
+  opts.on("-pPORT", "--port PORT", "Communications port") do |x|
+    options[:port] = x
+  end
+  
+  opts.on("-PFILE", "--pid FILE", "Where to write the PID file") do |x|
+    options[:pid] = x
+  end
+  
+  opts.on("-lFILE", "--log FILE", "Where to write the log file") do |x|
+    options[:log] = x
+  end
+  
+  opts.on("-D", "--no-daemonize", "Don't daemonize") do
+    options[:daemonize] = false
+  end
+  
+  opts.on("-v", "--version", "Print the version number and exit") do
+    options[:version] = true
+  end
+  
+  opts.on("-V", "Print extended version and build information") do
+    options[:info] = true
+  end
+end.parse!
 
-Daemons.run_proc('god') do
-  load options[:config]
+if options[:version]
+  require 'god'
+  
+  # print version
+  puts "Version #{God::VERSION}"
+  exit!
+elsif options[:info]
+  require 'god'
+  
+  puts "Version: #{God::VERSION}"
+  puts "Polls: enabled"
+  puts "Events: " + God::EventHandler.event_system
+  
+  exit!
+elsif command = ARGV[0]
+  require 'god'
+  
+  # a command was specified
+  
+  # disable at_exit
+  # module God; def self.at_exit; end; end
+  
+  # get the name of the watch/group
+  name = ARGV[1]
+  
+  # connect to remote drb
+  DRb.start_service
+  server = DRbObject.new nil, "druby://localhost:#{options[:port]}"
+  
+  begin
+    puts "Sending '#{command}' command"
+    
+    # send command
+    watches = server.control(name, command)
+    
+    # output response
+    puts 'The following watches were affected:'
+    watches.each do |w|
+      puts '  ' + w.name
+    end
+  rescue God::InvalidCommandError
+    abort "Command '#{command}' is not valid. Run 'god --help' for usage"
+  end
+  
+  exit!
+else
+  # start god
+  if !options[:daemonize]
+    require 'god'
+    load File.expand_path(options[:config])
+  else
+    pid = fork do
+      begin
+        require 'god'
+        
+        log_file = options[:log] || "/dev/null"
+        
+        STDIN.reopen "/dev/null"
+        STDOUT.reopen(log_file, "a")
+        STDERR.reopen STDOUT
+        
+        puts "Starting god"
+      
+        unless God::EventHandler.loaded?
+          puts
+          puts "***********************************************************************"
+          puts "*"
+          puts "* Event conditions are not available for your installation of god."
+          puts "* You may still use and write custom conditions using the poll system"
+          puts "*"
+          puts "***********************************************************************"
+          puts
+        end
+    
+        puts "Resetting file descriptors"
+        
+        puts "Loading config"
+      
+        load File.expand_path(options[:config])
+      rescue => e
+        File.open('god.log', 'a') { |f| f.puts e.message + "\n" + e.backtrace }
+        abort "!!! ERROR !!!"
+      end
+    end
+  
+    if options[:pid]
+      File.open(options[:pid], 'w') { |f| f.write pid }
+    end
+  
+    ::Process.detach pid
+  
+    exit!
+  end
 end

data/examples/events.god

@@ -0,0 +1,52 @@
+# This example shows how you might keep a local development Rails server up
+# and running on your Mac.
+
+# Run with:
+# god -c /path/to/events.god
+
+RAILS_ROOT = "/Users/tom/dev/helloworld"
+
+God.watch do |w|
+  w.name = "local-3000"
+  w.interval = 5 # seconds
+  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.pid_file = File.join(RAILS_ROOT, "log/mongrel.pid")
+  
+  # clean pid files before start if necessary
+  w.behavior(:clean_pid_file)
+  
+  # determine the state on startup
+  w.transition(:init, { true => :up, false => :start }) do |on|
+    on.condition(:process_running) do |c|
+      c.running = true
+    end
+  end
+  
+  # determine when process has finished starting
+  w.transition([:start, :restart], :up) do |on|
+    on.condition(:process_running) do |c|
+      c.running = true
+    end
+  end
+
+  # start if process is not running
+  w.transition(:up, :start) do |on|
+    on.condition(:process_exits)
+  end
+  
+  # restart if memory or cpu is too high
+  w.transition(:up, :restart) do |on|
+    on.condition(:memory_usage) do |c|
+      c.interval = 20
+      c.above = (50 * 1024) # 50mb
+      c.times = [3, 5]
+    end
+    
+    on.condition(:cpu_usage) do |c|
+      c.interval = 10
+      c.above = 10 # percent
+      c.times = [3, 5]
+    end
+  end
+end

data/examples/gravatar.god

@@ -1,46 +1,40 @@
-# run with:  god start -c /path/to/gravatar.god
+# run with:  god -c /path/to/gravatar.god
 # 
 # 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}/config/mongrel_cluster.yml"
-      w.stop = "mongrel_rails cluster::stop --only #{port} \
-        -C #{RAILS_ROOT}/config/mongrel_cluster.yml"
-      w.grace = 10 # seconds
-      
-      pid_file = File.join(RAILS_ROOT, "log/mongrel.#{port}.pid")
-      
-      w.behavior(:clean_pid_file) do |b|
-        b.pid_file = pid_file
-      end
+%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}/config/mongrel_cluster.yml"
+    w.stop = "mongrel_rails cluster::stop --only #{port} \
+      -C #{RAILS_ROOT}/config/mongrel_cluster.yml"
+    w.grace = 10 # seconds
+    
+    pid_file = File.join(RAILS_ROOT, "log/mongrel.#{port}.pid")
+    
+    w.behavior(:clean_pid_file)
 
-      w.start_if do |start|
-        start.condition(:process_not_running) do |c|
-          c.interval = 5 # seconds
-          c.pid_file = pid_file
-        end
+    w.start_if do |start|
+      start.condition(:process_running) do |c|
+        c.interval = 5 # seconds
+        c.running = false
+      end
+    end
+    
+    w.restart_if do |restart|
+      restart.condition(:memory_usage) do |c|
+        c.above = (150 * 1024) # 150mb
+        c.times = [3, 5] # 3 out of 5 intervals
       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
+    
+      restart.condition(:cpu_usage) do |c|
+        c.above = 50 # percent
+        c.times = 5
       end
     end
   end

data/ext/god/extconf.rb

@@ -1,8 +1,55 @@
 require 'mkmf'
 
+fail = false
+
+def create_dummy_makefile
+  File.open("Makefile", 'w') do |f|
+    f.puts "all:"
+    f.puts "install:"
+  end
+end
+
 case RUBY_PLATFORM
 when /bsd/i, /darwin/i
-  create_makefile 'kqueue_handler_ext'
+  unless have_header('sys/event.h')
+    puts
+    puts "Missing 'sys/event.h' header"
+    fail = true
+  end
+  
+  if fail
+    puts
+    puts "Events handler could not be compiled (see above error). Your god installation will not support event conditions."
+    create_dummy_makefile
+  else
+    create_makefile 'kqueue_handler_ext'
+  end
 when /linux/i
-  create_makefile 'netlink_handler_ext'
+  unless have_header('linux/netlink.h')
+    puts
+    puts "Missing 'linux/netlink.h' header(s)"
+    puts "You may need to install a header package for your system"
+    fail = true
+  end
+  
+  unless have_header('linux/connector.h') && have_header('linux/cn_proc.h')
+    puts
+    puts "Missing 'linux/connector.h', or 'linux/cn_proc.h' header(s)"
+    puts "These are only available in Linux kernel 2.6.15 and later (run `uname -a` to find yours)"
+    puts "You may need to install a header package for your system"
+    fail = true
+  end
+  
+  if fail
+    puts
+    puts "Events handler could not be compiled (see above error). Your god installation will not support event conditions."
+    create_dummy_makefile
+  else
+    create_makefile 'netlink_handler_ext'
+  end
+else
+  puts
+  puts "Unsupported platform '#{RUBY_PLATFORM}'. Supported platforms are BSD, DARWIN, and LINUX."
+  puts "Your god installation will not support event conditions."
+  create_dummy_makefile
 end