time_bandits 0.3.1 → 0.4.0

data/lib/time_bandits/monkey_patches/action_controller.rb

@@ -5,7 +5,8 @@ module ActionController #:nodoc:
 
   module Instrumentation
 
-    # patch to ensure that the completed line is always written to the log
+    # patch to ensure that the completed line is always written to the log.
+    # this is not necessary anymore with rails 4.
     def process_action(action, *args)
 
       raw_payload = get_raw_payload
@@ -25,9 +26,9 @@ module ActionController #:nodoc:
       end
       raise exception if exception
       result
-    end
+    end unless Rails::VERSION::STRING =~ /\A4\./
 
-    # patch to ensure that render times are always recorded in the log
+    # patch to ensure that render times are always recorded in the log.
     def render(*args)
       render_output = nil
       exception = nil
@@ -53,7 +54,7 @@ module ActionController #:nodoc:
 
     private
 
-    if Rails::VERSION::STRING =~ /^3\.[01]/
+    if Rails::VERSION::STRING =~ /\A3\.[01]/
       def get_raw_payload
         {
           :controller => self.class.name,
@@ -64,7 +65,7 @@ module ActionController #:nodoc:
           :path       => (request.fullpath rescue "unknown")
         }
       end
-    elsif Rails::VERSION::STRING =~ /^3\.2/
+    elsif Rails::VERSION::STRING =~ /\A3\.2/
       def get_raw_payload
         {
           :controller => self.class.name,
@@ -75,11 +76,12 @@ module ActionController #:nodoc:
           :path       => (request.fullpath rescue "unknown")
         }
       end
-    else
+    elsif Rails::VERSION::STRING !~ /\A4\.0/
       raise "time_bandits ActionController monkey patch is not compatible with your Rails version"
     end
 
     module ClassMethods
+      # patch to log rendering time with more precision
       def log_process_action(payload) #:nodoc:
         messages, view_runtime = [], payload[:view_runtime]
         messages << ("Views: %.3fms" % view_runtime.to_f) if view_runtime
@@ -89,6 +91,8 @@ module ActionController #:nodoc:
   end
 
   class LogSubscriber
+    # the original method logs the completed line.
+    # but we do it in the middleware.
     def process_action(event)
       payload   = event.payload
       additions = ActionController::Base.log_process_action(payload)
@@ -99,6 +103,7 @@ module ActionController #:nodoc:
     end
   end
 
+  # this gets included in ActionController::Base
   module TimeBanditry #:nodoc:
     extend ActiveSupport::Concern
 

data/lib/time_bandits/rack/logger.rb

@@ -1,34 +1,59 @@
 module TimeBandits
   module Rack
     class Logger < ActiveSupport::LogSubscriber
-      # TODO: how to deal with tags
-      def initialize(app, tags=nil)
+      def initialize(app, taggers=nil)
         @app = app
+        @taggers = taggers || Rails.application.config.log_tags || []
       end
 
       def call(env)
+        request = ActionDispatch::Request.new(env)
+
+        if logger.respond_to?(:tagged) && !@taggers.empty?
+          logger.tagged(compute_tags(request)) { call_app(request, env) }
+        else
+          call_app(request, env)
+        end
+      end
+
+      protected
+
+      def call_app(request, env)
         start_time = Time.now
-        before_dispatch(env, start_time)
+        before_dispatch(request, env, start_time)
         result = @app.call(env)
       ensure
         run_time = Time.now - start_time
         after_dispatch(env, result, run_time)
       end
 
-      protected
-      def before_dispatch(env, start_time)
+      def compute_tags(request)
+        @taggers.collect do |tag|
+          case tag
+          when Proc
+            tag.call(request)
+          when Symbol
+            request.send(tag)
+          else
+            tag
+          end
+        end
+      end
+
+      def before_dispatch(request, env, start_time)
         TimeBandits.reset
         Thread.current.thread_variable_set(:time_bandits_completed_info, nil)
 
-        request = ActionDispatch::Request.new(env)
         path = request.filtered_path
 
-        info "\n\nStarted #{request.request_method} \"#{path}\" for #{request.ip} at #{start_time.to_default_s}"
+        debug ""
+        info "Started #{request.request_method} \"#{path}\" for #{request.ip} at #{start_time.to_default_s}"
       end
 
       def after_dispatch(env, result, run_time)
-        status = result ? result.first : 500
-        duration, additions, view_time, action = Thread.current.thread_variable_get(:time_bandits_completed_info)
+        status = result ? result.first.to_i : 500
+        completed_info = Thread.current.thread_variable_get(:time_bandits_completed_info)
+        additions = completed_info[1] if completed_info
 
         message = "Completed #{status} #{::Rack::Utils::HTTP_STATUS_CODES[status]} in %.1fms" % (run_time*1000)
         message << " (#{additions.join(' | ')})" unless additions.blank?

data/lib/time_bandits/rack/logger40.rb

