operations_middleware 0.3.0 → 0.3.1

data/.gitignore

@@ -17,5 +17,6 @@ tmtags
 coverage
 rdoc
 pkg
+doc
 
 ## PROJECT::SPECIFIC

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Emily Price
+Copyright (c) 2010 PRIMEDIA Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -1,6 +1,36 @@
-= operation_middleware
+= Operations Middleware
 
-Description goes here.
+This library provides a piece of Rack middleware for monitoring application status. To include it in a rails application, you need to provide the following minimum configuration:
+
+  config.gem 'operations_middleware'
+  require 'operations_middleware'
+  config.middleware.use OperationsMiddleware do |ops|
+    ops.file_root = RAILS_ROOT
+  end
+  
+== Version Page
+
+This will provide a page at <tt>/ops/version</tt> which shows, in development mode, the current git branch and last commit SHA. In all other modes, it shows the same information, but taken from the contents of VERSION and REVISION files in the <tt>file_root</tt> directory. If you are deploying with Capistrano, the REVISION file will be created for you. If you want the VERSION file, you'll need to add that to your project or your Capistrano scripts.
+
+== Heartbeat Page
+
+It also provides a simple page at <tt>/ops/heartbeat</tt> which returns a 200 'OK' as long as the application is running.
+
+The application name is taken from the enclosing folder of the <tt>file_root</tt> option. If that folder is a Capistrano timestamped release, it goes up 2 additional levels for the name, stripping <tt>.com</tt> from the end of the directory if necessary. If this logic does not get the correct application name, it can be set manually in the configuration block:
+
+  ops.app_name = 'Custom Application Name'
+  
+=== Adding Custom Heartbeats
+
+Additionally, you can specify custom heartbeat monitoring pages as follows:
+
+  ops.heartbeat[:mysql] = lambda do
+    conn = ActiveRecord::Base.connection
+    migrations = conn.select_all("SELECT COUNT(1) FROM schema_migrations;") 
+    conn.disconnect!
+  end
+
+The mysql example shown above would be accessed at <tt>ops/heartbeat/mysql</tt>. The heartbeat can be set to any object which responds to <tt>call</tt>. The heartbeat page will return a 200 'OK' as long as the provided lambda does not raise an error. If an error is raised, a 500 will be returned instead.
 
 == Note on Patches/Pull Requests
  
@@ -14,4 +44,4 @@ Description goes here.
 
 == Copyright
 
-Copyright (c) 2010 Emily Price. See LICENSE for details.
+Copyright (c) 2010 PRIMEDIA Inc. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.3.1

data/lib/operations_middleware.rb

@@ -10,7 +10,9 @@ class OperationsMiddleware
 
   def call(env)
     return @app.call(env) unless env['PATH_INFO'] =~ %r{^/ops/(heartbeat|version)(?:/(\w+))?/?$}
-    
+        
+    @request_headers = env
+
     @status = 200
     @headers = {}
     
@@ -108,7 +110,7 @@ class OperationsMiddleware
   end
 
   def headers
-    hh = @headers.select{|k,v| k.match(/^HTTP.*/) }
+    hh = @request_headers.select{|k,v| k.match(/^[-A-Z_].*$/) }
     return if hh.nil? || hh.empty?
     ret = "<table border='1' style='width:100%'>"
     hh.each { |k, v| ret += "<tr><td>#{k}</td><td>#{v}</td></tr>" }

data/operations_middleware.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{operations_middleware}
-  s.version = "0.3.0"
+  s.version = "0.3.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Primedia Team"]
-  s.date = %q{2010-07-19}
+  s.date = %q{2010-07-06}
   s.description = %q{Rack middleware to provide route for heartbeat and version pages. Includes links to github repo. }
   s.email = %q{}
   s.extra_rdoc_files = [

data/spec/spec_helper.rb

@@ -1,6 +1,8 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rubygems'
 gem 'rack', '1.0.1'
+require 'rack'
 require 'operations_middleware'
 require 'spec'
 require 'spec/autorun'

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 3
-  - 0
-  version: 0.3.0
+  - 1
+  version: 0.3.1
 platform: ruby
 authors: 
 - Primedia Team
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-19 00:00:00 -04:00
+date: 2010-07-06 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency