goliath-chimp 0.0.1 → 0.0.2

data/lib/goliath/chimp.rb

@@ -3,9 +3,14 @@ require 'gorillib/metaprogramming/concern'
 require 'multi_json'
 
 require 'goliath/chimp/handler'
+
+require 'goliath/chimp/plugins/activity_monitor'
+
+require 'goliath/chimp/rack/env_extractor'
 require 'goliath/chimp/rack/api_version'
 require 'goliath/chimp/rack/control_methods'
 require 'goliath/chimp/rack/force_content_type'
+require 'goliath/chimp/rack/server_metrics'
 
 require 'goliath/chimp/rack/formatters/json'
 

data/lib/goliath/chimp/plugins/activity_monitor.rb

@@ -0,0 +1,37 @@
+module Goliath::Chimp
+  module Plugin
+    class ActivityMonitor
+
+      attr_reader :logger, :status, :previous
+
+      def initialize(address, port, config, status, logger)
+        @status   = status
+        @logger   = logger
+        @previous = Time.now.to_f
+      end
+
+      def run(options = {})
+        interval = options[:window] || 60
+        EM::Synchrony.add_periodic_timer(interval) do
+          current = latency
+          status[:reactor] = {
+            latency: current,
+            ratio:   (current / interval).round(6),
+          }
+          report status
+        end
+      end
+      
+      def latency
+        snapshot = Time.now.to_f
+        laten = snapshot - previous
+        @previous = snapshot
+        laten
+      end
+      
+      def report metric
+        logger.debug metric
+      end
+    end
+  end
+end

data/lib/goliath/chimp/rack/env_extractor.rb

@@ -0,0 +1,26 @@
+module Goliath::Chimp
+  module Rack
+    module EnvExtractor
+      
+      # Helper method for extracting potentially nested
+      # values from the env hash. Also normalizes
+      # string vs. symbol access.
+      #
+      def extract_from_env(env, key, default = nil)
+        return default unless env.is_a? Hash
+        case key
+        when String, Symbol
+          env[key.to_s] || env[key.to_sym] || default
+        when Array
+          slice = env[key.shift]
+          key.empty? ? slice : extract_from_env(slice, key)
+        when Hash
+          extract_from_env(env, key.to_a.flatten)
+        else
+          default
+        end
+      end
+
+    end
+  end
+end

data/lib/goliath/chimp/rack/server_metrics.rb

@@ -0,0 +1,38 @@
+module Goliath::Chimp
+  module Rack
+    class ServerMetrics
+      include Goliath::Rack::AsyncMiddleware
+      include EnvExtractor
+
+      attr_reader :path, :env_key, :default
+
+      def initialize(app, options = {})
+        @app     = app
+        @path    = options[:path]    || '/metrics'
+        @env_key = options[:env_key]
+        @default = options[:default] || '/*'
+      end
+
+      def call env
+        if env['PATH_INFO'] == path
+          [ 200, {}, env['status'] ]
+        else
+          super
+        end
+      end
+
+      def post_process(env, status, headers, body)
+        base_metrics = { count: 0, total_millis: 0 }
+        env['status'][:requests] ||= Hash.new{ |h, k| h[k] = Hash.new{ |h, k| h[k] = base_metrics } }
+        request_key    = extract_from_env(env, env_key, default)
+        request_method = env['REQUEST_METHOD'].downcase.to_sym
+        metrics = env['status'][:requests][request_key][request_method]
+        metrics[:count] += 1
+        elapsed_millis = ((Time.now.to_f - env[:start_time]) * 1000).round
+        metrics[:total_millis] += elapsed_millis
+        [status, headers, body]        
+      end
+
+    end
+  end
+end

data/lib/goliath/chimp/version.rb

@@ -1,5 +1,5 @@
 module Goliath
   module Chimp
-    VERSION = '0.0.1'
+    VERSION = '0.0.2'
   end
 end

data/spec/plugins/activity_monitor_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe Goliath::Chimp::Plugin::ActivityMonitor do
+
+  let(:log_output)  { StringIO.new }
+  let(:logger)      { Logger.new log_output }
+  let(:example_time){ Time.new(2014, 1, 1, 3, 15) }
+  subject(:monitor) { described_class.new('localhost', 3467, {}, {}, logger) }
+
+  before(:each){ Time.stub(:now).and_return(example_time, example_time + 30) }
+
+  context '#run' do
+    it 'establishes a periodic latency monitor' do
+      EM.synchrony do
+        monitor.should_receive(:report).with(reactor: { latency: 30.0, ratio: 300.0 })
+        monitor.run(window: 0.1)
+        EM::Synchrony.add_timer(0.2){ EM.stop }
+      end
+    end
+  end
+
+  context '#latency' do
+    it 'returns the latency' do
+      monitor.latency.should eq(30.0)
+    end
+
+    it 'updates the previous snapshot' do
+      expect{ monitor.latency }.to change{ monitor.previous }.from(example_time.to_f).to((example_time + 30).to_f)
+    end
+  end
+
+  context '#report' do
+    it 'logs the metric' do
+      monitor.logger.should_receive(:debug).with('metrics')
+      monitor.report 'metrics'
+    end
+  end
+end