@@ -0,0 +1,94 @@
+require 'active_support/core_ext/time/conversions'
+require 'active_support/core_ext/object/blank'
+require 'active_support/log_subscriber'
+require 'action_dispatch/http/request'
+require 'rack/body_proxy'
+
+module TimeBandits
+  module Rack
+    # Sets log tags, logs the request, calls the app, and flushes the logs.
+    class Logger < ActiveSupport::LogSubscriber
+      def initialize(app, taggers = nil)
+        @app          = app
+        @taggers      = taggers || Rails.application.config.log_tags || []
+        @instrumenter = ActiveSupport::Notifications.instrumenter
+      end
+
+      def call(env)
+        request = ActionDispatch::Request.new(env)
+
+        if logger.respond_to?(:tagged) && !@taggers.empty?
+          logger.tagged(compute_tags(request)) { call_app(request, env) }
+        else
+          call_app(request, env)
+        end
+      end
+
+    protected
+
+      def call_app(request, env)
+        start_time = Time.now
+        start(request, start_time)
+        resp = @app.call(env)
+        resp[2] = ::Rack::BodyProxy.new(resp[2]) { finish(request) }
+        resp
+      rescue
+        finish(request)
+        raise
+      ensure
+        completed(request, Time.now - start_time, resp)
+        ActiveSupport::LogSubscriber.flush_all!
+      end
+
+      # Started GET "/session/new" for 127.0.0.1 at 2012-09-26 14:51:42 -0700
+      def started_request_message(request, start_time=Time.now)
+        'Started %s "%s" for %s at %s' % [
+          request.request_method,
+          request.filtered_path,
+          request.ip,
+          start_time.to_default_s ]
+      end
+
+      def compute_tags(request)
+        @taggers.collect do |tag|
+          case tag
+          when Proc
+            tag.call(request)
+          when Symbol
+            request.send(tag)
+          else
+            tag
+          end
+        end
+      end
+
+      private
+
+      def start(request, start_time)
+        TimeBandits.reset
+        Thread.current.thread_variable_set(:time_bandits_completed_info, nil)
+        @instrumenter.start 'action_dispatch.request', request: request
+
+        logger.debug ""
+        logger.info started_request_message(request, start_time)
+      end
+
+      def completed(request, run_time, resp)
+        status = resp ? resp.first.to_i : 500
+        completed_info = Thread.current.thread_variable_get(:time_bandits_completed_info)
+        additions = completed_info[1] if completed_info
+        message = "Completed #{status} #{::Rack::Utils::HTTP_STATUS_CODES[status]} in %.1fms" % (run_time*1000)
+        message << " (#{additions.join(' | ')})" unless additions.blank?
+        logger.info message
+      end
+
+      def finish(request)
+        @instrumenter.finish 'action_dispatch.request', request: request
+      end
+
+      def logger
+        @logger ||= Rails.logger
+      end
+    end
+  end
+end

data/lib/time_bandits/railtie.rb

@@ -1,7 +1,11 @@
 module TimeBandits
 
   module Rack
-    autoload :Logger, 'time_bandits/rack/logger'
+    if Rails::VERSION::STRING >= "4.0"
+      autoload :Logger, 'time_bandits/rack/logger40'
+    else
+      autoload :Logger, 'time_bandits/rack/logger'
+    end
   end
 
   class Railtie < Rails::Railtie
@@ -9,6 +13,13 @@ module TimeBandits
     initializer "time_bandits" do |app|
       app.config.middleware.swap("Rails::Rack::Logger", "TimeBandits::Rack::Logger")
 
+      # rails 4 inserts Rack::Lock in development, but not in production.
+      # time bandits are not thread safe yet, so we insert the Rack::Lock middleware in production.
+      # TODO: make time_bandits thread safe
+      if Rails::VERSION::STRING >= "4.0" && Rails.env.production?
+        app.config.middleware.insert_after("Rack::Sendfile", "Rack::Lock")
+      end
+
       ActiveSupport.on_load(:action_controller) do
         require 'time_bandits/monkey_patches/action_controller'
         include ActionController::TimeBanditry

data/lib/time_bandits/version.rb

@@ -1,3 +1,3 @@
 module TimeBandits
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: time_bandits
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 15
   prerelease: 
   segments: 
   - 0
-  - 3
-  - 1
-  version: 0.3.1
+  - 4
+  - 0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Stefan Kaes
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-02-26 00:00:00 Z
+date: 2013-07-20 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: thread_variables
@@ -72,6 +72,7 @@ files:
 - lib/time_bandits/monkey_patches/memcache-client.rb
 - lib/time_bandits/monkey_patches/memcached.rb
 - lib/time_bandits/rack/logger.rb
+- lib/time_bandits/rack/logger40.rb
 - lib/time_bandits/railtie.rb
 - lib/time_bandits/time_consumers/database.rb
 - lib/time_bandits/time_consumers/database_rails2.rb