rack-monitor 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Pirmin Kalberer
+
+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/README.rdoc

@@ -0,0 +1,57 @@
+=Rack::Monitor
+
+Rack::Monitor is Rack middleware collecting run-time information for 
+monitoring tools like Munin.
+
+==Installation
+
+ $ sudo gem install rack-monitor
+
+==Basic Usage
+
+Rack::Monitor is implemented as a piece of Rack middleware and can be used with
+any Rack-based application. If your application includes a rackup (`.ru`) file
+or uses Rack::Builder to construct the application pipeline, simply require
+and use as follows:
+
+ require 'rack/monitor'
+
+ use Rack::Monitor if ENV['RACK_ENV'] == 'production'
+
+ run app
+
+==Using with Rails
+
+Add this to your `config/environments/production.rb`:
+
+ config.gem "rack-monitor", :lib => "rack/monitor"
+
+ require 'rack/monitor' #Rails bug?
+ config.middleware.use Rack::Monitor
+
+You should now see `Rack::Monitor` listed in the middleware pipeline:
+
+ RAILS_ENV=production rake middleware
+
+==Monitoring with Munin
+
+Copy plugin files from http://github.com/pka/rack-monitor/tree/master/munin/ to /etc/munin/plugins/
+
+Setup a configuration in /etc/munin/plugin-conf.d/ like
+http://github.com/pka/rack-monitor/tree/master/muninplugin-conf.d/rack
+
+ /etc/init.d/munin-node restart
+
+==Links
+
+GitHub:: http://github.com/pka/rack-monitor
+
+
+Thanks to:
+
+* rack-bug
+* Rails footnotes
+
+== Copyright
+
+Copyright (c) 2010 Pirmin Kalberer. See LICENSE for details.

data/lib/rack/monitor.rb

@@ -0,0 +1,10 @@
+require "rack"
+
+module Rack::Monitor
+  autoload :MonitorApp,                'rack/monitor/monitor_app'
+
+  def self.new(*args, &block)
+    MonitorApp.new(*args, &block)
+  end
+
+end

data/lib/rack/monitor/monitor_app.rb

@@ -0,0 +1,45 @@
+require 'rack/monitor/sensor'
+
+# Load all sensors
+#
+Dir[File.join(File.dirname(__FILE__), 'sensors', '*.rb')].each do |sensor|
+  require sensor
+end
+
+module Rack::Monitor
+
+class MonitorApp
+  def initialize(app, options={})
+    @app = app
+    @options = {:url=>'/rack_status'}.merge(options)
+    sensor_class_names = Rack::Monitor.constants.reject { |s| %q(Sensor MonitorApp).include?(s) }
+    @sensors = sensor_class_names.collect { |s| Rack::Monitor.const_get(s).new }
+  end
+
+  def call(env, options={})
+    if env["PATH_INFO"] == @options[:url]
+      [200, {'Content-Type' => 'text/plain'}, [monitor_output]]
+    else
+      @sensors.each { |sensor| sensor.before(env) }
+      status, headers, response = @app.call(env)
+      @sensors.each { |sensor| sensor.after(env) }
+      [status, headers, response]
+    end
+  end
+
+  private
+
+  def monitor_output
+    output = ''
+    @sensors.each do |sensor|
+      class_name = sensor.class.name.gsub(/^.*::/, '')
+      sensor.collect
+      sensor.measurements.each do |var, desc, value|
+        output << "[#{class_name}:#{var}] #{desc}: #{value}\n"
+      end
+    end
+    output
+  end
+end
+
+end

data/lib/rack/monitor/sensor.rb

@@ -0,0 +1,24 @@
+require 'rack'
+
+module Rack::Monitor
+
+class Sensor
+  #Called before request
+  def before(env)
+  end
+  
+  #Called after request
+  def after(env)
+  end
+  
+  #Called before delivering measurements
+  def collect
+  end
+  
+  #Return measured values arrays [variable, description, value]
+  def measurements
+    []
+  end
+end
+
+end

data/lib/rack/monitor/sensors/memory.rb

@@ -0,0 +1,18 @@
+module Rack::Monitor
+
+class Memory < Sensor
+  def initialize
+    @used = 0
+  end
+  
+  def collect
+    @used = `ps -o rss= -p #{$$}`.to_i
+  end
+  
+  def measurements
+    [['used', 'Memory used', @used]]
+  end
+end
+
+
+end

data/lib/rack/monitor/sensors/request.rb

@@ -0,0 +1,17 @@
+module Rack::Monitor
+
+class Request < Sensor
+  def initialize
+    @count = 0
+  end
+  
+  def after(env)
+    @count += 1
+  end
+  
+  def measurements
+    [['count', 'Total requests', @count]]
+  end
+end
+
+end

data/lib/rack/monitor/sensors/version.rb

@@ -0,0 +1,14 @@
+module Rack::Monitor
+
+class Version < Sensor
+  def measurements
+    m = [['rack_info', 'Rack version', Rack.release]]
+    if defined?(Rails) && defined?(Rails::Info)
+      m << ['rails_info', 'Rails version', Rails.version]
+    end
+    m
+  end
+end
+
+
+end

data/test/helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rack/monitor'
+
+class Test::Unit::TestCase
+end

data/test/test_rack-monitor.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestRackMonitor < Test::Unit::TestCase
+  def test_something_for_real
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification 
+name: rack-monitor
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Pirmin Kalberer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-03 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: Run-time date collector
+email: pka@sourcepole.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- lib/rack/monitor.rb
+- lib/rack/monitor/monitor_app.rb
+- lib/rack/monitor/sensor.rb
+- lib/rack/monitor/sensors/memory.rb
+- lib/rack/monitor/sensors/request.rb
+- lib/rack/monitor/sensors/version.rb
+- LICENSE
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/pka/rack-monitor
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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.3.5
+signing_key: 
+specification_version: 3
+summary: Rack::Monitor middleware
+test_files: 
+- test/helper.rb
+- test/test_rack-monitor.rb