data/spec/rack/env_extractor_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+
+describe Goliath::Chimp::Rack::EnvExtractor do
+
+  subject do
+    extractor_mod = described_class
+    example_class = Class.new{ include extractor_mod }
+    example_class.new
+  end
+
+  context '#extract_from_env' do
+    context 'default' do
+      let(:env){ Hash.new }
+      
+      it 'returns the default value when key is not found' do
+        subject.extract_from_env(env, 'foo', 'default').should eq('default')
+      end      
+    end
+
+    context String do
+      let(:env){ { 'foo' => 'bar' } }
+      
+      it 'extracts the value using the string as a key' do
+        subject.extract_from_env(env, 'foo').should eq('bar')
+        subject.extract_from_env(env, 'bar').should be_nil
+      end
+
+      it 'extracts symbolic values' do
+        env = { foo: 'bar' }
+        subject.extract_from_env(env, 'foo').should eq('bar')
+      end
+    end
+
+    context Symbol do
+      let(:env){ { foo: 'bar' } }
+
+      it 'extracts the value using the symbol as a key' do
+        subject.extract_from_env(env, :foo).should eq('bar')
+        subject.extract_from_env(env, :bar).should be_nil
+      end
+      
+      it 'extracts string values' do
+        env = { 'foo' => 'bar' }
+        subject.extract_from_env(env, :foo).should eq('bar')
+      end
+    end
+
+    context Array do
+      let(:env){ { foo: { bar: 'baz' } } }
+      
+      it 'extracts the value using the array as a set of keys' do
+        subject.extract_from_env(env, [:foo, :bar]).should eq('baz')
+        subject.extract_from_env(env, [:bar, :foo]).should be_nil
+      end
+    end
+
+    context Hash do
+      let(:env){ { foo: { bar: 'baz' } } }
+
+      it 'extracts the value using the hash as a set of keys' do
+        subject.extract_from_env(env, { foo: :bar }).should eq('baz')
+        subject.extract_from_env(env, { bar: :foo }).should be_nil
+      end
+    end
+
+    context 'other' do
+      let(:env){ Hash.new }
+
+      it 'returns the default if given an invalid key' do
+        subject.extract_from_env(env, 123, 'default').should eq('default')
+      end
+    end
+  end
+end

data/spec/rack/server_metrics_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe Goliath::Chimp::Rack::ServerMetrics do
+
+  let(:app)         { double :app }
+  let(:status)      { Hash.new }
+  let(:example_time){ Time.new(2014, 1, 1, 3, 15) }
+  let(:env)         { { 'status' => status, endpoint: 'images', start_time: example_time.to_f } }
+  subject           { described_class.new(app, env_key: 'endpoint') }
+
+  context '#call', 'when /metrics' do
+    it 'does not call the app' do
+      app.should_not_receive(:call)
+      env['PATH_INFO'] = '/metrics'
+      subject.call env      
+    end
+
+    it 'returns the current status' do
+      env['PATH_INFO'] = '/metrics'
+      subject.call(env).should eq([200, {}, status])
+    end
+  end
+
+  context '#call', 'when /^version' do
+    it 'does nothing' do
+      app.should_receive(:call)
+      subject.should_receive(:post_process)
+      env['PATH_INFO'] = '/foobar'
+      subject.call env
+    end
+  end
+
+  context '#post_process' do
+    it 'does not alter the response' do
+      env['REQUEST_METHOD'] = 'GET'
+      subject.post_process(env, 200, {}, {}).should eq([200, {}, {}])
+    end
+
+    it 'attaches request metrics to the status' do
+      env['REQUEST_METHOD'] = 'GET'
+      Time.stub(:now).and_return(example_time + 30)
+      subject.post_process(env, 200, {}, {})
+      status.should eq(requests: { 'images' => { get: { count: 1, total_millis: 30000 } } })
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,3 +1,6 @@
+require 'logger'
+require 'stringio'
+
 if ENV['RACK_COVERAGE']
   require 'simplecov'
   SimpleCov.start

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: goliath-chimp
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-30 00:00:00.000000000 Z
+date: 2014-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: goliath
@@ -80,19 +80,25 @@ files:
 - goliath-chimp.gemspec
 - lib/goliath/chimp.rb
 - lib/goliath/chimp/handler.rb
+- lib/goliath/chimp/plugins/activity_monitor.rb
 - lib/goliath/chimp/rack/api_version.rb
 - lib/goliath/chimp/rack/control_methods.rb
+- lib/goliath/chimp/rack/env_extractor.rb
 - lib/goliath/chimp/rack/force_content_type.rb
 - lib/goliath/chimp/rack/formatters/json.rb
+- lib/goliath/chimp/rack/server_metrics.rb
 - lib/goliath/chimp/rack/validation/required_routes.rb
 - lib/goliath/chimp/rack/validation/route_handler.rb
 - lib/goliath/chimp/rack/validation/routes.rb
 - lib/goliath/chimp/version.rb
 - spec/handler_spec.rb
+- spec/plugins/activity_monitor_spec.rb
 - spec/rack/api_version_spec.rb
 - spec/rack/control_methods_spec.rb
+- spec/rack/env_extractor_spec.rb
 - spec/rack/force_content_type_spec.rb
 - spec/rack/formatters/json_spec.rb
+- spec/rack/server_metrics_spec.rb
 - spec/rack/validations/required_routes_spec.rb
 - spec/rack/validations/route_handler_spec.rb
 - spec/rack/validations/routes_spec.rb
@@ -112,7 +118,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3557348802184007792
+      hash: 3845754265470155617
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -121,7 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3557348802184007792
+      hash: 3845754265470155617
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -130,10 +136,13 @@ specification_version: 3
 summary: Collection of Chimp-inspired Goliath/Rack utility classes
 test_files:
 - spec/handler_spec.rb
+- spec/plugins/activity_monitor_spec.rb
 - spec/rack/api_version_spec.rb
 - spec/rack/control_methods_spec.rb
+- spec/rack/env_extractor_spec.rb
 - spec/rack/force_content_type_spec.rb
 - spec/rack/formatters/json_spec.rb
+- spec/rack/server_metrics_spec.rb
 - spec/rack/validations/required_routes_spec.rb
 - spec/rack/validations/route_handler_spec.rb
 - spec/rack/validations/routes_spec.rb