maiha-request_id 0.1 → 0.1.1

data/README

@@ -7,17 +7,40 @@ Rails plugin that adds a new method (Controller#request_id) to distinguish reque
 Methods
 =======
 
-ActionController::Base#request_id
+* ActionController::Base#request_id
+
+  => "3000:1"   # request_id_with_port is true
+  => "1"        # request_id_with_port is false
+
+
+Configurations
+==============
+
+* ActionController::Base.request_id_with_port
+
+  Indicates whether request_id needs port number or not.
+  It is useful under clustered servers. This is true, by default.
 
 
 Log
 ===
 
+* Request ID field is automatically added into log file
+
 Processing UserController#index (for 127.0.0.1 at 2008-11-16 21:30:00) [GET]
-  Request ID: 1 (port:3000)
-  Session ID: 2e324cf7ff9737194a07911cdbf323b0
-  Parameters: {"action"=>"index", "controller"=>"user"}
+  Request ID: 3000:1
+
+Processing UserController#index (for 127.0.0.1 at 2008-11-16 21:30:05) [GET]
+  Request ID: 3000:2
+
+
+Note
+====
+
+* request_id is reset when the server restarts
 
+* backend_port is used as port number only on Mongrel server, otherwise frontend_port is used.
+  Anyone know how to detect backend port number on Lighttpd, WEBrick and Thin?
 
 
 Copyright (c) 2008 maiha@wota.jp, released under the MIT license

data/lib/request_id.rb

@@ -1,17 +1,48 @@
 module RequestId
   def self.included(base)
-    instance_methods = rails22?(base) ? Rails22 : Rails21
+    instance_methods = rails2x? ? Rails2x : Rails1x
     base.class_eval do
       cattr_accessor :max_request_id
+      cattr_accessor :request_id_with_port
+      self.request_id_with_port = true
       include instance_methods
     end
   end
 
-  def self.rails22?(base)
-    base.instance_methods.include?("log_processing_for_request_id")
+  def self.rails2x?
+    ActionController::Base.private_instance_methods.include?("log_processing_for_request_id")
   end
 
-  module Rails21
+  def request_id
+    @request_id ||= new_request_id
+  end
+
+  private
+    def new_request_id
+      id = self.class.max_request_id = self.class.max_request_id.to_i + 1
+      if self.class.request_id_with_port
+        port = backend_port || request.port
+        "#{port}:#{id}"
+      else
+        id.to_s
+      end
+    end
+
+    def backend_port
+      case request.cgi.class.name
+      when "Mongrel::CGIWrapper"
+        request.cgi.handler.listener.port rescue "unknown_mongrel"
+      when "Rack::Adapter::Rails::CGIWrapper"
+        # not implemented yet
+        nil
+      else
+        nil
+      end
+    rescue => error
+      logger.error "[request_id] backend_port error: #{error}" if logger
+    end
+
+  module Rails1x
     def self.included(base)
       base.class_eval do
         alias_method_chain :log_processing, :request_id
@@ -19,21 +50,17 @@ module RequestId
     end
 
     private
-      def request_id
-        @request_id ||= (self.class.max_request_id = self.class.max_request_id.to_i + 1)
-      end
-
       def log_processing_with_request_id
         if logger
           logger.info "\n\nProcessing #{controller_class_name}\##{action_name} (for #{request_origin}) [#{request.method.to_s.upcase}]"
-          logger.info "  Request ID: #{request_id} (port:#{request.port})"
+          logger.info "  Request ID: #{request_id}"
           logger.info "  Session ID: #{@_session.session_id}" if @_session and @_session.respond_to?(:session_id)
           logger.info "  Parameters: #{respond_to?(:filter_parameters) ? filter_parameters(params).inspect : params.inspect}"
         end
       end
   end
 
-  module Rails22
+  module Rails2x
     def self.included(base)
       base.class_eval do
         alias_method_chain :log_processing_for_request_id, :request_id
@@ -43,7 +70,7 @@ module RequestId
     private
       def log_processing_for_request_id_with_request_id
         log_processing_for_request_id_without_request_id
-        logger.info "  Request ID: #{request_id} (port:#{request.port})"
+        logger.info "  Request ID: #{request_id}"
       end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: maiha-request_id
 version: !ruby/object:Gem::Version 
-  version: "0.1"
+  version: 0.1.1
 platform: ruby
 authors: 
 - maiha
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-11-16 00:00:00 -08:00
+date: 2009-02-16 00:00:00 -08:00
 default_executable: 
 dependencies: []