RubyGems - olgen-god - Versions diffs - 0.8.0 - Mend

olgen-god 0.8.0

Files changed (148) hide show

data/.gitignore +8 -0
data/Announce.txt +135 -0
data/History.txt +345 -0
data/README.txt +59 -0
data/Rakefile +69 -0
data/VERSION.yml +4 -0
data/bin/god +132 -0
data/examples/events.god +84 -0
data/examples/gravatar.god +54 -0
data/examples/single.god +66 -0
data/ext/god/.gitignore +5 -0
data/ext/god/extconf.rb +55 -0
data/ext/god/kqueue_handler.c +123 -0
data/ext/god/netlink_handler.c +168 -0
data/god.gemspec +226 -0
data/ideas/execve/.DS_Store +0 -0
data/ideas/execve/execve.c +29 -0
data/ideas/execve/extconf.rb +11 -0
data/ideas/execve/go.rb +8 -0
data/ideas/future.god +82 -0
data/init/god +42 -0
data/init/lsb_compliant_god +109 -0
data/lib/god/behavior.rb +52 -0
data/lib/god/behaviors/clean_pid_file.rb +21 -0
data/lib/god/behaviors/clean_unix_socket.rb +21 -0
data/lib/god/behaviors/notify_when_flapping.rb +51 -0
data/lib/god/cli/command.rb +255 -0
data/lib/god/cli/run.rb +172 -0
data/lib/god/cli/version.rb +23 -0
data/lib/god/condition.rb +96 -0
data/lib/god/conditions/always.rb +23 -0
data/lib/god/conditions/complex.rb +86 -0
data/lib/god/conditions/cpu_usage.rb +80 -0
data/lib/god/conditions/degrading_lambda.rb +52 -0
data/lib/god/conditions/disk_usage.rb +32 -0
data/lib/god/conditions/file_mtime.rb +28 -0
data/lib/god/conditions/flapping.rb +128 -0
data/lib/god/conditions/http_response_code.rb +168 -0
data/lib/god/conditions/lambda.rb +25 -0
data/lib/god/conditions/memory_usage.rb +82 -0
data/lib/god/conditions/ping.rb +40 -0
data/lib/god/conditions/process_exits.rb +72 -0
data/lib/god/conditions/process_running.rb +74 -0
data/lib/god/conditions/tries.rb +44 -0
data/lib/god/configurable.rb +57 -0
data/lib/god/contact.rb +106 -0
data/lib/god/contacts/campfire.rb +83 -0
data/lib/god/contacts/email.rb +95 -0
data/lib/god/contacts/jabber.rb +127 -0
data/lib/god/contacts/sms.rb +96 -0
data/lib/god/contacts/twitter.rb +39 -0
data/lib/god/contacts/webhook.rb +47 -0
data/lib/god/dependency_graph.rb +41 -0
data/lib/god/diagnostics.rb +37 -0
data/lib/god/driver.rb +207 -0
data/lib/god/errors.rb +24 -0
data/lib/god/event_handler.rb +111 -0
data/lib/god/event_handlers/dummy_handler.rb +13 -0
data/lib/god/event_handlers/kqueue_handler.rb +17 -0
data/lib/god/event_handlers/netlink_handler.rb +13 -0
data/lib/god/logger.rb +124 -0
data/lib/god/metric.rb +59 -0
data/lib/god/process.rb +352 -0
data/lib/god/registry.rb +32 -0
data/lib/god/simple_logger.rb +53 -0
data/lib/god/smtp_tls.rb +55 -0
data/lib/god/socket.rb +96 -0
data/lib/god/sugar.rb +47 -0
data/lib/god/system/portable_poller.rb +42 -0
data/lib/god/system/process.rb +50 -0
data/lib/god/system/slash_proc_poller.rb +92 -0
data/lib/god/task.rb +503 -0
data/lib/god/timeline.rb +25 -0
data/lib/god/trigger.rb +43 -0
data/lib/god/watch.rb +183 -0
data/lib/god.rb +675 -0
data/site/images/banner.jpg +0 -0
data/site/images/bg.gif +0 -0
data/site/images/bg_grey.gif +0 -0
data/site/images/bullet.jpg +0 -0
data/site/images/corner_green.gif +0 -0
data/site/images/corner_green.psd +0 -0
data/site/images/corner_pink.gif +0 -0
data/site/images/god_logo.png +0 -0
data/site/images/header_bg.gif +0 -0
data/site/images/header_bg.jpg +0 -0
data/site/images/red_dot.gif +0 -0
data/site/images/top_bg.gif +0 -0
data/site/index.html +563 -0
data/site/install.html +2 -0
data/site/javascripts/code_highlighter.js +188 -0
data/site/javascripts/ruby.js +18 -0
data/site/stylesheets/layout.css +174 -0
data/test/configs/child_events/child_events.god +44 -0
data/test/configs/child_events/simple_server.rb +3 -0
data/test/configs/child_polls/child_polls.god +37 -0
data/test/configs/child_polls/simple_server.rb +12 -0
data/test/configs/complex/complex.god +59 -0
data/test/configs/complex/simple_server.rb +3 -0
data/test/configs/contact/contact.god +84 -0
data/test/configs/contact/simple_server.rb +3 -0
data/test/configs/daemon_events/daemon_events.god +37 -0
data/test/configs/daemon_events/simple_server.rb +8 -0
data/test/configs/daemon_events/simple_server_stop.rb +11 -0
data/test/configs/daemon_polls/daemon_polls.god +17 -0
data/test/configs/daemon_polls/simple_server.rb +6 -0
data/test/configs/degrading_lambda/degrading_lambda.god +31 -0
data/test/configs/degrading_lambda/tcp_server.rb +15 -0
data/test/configs/lifecycle/lifecycle.god +25 -0
data/test/configs/matias/matias.god +50 -0
data/test/configs/real.rb +59 -0
data/test/configs/running_load/running_load.god +16 -0
data/test/configs/stress/simple_server.rb +3 -0
data/test/configs/stress/stress.god +15 -0
data/test/configs/task/logs/.placeholder +0 -0
data/test/configs/task/task.god +26 -0
data/test/configs/test.rb +61 -0
data/test/helper.rb +139 -0
data/test/suite.rb +6 -0
data/test/test_behavior.rb +18 -0
data/test/test_campfire.rb +41 -0
data/test/test_condition.rb +50 -0
data/test/test_conditions_disk_usage.rb +50 -0
data/test/test_conditions_http_response_code.rb +109 -0
data/test/test_conditions_process_running.rb +40 -0
data/test/test_conditions_tries.rb +67 -0
data/test/test_contact.rb +109 -0
data/test/test_dependency_graph.rb +62 -0
data/test/test_driver.rb +11 -0
data/test/test_email.rb +45 -0
data/test/test_event_handler.rb +80 -0
data/test/test_god.rb +570 -0
data/test/test_handlers_kqueue_handler.rb +16 -0
data/test/test_jabber.rb +36 -0
data/test/test_logger.rb +55 -0
data/test/test_metric.rb +72 -0
data/test/test_process.rb +247 -0
data/test/test_registry.rb +15 -0
data/test/test_socket.rb +34 -0
data/test/test_sugar.rb +42 -0
data/test/test_system_portable_poller.rb +17 -0
data/test/test_system_process.rb +30 -0
data/test/test_task.rb +246 -0
data/test/test_timeline.rb +37 -0
data/test/test_trigger.rb +59 -0
data/test/test_watch.rb +279 -0
data/test/test_webhook.rb +17 -0
metadata +242 -0

