hoover 0.0.5 → 0.0.6

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## Version 0.0.6 - Oct 26, 2011
+
+* Remove ActionView log subscriber contents (not useful to me, and triggers the loggly hash-in-array bug)
+* Polish and specs for ActionController, ActiveResource, and ActionMailer log subscribers (derived from live test
+  against Rails 3.0.9
+* Send an INFO message to main Rails logger so you can see what was sent to Loggly
+
 ## Version 0.0.5 - Oct 24, 2011
 
 * Sanitize hash objects coming in instead of relying on implicit to_json which sometimes crashes.

data/README.md

@@ -17,6 +17,12 @@ If you are using Rails 3, then there are prewritten log subscribers that pass mo
 the normal rails log in a simplified and convenient JSON format.
 
 
+## Requirements
+
+Hoover is designed to work w/ Ruby 1.8.7 or 1.9.2+ and any Rack framework.  That said, it has been developed under Rails
+3.0.9 with 1.8.7.  Other Rack frameworks are probably pretty rough at this point (but please send suggestions!).
+
+
 ## Installation
 
 You're using bundler right?
@@ -54,12 +60,19 @@ If you add with the same key more than once, Hoover automatically rolls it up in
 
 ## Todo
 
+* Provide sensible defaults for generic Rack logging.  Any ideas?
 * Provide config option to set the logglier during Rails initialization, thus guaranteeing its presence beyond what is
   possible with simple ActionController filters.
-* Write specs for Rails components.
 * Provide config option to choose which log subscribers to enable.
 
 
+## Known Issues
+
+* As of this writing, Loggly's JSON API does not handle hashes nested inside arrays properly.  Each hash ends up looking
+  like [object Object] in the search console.  This totally breaks Hoover's automatic stacking of duplicate adds, but
+  hopefully they'll have it fixed soon.
+
+
 ## Contributing to Hoover
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet

data/hoover.gemspec

@@ -17,10 +17,11 @@ Gem::Specification.new do |s|
 
   s.require_paths = [%q{lib}]
 
-  s.add_dependency "logglier", ["~> 0.2.6"]
+  s.add_dependency "logglier", ["~> 0.2.5"]
 
   s.add_development_dependency "bundler"
   s.add_development_dependency "rake"
   s.add_development_dependency "minitest"
   s.add_development_dependency "mocha"
+  s.add_development_dependency "rails", ["~> 3.1.0"]
 end

data/lib/hoover.rb

@@ -3,6 +3,12 @@ require 'hoover/job'
 require 'hoover/railtie' if defined?(Rails)
 
 module Hoover
+  autoload :ActionControllerLogSubscriber, 'hoover/log_subscribers/action_controller_log_subscriber'
+  autoload :ActionMailerLogSubscriber, 'hoover/log_subscribers/action_mailer_log_subscriber'
+  autoload :ActionViewLogSubscriber, 'hoover/log_subscribers/action_view_log_subscriber'
+  autoload :ActiveResourceLogSubscriber, 'hoover/log_subscribers/active_resource_log_subscriber'
+  autoload :ActiveRecordLogSubscriber, 'hoover/log_subscribers/active_record_log_subscriber'
+
   class << self
     def init(logglier = nil)
       self.active_job = Job.new(logglier)
@@ -25,6 +31,11 @@ module Hoover
       active_job.add(*args)
     end
 
+    def hash(*args)
+      raise "Must init Hoover before calling hash" unless active_job
+      active_job.hash
+    end
+
     def logglier=(logglier)
       raise "Must init Hoover before setting logglier" unless active_job
       active_job.logglier = logglier

data/lib/hoover/job.rb

@@ -25,6 +25,7 @@ module Hoover
     def post
       raise "cannot post until logglier is set" unless ready_to_post?
       @hash.each{ |k,v| @hash[k] = @hash[k].first if v.size == 1 }
+      Rails.logger.info "  Hoover sending keys #{@hash.keys.inspect} to Loggly" if defined?(Rails) && Rails.logger
       @logglier.info(@hash)
     end
 
@@ -42,7 +43,7 @@ module Hoover
 
     def sanitize_object(value)
       case value
-      when String, Fixnum, Date, Time, NilClass
+      when String, Fixnum, Float, Date, Time, NilClass
         value
       else
         value.to_s

data/lib/hoover/log_subscribers/action_controller_log_subscriber.rb

@@ -1,3 +1,6 @@
+require 'action_controller'
+require 'active_support/core_ext/hash/except'
+
 module Hoover
   class ActionControllerLogSubscriber < ActiveSupport::LogSubscriber
     INTERNAL_PARAMS = %w(controller action format _method only_path)
@@ -16,26 +19,32 @@ module Hoover
       payload   = event.payload
       additions = ActionController::Base.log_process_action(payload)
 
+      runtimes  = additions.inject({}) do |hash, string|
+        name, time = string.split(':')
+        hash[name] = time.to_f
+        hash
+      end
+
       status = payload[:status]
       if status.nil? && payload[:exception].present?
         status = Rack::Utils.status_code(ActionDispatch::ShowExceptions.rescue_responses[payload[:exception].first]) rescue nil
       end
 
-      Hoover.add(:status => "#{status} #{Rack::Utils::HTTP_STATUS_CODES[status]}",
-                 :duration => "%.0f" % event.duration)
-      Hoover.add :additions => additions.join(" | ") unless additions.blank?
+      Hoover.add(:status => status,
+                 :duration => event.duration)
+      Hoover.add :runtimes => runtimes unless runtimes.blank?
     end
 
     def send_file(event)
-      Hoover.add(:sent_file, "%s (%.1fms)" % [event.payload[:path], event.duration])
+      Hoover.add(:sent_file => { :path => event.payload[:path], :runtime => event.duration })
     end
 
     def redirect_to(event)
-      Hoover.add(:redirected_to, event.payload[:location])
+      Hoover.add(:redirected_to => event.payload[:location])
     end
 
     def send_data(event)
-      Hoover.add(:sent_data, "%s (%.1fms)" % [event.payload[:filename], event.duration])
+      Hoover.add(:sent_data => { :filename => event.payload[:filename], :runtime => event.duration })
     end
 
     %w(write_fragment read_fragment exist_fragment?
@@ -43,8 +52,7 @@ module Hoover
       class_eval <<-METHOD, __FILE__, __LINE__ + 1
         def #{method}(event)
           key_or_path = event.payload[:key] || event.payload[:path]
-          human_name  = #{method.to_s.humanize.inspect}
-          Hoover.add(method.to_sym, "\#{key_or_path} (%.1fms)" % event.duration)
+          Hoover.add(#{method.to_sym.inspect} => { :key => key_or_path, :runtime => event.duration })
         end
       METHOD
     end

data/lib/hoover/log_subscribers/action_mailer_log_subscriber.rb

@@ -2,8 +2,8 @@ module Hoover
   class ActionMailerLogSubscriber < ActiveSupport::LogSubscriber
     def deliver(event)
       recipients = Array.wrap(event.payload[:to])
-      Hoover.add(:sent_mail_to, recipients)
-      Hoover.add(:sent_mail_duration, "%1.f" % event.duration)
+      Hoover.add(:sent_mail_to => recipients)
+      Hoover.add(:sent_mail_duration => event.duration)
     end
   end
 end

data/lib/hoover/log_subscribers/action_view_log_subscriber.rb

@@ -1,19 +1,5 @@
 module Hoover
   class ActionViewLogSubscriber < ActiveSupport::LogSubscriber
-    def render_template(event)
-      rendered = { :identifier => from_rails_root(event.payload[:identifier]),
-                   :duration => event.duration }
-      rendered[:layout] = from_rails_root(event.payload[:layout]) if event.payload[:layout]
-
-      Hoover.add :rendered => rendered
-    end
-    alias :render_partial :render_template
-    alias :render_collection :render_template
-
-  protected
-
-    def from_rails_root(string)
-      string.sub("#{Rails.root}/", "").sub(/^app\/views\//, "")
-    end
+    # I have no need to log this to Loggly, implementations welcome.
   end
 end

data/lib/hoover/log_subscribers/active_resource_log_subscriber.rb

@@ -4,7 +4,7 @@ module Hoover
       result = event.payload[:result]
       request = { :method => event.payload[:method].to_s.upcase,
                   :request_uri => event.payload[:request_uri],
-                  :result_code => result.code,
+                  :result_code => result.code.to_i,
                   :result_message => result.message,
                   :result_length => result.body.to_s.length,
                   :duration => event.duration }

data/lib/hoover/rack_logger.rb

@@ -22,6 +22,7 @@ module Hoover
         Hoover.add :method => request.request_method,
                    :path => request.filtered_path
       else
+        # TODO: Figure out sane logging defaults for the average rack app and make this configurable
         Hoover.add env
       end
 

data/lib/hoover/railtie.rb

@@ -1,10 +1,4 @@
 module Hoover
-  autoload :ActionControllerLogSubscriber, 'hoover/log_subscribers/action_controller_log_subscriber'
-  autoload :ActionMailerLogSubscriber, 'hoover/log_subscribers/action_mailer_log_subscriber'
-  autoload :ActionViewLogSubscriber, 'hoover/log_subscribers/action_view_log_subscriber'
-  autoload :ActiveResourceLogSubscriber, 'hoover/log_subscribers/active_resource_log_subscriber'
-  autoload :ActiveRecordLogSubscriber, 'hoover/log_subscribers/active_record_log_subscriber'
-
   class Railtie < Rails::Railtie
     def self.all_rails_log_subscribers
       [:action_controller, :action_mailer, :action_view, :active_resource, :active_record]

data/lib/hoover/version.rb

@@ -1,3 +1,3 @@
 module Hoover
-  VERSION = '0.0.5'
+  VERSION = '0.0.6'
 end

data/spec/action_controller_log_subscrier_spec.rb

@@ -0,0 +1,177 @@
+require 'helper'
+require 'rails'
+
+describe Hoover::ActionControllerLogSubscriber do
+  before do
+    Hoover.init
+    @subscriber = Hoover::ActionControllerLogSubscriber.new
+  end
+
+  describe "start_processing" do
+    before do
+      @subscriber.start_processing(start_processing_stub)
+    end
+
+    it "sets controller" do
+      Hoover.hash[:controller].first.must_equal "AboutController"
+    end
+
+    it "sets action" do
+      Hoover.hash[:action].first.must_equal "index"
+    end
+
+    it "sets params" do
+      Hoover.hash[:params].first.must_equal "with_param" => "1"
+    end
+
+    it "sets format" do
+      Hoover.hash[:format].first.must_equal "HTML"
+    end
+  end
+
+  describe "process_action" do
+    before do
+      @subscriber.process_action(process_action_stub)
+    end
+
+    it "sets status" do
+      Hoover.hash[:status].first.must_equal 200
+    end
+
+    it "sets duration" do
+      Hoover.hash[:duration].first.must_equal 475.987
+    end
+
+    it "sets runtimes" do
+      Hoover.hash[:runtimes].first.must_equal "Views" => 138.4
+    end
+  end
+
+  describe "send_file" do
+    before do
+      @subscriber.send_file(send_file_stub)
+    end
+
+    it "sets sent_file" do
+      Hoover.hash[:sent_file].first.must_equal :path => '/apath', :runtime => 100.1
+    end
+  end
+
+  describe "redirect_to" do
+    before do
+      @subscriber.redirect_to(redirect_to_stub)
+    end
+
+    it "sets sent_file" do
+      Hoover.hash[:redirected_to].first.must_equal '/newlocation'
+    end
+  end
+
+  describe "send_data" do
+    before do
+      @subscriber.send_data(send_data_stub)
+    end
+
+    it "sets sent_data" do
+      Hoover.hash[:sent_data].first.must_equal :filename => 'somefile.txt', :runtime => 200.1
+    end
+  end
+
+  describe "write_fragment" do
+    before do
+      @subscriber.write_fragment(fragment_stub)
+    end
+
+    it "sets write_fragment" do
+      Hoover.hash[:write_fragment].first.must_equal :key => 'thefrag', :runtime => 123.1
+    end
+  end
+
+  describe "read_fragment" do
+    before do
+      @subscriber.read_fragment(fragment_stub)
+    end
+
+    it "sets read_fragment" do
+      Hoover.hash[:read_fragment].first.must_equal :key => 'thefrag', :runtime => 123.1
+    end
+  end
+
+  describe "exist_fragment" do
+    before do
+      @subscriber.exist_fragment?(fragment_stub)
+    end
+
+    it "sets exist_fragment" do
+      Hoover.hash[:exist_fragment?].first.must_equal :key => 'thefrag', :runtime => 123.1
+    end
+  end
+
+  describe "expire_fragment" do
+    before do
+      @subscriber.expire_fragment(fragment_stub)
+    end
+
+    it "sets expire_fragment" do
+      Hoover.hash[:expire_fragment].first.must_equal :key => 'thefrag', :runtime => 123.1
+    end
+  end
+
+  describe "expire_page" do
+    before do
+      @subscriber.expire_page(page_stub)
+    end
+
+    it "sets expire_page" do
+      Hoover.hash[:expire_page].first.must_equal :key => '/thepath', :runtime => 124.1
+    end
+  end
+
+  private
+
+  def start_processing_stub
+    payload = { :controller => "AboutController", :action => "index", :path => "/about?with_param=1",
+                 :params => { "with_param" => "1", "action" => "index", "controller" => "about" },
+                 :formats => [:html], :method=>"GET" }
+    duration = 0.005
+    stub(:payload => payload, :duration => duration)
+  end
+
+  def process_action_stub
+    payload = { :controller => "AboutController", :action => "index", :status => 200,
+                 :params => { "with_param" => "1", "action" => "index", "controller" => "about" },
+                 :path => "/about?with_param=1", :formats => [:html], :method => "GET",
+                 :query_runtime => 0, :db_runtime => 4.542, :view_runtime => 138.39879927063 }
+    duration = 475.987
+    stub(:payload => payload, :duration => duration)
+  end
+
+  def send_file_stub
+    payload = { :path => '/apath' }
+    duration = 100.1
+    stub(:payload => payload, :duration => duration)
+  end
+
+  def redirect_to_stub
+    payload = { :location => '/newlocation' }
+    stub(:payload => payload)
+  end
+
+  def send_data_stub
+    payload = { :filename => 'somefile.txt' }
+    duration = 200.1
+    stub(:payload => payload, :duration => duration)
+  end
+
+  def fragment_stub
+    payload = { :key => 'thefrag' }
+    duration = 123.1
+    stub(:payload => payload, :duration => duration)
+  end
+
+  def page_stub
+    payload = { :path => '/thepath' }
+    duration = 124.1
+    stub(:payload => payload, :duration => duration)
+  end
+end

data/spec/action_mailer_log_subscriber_spec.rb

@@ -0,0 +1,26 @@
+require 'helper'
+require 'rails'
+
+describe Hoover::ActionMailerLogSubscriber do
+  before do
+    Hoover.init
+    @subscriber = Hoover::ActionMailerLogSubscriber.new
+  end
+
+  describe 'deliver' do
+    before do
+      @subscriber.deliver(deliver_stub)
+    end
+
+    it "sets sent_mail_to" do
+      Hoover.hash[:sent_mail_to].first.must_equal ['email@example.com']
+    end
+  end
+  private
+
+  def deliver_stub
+    payload = { :to => 'email@example.com' }
+    duration = 1.1
+    stub(:payload => payload, :duration => duration)
+  end
+end

data/spec/active_resource_log_subscriber_spec.rb

@@ -0,0 +1,47 @@
+require 'helper'
+require 'rails'
+
+describe Hoover::ActiveResourceLogSubscriber do
+  before do
+    Hoover.init
+    @subscriber = Hoover::ActiveResourceLogSubscriber.new
+  end
+
+  describe 'request' do
+    before do
+      @subscriber.request(request_stub)
+    end
+
+    it "sets method" do
+      Hoover.hash[:active_resource_request].first[:method].must_equal 'GET'
+    end
+
+    it "sets request_uri" do
+      Hoover.hash[:active_resource_request].first[:request_uri].must_equal 'http://localhost/test.xml'
+    end
+
+    it "sets result_code" do
+      Hoover.hash[:active_resource_request].first[:result_code].must_equal 200
+    end
+
+    it "sets result_message" do
+      Hoover.hash[:active_resource_request].first[:result_message].must_equal 'OK'
+    end
+
+    it "sets result_length" do
+      Hoover.hash[:active_resource_request].first[:result_length].must_equal 4
+    end
+
+    it "sets duration" do
+      Hoover.hash[:active_resource_request].first[:duration].must_equal 21.12
+    end
+  end
+  private
+
+  def request_stub
+    result = stub(:code => '200', :message => 'OK', :body => 'body')
+    payload = { :method => :get, :result => result, :request_uri => "http://localhost/test.xml" }
+    duration = 21.12
+    stub(:payload => payload, :duration => duration)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hoover
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,22 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-24 00:00:00.000000000Z
+date: 2011-10-26 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logglier
-  requirement: &70110723980740 !ruby/object:Gem::Requirement
+  requirement: &70138783509820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.2.6
+        version: 0.2.5
   type: :runtime
   prerelease: false
-  version_requirements: *70110723980740
+  version_requirements: *70138783509820
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70110723980320 !ruby/object:Gem::Requirement
+  requirement: &70138783509400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70110723980320
+  version_requirements: *70138783509400
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70110723979860 !ruby/object:Gem::Requirement
+  requirement: &70138783508940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70110723979860
+  version_requirements: *70138783508940
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &70110723979440 !ruby/object:Gem::Requirement
+  requirement: &70138783508520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70110723979440
+  version_requirements: *70138783508520
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70110723979020 !ruby/object:Gem::Requirement
+  requirement: &70138770853240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,18 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70110723979020
+  version_requirements: *70138770853240
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &70138770852720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: *70138770852720
 description: Sets up a hash at the beginning of each request and flushes it to Loggly
   at the end of the request.  Also comes with standard Rails 3 log subscribers.
 email:
@@ -93,6 +104,9 @@ files:
 - lib/hoover/rack_logger.rb
 - lib/hoover/railtie.rb
 - lib/hoover/version.rb
+- spec/action_controller_log_subscrier_spec.rb
+- spec/action_mailer_log_subscriber_spec.rb
+- spec/active_resource_log_subscriber_spec.rb
 - spec/helper.rb
 - spec/hoover_spec.rb
 - spec/job_spec.rb
@@ -123,6 +137,9 @@ specification_version: 3
 summary: Rack-based support for collecting a single hash per request to be sent to
   Loggly
 test_files:
+- spec/action_controller_log_subscrier_spec.rb
+- spec/action_mailer_log_subscriber_spec.rb
+- spec/active_resource_log_subscriber_spec.rb
 - spec/helper.rb
 - spec/hoover_spec.rb
 - spec/job_spec.rb