RubyGems - jnewland-pulse - Versions diffs - 0.4.1 - Mend

jnewland-pulse 0.4.1

Files changed (7) hide show

data/README.textile ADDED Viewed

@@ -0,0 +1,108 @@
+h1. Pulse
+Pulse adds an action to your rails project that can be used for external health checking.  The most common use is by a http proxy such as "haproxy":http://haproxy.1wt.eu/ or a monitoring tool such as "god":http://god.rubyforge.org.
+h3. Authors
+* "Paul Gross":http://www.prgs.net
+* "Jesse Newland":http://jnewland.com
+h2. Requirements
+* Rails
+* MySQL, Postgres, or Oracle. sqlite not supported, sorry.
+h2. Installation
+In your @config/environment.rb@:
+<pre>
+  <code>
+    config.gem 'jnewland_pulse', :lib => 'pulse', :source => 'http://gems.github.com'
+  </code>
+</pre>
+Install the gem:
+<pre>
+  <code>
+    cd RAILS_ROOT
+    rake gems:install
+  </code>
+</pre>
+Finally, add a route to config/routes.rb:
+<pre>
+  <code>
+    map.pulse 'pulse'
+  </code>
+</pre>
+This configures pulse to work at the 'pulse' URL.  If you would rather use a different URL:
+<pre>
+  <code>
+    map.pulse 'some/other/url'
+  </code>
+</pre>
+h2. haproxy configuration
+haproxy can be configured to use the /pulse url for its health checking.  Just add:
+<pre>
+  <code>
+    option httpchk GET /pulse
+  </code>
+</pre>
+You can adjust the interval and grace period for this check with the @check inter@ and @slowstart@ options. Since mongrel won't respond to HTTP requests until the entire Rails environment is loaded, this is essential.
+<pre>
+  <code>
+    listen rails :9000
+      server rails-1 localhost:8000 maxconn 1 check inter 20000 slowstart 90000
+      server rails-2 localhost:8001 maxconn 1 check inter 20000 slowstart 90000
+      ...
+  </code>
+</pre>
+h2. god configuration
+You are using god to watch your mongrels, right?
+In your mongrel watch, add the following restart condition:
+<pre>
+  <code>
+    w.restart_if do |restart|
+      ...
+      restart.condition(:http_response_code) do |c|
+        c.code_is_not = 200
+        c.host = 'localhost'
+        c.path = '/pulse'
+        c.port = 8000
+        c.timeout = 5.seconds
+        c.interval = 20.seconds
+      end
+    end
+  </code>
+</pre>
+Also make sure to give your mongrels a nice grace period.
+<pre>
+  <code>
+    ...
+    w.start_grace = 90.seconds
+    w.restart_grace = 90.seconds
+    ...
+  </code>
+</pre>
+For a complete god configuration example, check out my "god_examples project":http://github.com/jnewland/god_examples and the included "sample rails god config":http://github.com/jnewland/god_examples/tree/master/rails/config/god/app.god.
+h2. License
+Released under "Ruby's license":http://www.ruby-lang.org/en/LICENSE.txt

data/init.rb ADDED Viewed

	@@ -0,0 +1 @@
1	+ require File.dirname(__FILE__) + "/lib/pulse"

data/lib/pulse.rb ADDED Viewed

@@ -0,0 +1,3 @@
+require File.dirname(__FILE__) + '/pulse_controller'
+require File.dirname(__FILE__) + '/pulse_helper'
+require File.dirname(__FILE__) + '/routes'

data/lib/pulse_controller.rb ADDED Viewed

@@ -0,0 +1,19 @@
+class PulseController < ActionController::Base
+  session :off
+  #The pulse action. Runs <tt>select 1</tt> on the DB. If a sane result is
+  #returned, 'OK' is displayed and a 200 response code is returned. If not,
+  #'ERROR' is returned along with a 500 response code.
+  def pulse
+    if (ActiveRecord::Base.connection.execute("select 1 from dual").num_rows rescue 0) == 1
+      render :text => "<html><body>OK  #{Time.now.utc.to_s(:db)}</body></html>"
+    else
+      render :text => '<html><body>ERROR</body></html>', :status => :internal_server_error
+    end
+  end
+  #cancel out loggin for the PulseController by defining logger as <tt>nil</tt>
+  def logger
+    nil
+  end
+end

data/lib/pulse_helper.rb ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ module PulseHelper
2	+ end

data/lib/routes.rb ADDED Viewed

@@ -0,0 +1,9 @@
+module Pulse
+  module Routes
+    def pulse(path)
+      connect path, :controller => 'pulse', :action => 'pulse'
+    end
+  end
+end
+ActionController::Routing::RouteSet::Mapper.send :include, Pulse::Routes

metadata ADDED Viewed

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: jnewland-pulse
+version: !ruby/object:Gem::Version
+  version: 0.4.1
+platform: ruby
+authors:
+- Paul Gross
+- Jesse Newland
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2008-10-03 00:00:00 -07:00
+default_executable:
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  version_requirement:
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: "0"
+    version:
+description: Adds a pulse action to a Rails app
+email: jnewland@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- init.rb
+- lib/pulse.rb
+- lib/pulse_controller.rb
+- lib/pulse_helper.rb
+- lib/routes.rb
+- README.textile
+has_rdoc: false
+homepage: http://github.com/jnewland/pulse
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: "0"
+  version:
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: "0"
+  version:
+requirements: []
+rubyforge_project:
+rubygems_version: 1.2.0
+signing_key:
+specification_version: 2
+summary: Adds a pulse action to a Rails app
+test_files: []