data/site/index.html ADDED Viewed

@@ -0,0 +1,563 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <title>God - A Process Monitoring Framework in Ruby</title>
+  <link href="stylesheets/layout.css" rel="stylesheet" type="text/css" />
+  <script type="text/javascript" src="javascripts/code_highlighter.js"></script>
+  <script type="text/javascript" src="javascripts/ruby.js"></script>
+</head>
+<body id="page_home">
+<div id="mothership">
+</div>
+<div id="content">
+	<div class="banner">
+	</div>
+  <!-- <div id="menu">
+    <div class="dots"></div>
+    <ul>
+      <li class="menu_home"><a href="/">Home</a></li>
+      <li class="menu_contact"><a href="mailto:tom@projectmothership.com">Contact</a></li>
+    </ul>
+    <div class="dots"></div>
+  </div> -->
+	<div class="columnleft">
+		<h1>A Better Way to Monitor</h1>
+		<p>God is an easy to configure, easy to extend monitoring framework written in Ruby.</p>
+		<p>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.</p>
+		<p style="text-align: right">Tom Preston-Werner<br /><a href="mailto:tom@mojombo.com">tom@mojombo.com</a></p>
+		<p style="text-align: right">Google Group: <a href="http://groups.google.com/group/god-rb">http://groups.google.com/group/god-rb</a></p>
+	</div>
+	<div class="columnright">
+	<h1>Features</h1>
+	<ul class="features">
+		<li>Config file is written in Ruby</li>
+		<li>Easily write your own custom conditions in Ruby</li>
+		<li>Supports both poll and event based conditions</li>
+		<li>Different poll conditions can have different intervals</li>
+		<li>Integrated notification system (write your own too!)</li>
+		<li>Easily control non-daemonizing scripts</li>
+	</ul>
+	</div>
+	<h1>Installation (v 0.7.17)</h1>
+	<p>The best way to get god is via rubygems:</p>
+	<pre>$ sudo gem install god</pre>
+	<h1>Contribute</h1>
+	<p>God is open source and accepting pull requests via GitHub!</p>
+	<p><a href="http://github.com/mojombo/god">http://github.com/mojombo/god</a></p>
+	<h1>Requirements</h1>
+	<p>God currently only works on <b>Linux (kernel 2.6.15+), BSD,</b> and <b>Darwin</b> systems. No support for Windows is planned. Event based conditions on Linux systems require the <code>cn</code> (connector) kernel module loaded or compiled in to the kernel and god must be run as root.</p>
+	<p>The following systems have been tested. Help us test it on others!</p>
+	<ul>
+	  <li>Darwin 10.4.10</li>
+	  <li>RedHat Fedora Core 6</li>
+	  <li>Ubuntu Dapper (no events)</li>
+	  <li>Ubuntu Feisty</li>
+	  <li>CentOS 4.5 (no events)</li>
+	</ul>
+	<h1>Config Files are Ruby Code!</h1>
+	<p>The easiest way to understand how god will make your life better is by looking at a sample config file. The following configuration file is what I once used at <a href="http://site.gravatar.com/">gravatar.com</a> to keep the mongrels running:</p>
+<pre><code class="ruby"># run with: god -c /path/to/mongrel.god -D
+#
+# This is the actual config file used to keep the mongrels of
+# gravatar.com running.
+RAILS_ROOT = "/Users/tom/dev/gravatar2"
+%w{8200 8201 8202}.each do |port|
+  God.watch do |w|
+    w.name = "gravatar2-mongrel-#{port}"
+    w.interval = 30.seconds # default
+    w.start = "mongrel_rails start -c #{RAILS_ROOT} -p #{port} \
+      -P #{RAILS_ROOT}/log/mongrel.#{port}.pid  -d"
+    w.stop = "mongrel_rails stop -P #{RAILS_ROOT}/log/mongrel.#{port}.pid"
+    w.restart = "mongrel_rails restart -P #{RAILS_ROOT}/log/mongrel.#{port}.pid"
+    w.start_grace = 10.seconds
+    w.restart_grace = 10.seconds
+    w.pid_file = File.join(RAILS_ROOT, "log/mongrel.#{port}.pid")
+    w.behavior(:clean_pid_file)
+    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.megabytes
+        c.times = [3, 5] # 3 out of 5 intervals
+      end
+      restart.condition(:cpu_usage) do |c|
+        c.above = 50.percent
+        c.times = 5
+      end
+    end
+    # lifecycle
+    w.lifecycle do |on|
+      on.condition(:flapping) do |c|
+        c.to_state = [:start, :restart]
+        c.times = 5
+        c.within = 5.minute
+        c.transition = :unmonitored
+        c.retry_in = 10.minutes
+        c.retry_times = 5
+        c.retry_within = 2.hours
+      end
+    end
+  end
+end</code></pre>
+<p>That's a lot to take in at once, so I'll break it down by section and explain what's going on in each.</p>
+<pre><code class="ruby">RAILS_ROOT = "/var/www/gravatar2/current"</code></pre>
+<p>Here I've set a constant that is used throughout the file. Keeping the <code>RAILS_ROOT</code> value in a constant makes it easy to adapt this script to other applications. Because the config file is Ruby code, I can set whatever variables or constants I want that make the configuration more concise and easier to work with.</p>
+<pre><code class="ruby">%w{8200 8201 8202}.each do |port|
+  ...
+end</code></pre>
+<p>Because the config file is written in actual Ruby code, we can construct loops and do other intelligent things that are impossible in your every day, run of the mill config file. I need to watch three mongrels, so I simply loop over their port numbers, eliminating duplication and making my life a whole lot easier.</p>
+<pre><code class="ruby">  God.watch do |w|
+    w.name = "gravatar2-mongrel-#{port}"
+    w.interval = 30.seconds # default
+    w.start = "mongrel_rails start -c #{RAILS_ROOT} -p #{port} \
+      -P #{RAILS_ROOT}/log/mongrel.#{port}.pid  -d"
+    w.stop = "mongrel_rails stop -P #{RAILS_ROOT}/log/mongrel.#{port}.pid"
+    w.restart = "mongrel_rails restart -P #{RAILS_ROOT}/log/mongrel.#{port}.pid"
+    w.start_grace = 10.seconds
+    w.restart_grace = 10.seconds
+    w.pid_file = File.join(RAILS_ROOT, "log/mongrel.#{port}.pid")
+    ...
+  end</code></pre>
+<p>A <code>watch</code> represents a single process that has concrete start, stop, and/or restart operations. You can define as many watches as you like. In the example above, I've got some Rails instances running in Mongrels that I need to keep alive. Every watch must have a unique <code>name</code> so that it can be identified later on. The <code>interval</code> option sets the default poll interval (this can be overridden in each condition). The <code>start</code> and <code>stop</code> attributes specify the commands to start and stop the process. If no <code>restart</code> attribute is set, restart will be represented by a call to stop followed by a call to start. The optional <code>grace</code> attribute sets the amount of time following a start/stop/restart command to wait before resuming normal monitoring operations. To be more specific, I can set just <code>start_grace</code>, <code>stop_grace</code>, and/or <code>restart_grace</code>. If the process you're watching runs as a daemon (as mine does), you'll need to set the <code>pid_file</code> attribute.</p>
+<pre><code class="ruby">    w.behavior(:clean_pid_file)</code></pre>
+<p>Behaviors allow you to execute additional commands around start/stop/restart commands. In our case, if the process dies it will leave a PID file behind. The next time a start command is issued, it will fail, complaining about the leftover PID file. We'd like the PID file cleaned up before a start command is issued. The built-in behavior <code>clean_pid_file</code> will do just that.</p>
+<pre><code class="ruby">    w.start_if do |start|
+      start.condition(:process_running) do |c|
+        c.interval = 5.seconds
+        c.running = false
+      end
+    end</code></pre>
+<p>Watches contain conditions grouped by the action to execute should they return <code>true</code>. I start with a <code>start_if</code> block that contains a single condition. Conditions are specified by calling <code>condition</code> with an identifier, in this case
+<code>:process_running</code>. Each condition can specify a poll interval that will override the default watch interval. In this case, I want to check that the process is still running every 5 seconds instead of the 30 second interval that other conditions will inherit. The ability to set condition specific poll intervals makes it possible to run critical tests (such as :process_running) more often than less critical tests (such as :memory_usage and :cpu_usage).</p>
+<pre><code class="ruby">    w.restart_if do |restart|
+      restart.condition(:memory_usage) do |c|
+        c.above = 150.megabytes
+        c.times = [3, 5] # 3 out of 5 intervals
+      end
+      ...
+    end</code></pre>
+<p>Similar to <code>start_if</code> there is a <code>restart_if</code> command that groups conditions that should trigger a restart. The <code>memory_usage</code> condition will fail if the specified process is using too much memory. The maximum allowable amount of memory is specified with the <code>above</code> attribute (you can use the kilobytes, megabytes, or gigabytes helpers). The number of times the test needs to fail in order to trigger a restart is set with <code>times</code>. This can be either an integer or an array. An integer means it must fail that many times in a row while an array [x, y] means it must fail x times out of the last y tests.</p>
+<pre><code class="ruby">    w.restart_if do |restart|
+      ...
+      restart.condition(:cpu_usage) do |c|
+        c.above = 50.percent
+        c.times = 5
+      end
+    end</code></pre>
+<p>To keep an eye on CPU usage, I've employed the <code>cpu_usage</code> condition. When CPU usage for a Mongrel process is over 50% for 5 consecutive intervals, it will be restarted.</p>
+<pre><code class="ruby">    w.lifecycle do |on|
+      on.condition(:flapping) do |c|
+        c.to_state = [:start, :restart]
+        c.times = 5
+        c.within = 5.minute
+        c.transition = :unmonitored
+        c.retry_in = 10.minutes
+        c.retry_times = 5
+        c.retry_within = 2.hours
+      end
+    end</code></pre>
+<p>Conditions inside a <code>lifecycle</code> section are active as long as the process is being monitored (they live across state changes).
+<p>The <code>:flapping</code> condition guards against the edge case wherein god rapidly starts or restarts your application. Things like server configuration changes or the unavailability of external services could make it impossible for my process to start. In that case, god will try to start my process over and over to no avail. The <code>:flapping</code> condition provides two levels of giving up on flapping processes. If I were to translate the options of the code above, it would be something like: If this watch is started or restarted five times withing 5 minutes, then unmonitor it...then after ten minutes, monitor it again to see if it was just a temporary problem; if the process is seen to be flapping five times within two hours, then give up completely.</p>
+<p>That's it!</p>
+<!-- ------------------------------------------------------------------------- -->
+<h1>Changing UID/GID for processes</h1>
+<p>It is possible to have god run your start/stop/restart commands as a specific user/group. This can be done by setting the <code>uid</code> and/or <code>gid</code> attributes of a watch.</p>
+<pre><code class="ruby">  God.watch do |w|
+    ...
+    w.uid = 'tom'
+    w.gid = 'devs'
+    ...
+  end</code></pre>
+</p>This only works for commands specified as a string. Lambda commands are unaffected.</p>
+<!-- ------------------------------------------------------------------------- -->
+<h1>Lambda commands</h1>
+<p>In addition to specifying start/stop/restart commands as strings (to be executed via the shell), you can specify a lambda that will be called.</p>
+<pre><code class="ruby">  God.watch do |w|
+    ...
+    w.start = lambda { ENV['APACHE'] ? `apachectl -k graceful` : `lighttpd restart` }
+    ...
+  end</code></pre>
+<!-- ------------------------------------------------------------------------- -->
+<h1>Starting and Controlling God</h1>
+<p>To start the god monitoring process as a daemon simply run the <code>god</code> executable passing in the path to the config file (you need to sudo if you're using events on Linux or want to use the setuid/setgid functionality):</p>
+<pre>$ sudo god -c /path/to/config.god</pre>
+<p>While you're writing your config file, it can be helpful to run god in the foreground so you can see the log messages. You can do that with:</p>
+<pre>$ sudo god -c /path/to/config.god -D</pre>
+<p>You can start/restart/stop/monitor/unmonitor your Watches with the same utility like so:</p>
+<pre>$ sudo god stop gravatar2-mongrel-8200</pre>
+<!-- ------------------------------------------------------------------------- -->
+<h1>Grouping Watches</h1>
+<p>Watches can be assigned to groups. These groups can then be controlled together from the command line.</p>
+<pre><code class="ruby">  God.watch do |w|
+    ...
+    w.group = 'mongrels'
+    ...
+  end</code></pre>
+<p>The above configuration now allows you to control the watch (and any others that are in the group) with a single command:</p>
+<pre>$ sudo god stop mongrels</pre>
+<!-- ------------------------------------------------------------------------- -->
+<h1>Advanced Configuration with Transitions and Events</h1>
+<p>So far you've been introduced to a simple poll-based config file and seen how to run it. Poll-based monitoring works great for simple things, but falls short for highly critical tasks. God has native support for kqueue/netlink events on BSD/Darwin/Linux systems. For instance, instead of using the <code>process_running</code> condition to poll for the status of your process, you can use the <code>process_exits</code> condition that will be notified <b>immediately</b> upon the exit of your process. This means less load on your system and shorter downtime after a crash.</p>
+<p>While the configuration syntax you saw in the previous example is very simple, it lacks the power that we need to deal with event based monitoring. In fact, the <code>start_if</code> and <code>restart_if</code> methods are really just calling out to a lower-level API. If we use the low-level API directly, we can harness the full power of god's event based lifecycle system. Let's look at another example config file.</p>
+<pre><code class="ruby">RAILS_ROOT = "/Users/tom/dev/gravatar2"
+God.watch do |w|
+  w.name = "local-3000"
+  w.interval = 5.seconds # default
+  w.start = "mongrel_rails start -c #{RAILS_ROOT} -P #{RAILS_ROOT}/log/mongrel.pid -p 3000 -d"
+  w.stop = "mongrel_rails stop -P #{RAILS_ROOT}/log/mongrel.pid"
+  w.restart = "mongrel_rails restart -P #{RAILS_ROOT}/log/mongrel.pid"
+  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
+    # failsafe
+    on.condition(:tries) do |c|
+      c.times = 5
+      c.transition = :start
+    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.megabytes
+      c.times = [3, 5]
+    end
+    on.condition(:cpu_usage) do |c|
+      c.interval = 10
+      c.above = 10.percent
+      c.times = [3, 5]
+    end
+  end
+  # lifecycle
+  w.lifecycle do |on|
+    on.condition(:flapping) do |c|
+      c.to_state = [:start, :restart]
+      c.times = 5
+      c.within = 5.minute
+      c.transition = :unmonitored
+      c.retry_in = 10.minutes
+      c.retry_times = 5
+      c.retry_within = 2.hours
+    end
+  end
+end
+</code></pre>
+<p>A bit longer, I know, but very straighforward once you understand how the <code>transition</code> calls work. The <code>name</code>, <code>interval</code>, <code>start</code>, <code>stop</code>, and <code>pid_file</code> attributes should be familiar. We also specify the <code>clean_pid_file</code> behavior.</p>
+<p>Before jumping into the code, it's important to understand the different states that a Watch can have, and how that state changes over time. At any given time, a Watch will be in one of the <code>init</code>, <code>up</code>, <code>start</code>, or <code>restart</code> states. As different conditions are satisfied, the Watch will progress from state to state, enabling and disabling conditions along the way.</p>
+<p>When god first starts, each Watch is placed in the <code>init</code> state.</p>
+<p>You'll use the <code>transition</code> method to tell god how to transition between states. It takes two arguments. The first argument may be either a symbol or an array of symbols representing the state or states during which the specified conditions should be enabled. The second argument may be either a symbol or a hash. If it is a symbol, then that is the state that will be transitioned to if any of the conditions return <code>true</code>. If it is a hash, then that hash must have both <code>true</code> and <code>false</code> keys, each of which point to a symbol that represents the state to transition to given the corresponding return from the single condition that must be specified.</p>
+<pre><code class="ruby">  # 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</code></pre>
+<p>The first transition block tells god what to do when the Watch is in the <code>init</code> state (first argument). This is where I tell god how to determine if my task is already running. Since I'm monitoring a process, I can use the <code>process_running</code> condition to determine whether the process is running. If the process is running, it will return true, otherwise it will return false. Since I sent a hash as the second argument to <code>transition</code>, the return from <code>process_running</code> will determine which of the two states will be transitioned to. If the process is running, the return is true and god will put the Watch into the <code>up</code> state. If the process is not running, the return is false and god will put the Watch into the <code>start</code> state.</p>
+<pre><code class="ruby">  # determine when process has finished starting
+  w.transition([:start, :restart], :up) do |on|
+    on.condition(:process_running) do |c|
+      c.running = true
+    end
+    ...
+  end</code></pre>
+<p>If god has determined that my process isn't running, the Watch will be put into the <code>start</code> state. Upon entering this state, the <code>start</code> command that I specified on the Watch will be called. In addition, the above transition specifies a condition that should be enabled when in either the <code>start</code> or <code>restart</code> states. The condition is another <code>process_running</code>, however this time I'm only interested in moving to another state once it returns <code>true</code>. A <code>true</code> return from this condition means that the process is running and it's ok to transition to the <code>up</code> state (second argument to <code>transition</code>).</p>
+<pre><code class="ruby">  # determine when process has finished starting
+  w.transition([:start, :restart], :up) do |on|
+    ...
+    # failsafe
+    on.condition(:tries) do |c|
+      c.times = 5
+      c.transition = :start
+    end
+  end</code></pre>
+<p>The other half of this transition uses the <code>tries</code> condition to ensure that god doesn't get stuck in this state. It's possible that the process could go down while the transition is being made, in which case god would end up polling forever to see if the process is up. Here I've specified that if this condition is called five times, god should override the normal transition destination and move to the <code>start</code> state instead. If you specify a <code>transition</code> attribute on any condition, that state will be transferred to instead of the normal transfer destination.</p>
+<pre><code class="ruby">  # start if process is not running
+  w.transition(:up, :start) do |on|
+    on.condition(:process_exits)
+  end</code></pre>
+<p>This is where the event based system comes into play. Once in the <code>up</code> state, I want to be notified when my process exits. The <code>process_exits</code> condition registers a callback that will trigger a transition change when it is fired off. Event conditions (like this one) cannot be used in transitions that have a hash for the second argument (as they do not return true or false).</p>
+<pre><code class="ruby">  # 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.megabytes
+      c.times = [3, 5]
+    end
+    on.condition(:cpu_usage) do |c|
+      c.interval = 10
+      c.above = 10.percent
+      c.times = [3, 5]
+    end
+  end</code></pre>
+<p>Notice that I can have multiple transitions with the same start state. In this case, I want to have the <code>memory_usage</code> and <code>cpu_usage</code> poll conditions going at the same time that I listen for the process exit event. In the case of runaway CPU or memory usage, however, I want to transition to the <code>restart</code> state. When a Watch enters the <code>restart</code> state it will either call the <code>restart</code> command that you specified, or if none has been set, call the <code>stop</code> and then <code>start</code> commands.</p>
+<!-- ------------------------------------------------------------------------- -->
+<h1>Watching Non-Daemon Processes</h1>
+<p>Need to watch a script that doesn't have built in daemonization? No problem! God will daemonize and keep track of your process for you. If you don't specify a <code>pid_file</code> attribute for a watch, it will be auto-daemonized and a PID file will be stored for it in <code>/var/run/god</code>. If you'd rather have the PID file stored in a different location, you can set it at the top of your config:</p>
+<pre><code class="ruby">God.pid_file_directory = '/home/tom/pids'
+God.watch do |w|
+  # watch with no pid_file attribute set
+end</code></pre>
+<p>The directory you specify must be writable by god.</p>
+<!-- ------------------------------------------------------------------------- -->
+<h1>Loading Other Config Files</h1>
+<p>You should feel free to separate your god configs into separate files for easier organization. You can load in other configs using Ruby's normal <code>load</code> method, or use the convenience method <code>God.load</code> which allows for glob-style paths:</p>
+<pre><code class="ruby"># load in all god configs
+God.load "/usr/local/conf/*.god"</code></pre>
+<p>God won't start its monitoring operations until all configurations have been loaded.</p>
+<!-- ------------------------------------------------------------------------- -->
+<h1>Dynamically Loading Config Files Into an Already Running God</h1>
+<p>God allows you to load or reload configurations into an already running instance. There are a few things to consider when doing this:</p>
+<ul>
+  <li>Existng Watches with the same <code>name</code> as the incoming Watches will be overidden by the new config.</li>
+  <li>All paths must be either absolute or relative to the path from which god was started.</li>
+</ul>
+<p>To load a config into a running god, issue the following command:</p>
+<pre>$ sudo god load path/to/config.god</pre>
+<p>Config files that are loaded dynamically can contain anything that a normal config file contains, however, global options such as <code>God.pid_file_directory</code> blocks will be ignored (and produce a warning in the logs).</p>
+<!-- ------------------------------------------------------------------------- -->
+<h1>Getting Logs for a Single Watch</h1>
+<p>Sifting through the god logs for statements specific to a single Watch can be frustrating when you have many of them. You can get the realtime logs for a single Watch via the command line:</p>
+<pre>$ sudo god log local-3000</pre>
+<p>This will display log output for the 'local-3000' Watch and update every second with new log messages.</p>
+<p>You can also supply a shorthand to the log command that will match one of your watches. If it happens to match several, the shortest match will be used:</p>
+<pre>$ sudo god log l3</pre>
+<!-- ------------------------------------------------------------------------- -->
+<h1>Notifications</h1>
+<p>God has an extensible notification framework built in that makes it easy to have notifications sent when conditions are triggered. There are three steps to enabling notifications.</p>
+<p>Step 1: Set the options for the notification subsystem(s) that you'll be using. Let's look at how to setup email notifications.</p>
+<pre><code class="ruby">God::Contacts::Email.message_settings = {
+  :from => 'god@example.com'
+}
+God::Contacts::Email.server_settings = {
+  :address => "smtp.example.com",
+  :port => 25,
+  :domain => "example.com",
+  :authentication => :plain,
+  :user_name => "john",
+  :password => "s3kr3ts"
+}</code></pre>
+<p>Step 2: Configure some contacts.</p>
+<pre><code class="ruby">God.contact(:email) do |c|
+  c.name = 'tom'
+  c.email = 'tom@example.com'
+end
+God.contact(:email) do |c|
+  c.name = 'vanpelt'
+  c.email = 'vanpelt@example.com'
+  c.group = 'developers'
+end
+God.contact(:email) do |c|
+  c.name = 'kevin'
+  c.email = 'kevin@example.com'
+  c.group = 'developers'
+end</code></pre>
+<p>Step 3: Attach to a condition:</p>
+<pre><code class="ruby">  w.transition(:up, :start) do |on|
+    on.condition(:process_exits) do |c|
+      c.notify = 'tom'
+    end
+  end</code></pre>
+<p>There are two ways to specify that a notification should be sent. The first, easier way is shown above. Every condition can take an optional <code>notify</code> attribute that specifies which contacts should be notified when the condition is triggered. The value can be a contact name or contact group *or* an array of contact names and/or contact groups.</p>
+<pre><code class="ruby">  w.transition(:up, :start) do |on|
+    on.condition(:process_exits) do |c|
+      c.notify = {:contacts => ['tom', 'developers'], :priority => 1, :category => 'product'}
+    end
+  end</code></pre>
+</p>The second way allows you to specify the <code>priority</code> and <code>category</code> in addition to the contacts. The extra attributes can be arbitrary integers or strings and will be passed as-is to the notification subsystem.</p>
+<p>The above notification will arrive as an email similar to the following.</p>
+<pre><code>From: god &lt;god@example.com&gt;
+To: tom &lt;tom@example.com&gt;
+Subject: [god] mongrel-8600 [trigger] process exited (ProcessExits)
+Message: mongrel-8600 [trigger] process exited (ProcessExits)
+Host: candymountain.example.com
+Priority: 1
+Category: product</code></pre>
+<!-- ------------------------------------------------------------------------- -->
+<h1>Extend God with your own Conditions</h1>
+<p>God was designed from the start to allow you to easily write your own custom conditions, making it simple to add tests that are application specific.</p>
+</div>
+<div id="footer">
+	<p>Brought to you by <a href="http://tom.preston-werner.com/">Tom Preston-Werner</a></p>
+</div>
+<script src="http://www.google-analytics.com/urchin.js" type="text/javascript">
+</script>
+<script type="text/javascript">
+_uacct = "UA-2196727-1";
+urchinTracker();
+</script>
+</body>
+</html>

data/site/install.html ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ ln -s /usr/src/linux-headers-2.6.15-28/include/linux/connector.h /usr/include/linux/connector.h
2	+ ln -s /usr/src/linux-headers-2.6.15-28/include/linux/cn_proc.h /usr/include/linux/cn_proc.h