td-logger 0.2.4 → 0.2.5

data/ChangeLog

@@ -1,4 +1,13 @@
 
+== 2011-09-30 version 0.2.5
+
+* Use HTTP_X_FORWARDED_FOR instead of REMOTE_ADDR if it's available
+* Don't enable ActiveRecord extension unless defined?(ActiveRecord)
+* Ignore OPTIONS method
+* Use Symbol for keys of access log
+* Removed defined?(RAILS_ENV) and defined?(RAILS_ROOT) to suppress wornings
+
+
 == 2011-09-13 version 0.2.4
 
 * Increase flush_interval from 10 sec to 5 mins gradually

data/README.rdoc

@@ -20,7 +20,7 @@ And then add +config/treasure_data.yml+ file as following:
       access_log_table: access
       auto_create_table: true
     
-    # logging via td-agent
+    # logging via td-agent (fluent)
     production:
       agent: "localhost:24224"
       tag: td.myapp

data/lib/td/logger/agent/access_log.rb

@@ -4,8 +4,8 @@ module Logger
 module Agent
 
   ACCESS_LOG_PARAM_ENV =
-        if defined? Rails
-          if Rails.respond_to?(:version) && Rails.version =~ /^3/
+        if defined? ::Rails
+          if ::Rails.respond_to?(:version) && ::Rails.version =~ /^3/
             # Rails 3
             'action_dispatch.request.path_parameters'
           else
@@ -18,54 +18,62 @@ module Agent
         end
 
   ACCESS_LOG_PRESET_PARAM_KEYS = {
-    'controller' => :controller,
-    'action' => :action,
-  }
-
-  ACCESS_LOG_PRESET_ENV_KEYS = {
-    'ip'      => 'REMOTE_ADDR',
-    'method'  => 'REQUEST_METHOD',
-    'uri'     => 'REQUEST_URI',
-    'referer' => 'HTTP_REFERER',
-    'ua'      => 'HTTP_USER_AGENT'
+    :controller => :controller,
+    :action => :action,
   }
 
   def self.enable_access_log(tag)
     Middleware.before do |env|
-      data = {}
-      Thread.current['td.access_log'] = data
-      env['td.access_log'] = data
+      record = {}
+      Thread.current['td.access_log'] = record
+      env['td.access_log'] = record
       env['td.access_time'] = Time.now
     end
 
     Middleware.after do |env,result|
-      data = env['td.access_log'] || {}
-      access_time = env['td.access_time']
-
-      # add 'elapsed' column
-      if access_time
-        elapsed = Time.now - access_time
-        data['elapsed'] = elapsed
-        # set 'time' column to access time
-        data['time'] = access_time
+      req = env['action_dispatch.request']
+      if !req || !req.is_a?(Rack::Request)
+        req = Rack::Request.new(env)
       end
 
-      ACCESS_LOG_PRESET_ENV_KEYS.each_pair {|key,val|
-        data[key] ||= env[val] if env[val]
-      }
+      # ignore OPTIONS request
+      if req.request_method != "OPTIONS"
+        record = env['td.access_log'] || {}
+        access_time = env['td.access_time']
+
+        # add 'elapsed' column
+        if access_time
+          elapsed = Time.now - access_time
+          record[:elapsed] = elapsed
+          # set 'time' column to access time
+          record[:time] = access_time
+        end
+
+        record[:method] ||= req.request_method
+        record[:ip] ||= (env['action_dispatch.remote_ip'] || req.ip).to_s
+        record[:uri] ||= env['REQUEST_URI'].to_s if env['REQUEST_URI']
+        record[:referer] ||= env['HTTP_REFERER'].to_s if env['HTTP_REFERER']
+        record[:ua] ||= env['HTTP_USER_AGENT'].to_s if env['HTTP_USER_AGENT']
 
-      m = env[ACCESS_LOG_PARAM_ENV]
-      ACCESS_LOG_PRESET_PARAM_KEYS.each_pair {|key,val|
-        data[key] ||= m[val] if m[val]
-      }
+        m = env[ACCESS_LOG_PARAM_ENV]
+        ACCESS_LOG_PRESET_PARAM_KEYS.each_pair {|key,val|
+          record[key] ||= m[val] if m[val]
+        }
 
-      # result code
-      data['status'] ||= result[0].to_i
+        # result code
+        record[:status] ||= result[0].to_i
 
-      TreasureData.log(tag, data)
+        TreasureData.log(tag, record)
+      end
     end
   end
 
 end
 end
 end
+
+module TreasureData
+  def self.access_log
+    Thread.current['td.access_log']
+  end
+end

data/lib/td/logger/agent/rails/controller.rb

@@ -4,29 +4,35 @@ module Agent
   module Rails
 
     def self.init_controller
-      ms = ControllerMethods
-      modms = ControllerModuleMethods
-      ActionController::Base.class_eval do
-        include ms
-        extend modms
-      end
+      ActionController::Base.send(:include, ControllerExtension)
     end
 
-    module ControllerMethods
-      def td_access_log
-        request.env['td.access_log'] ||= {}
+    module ControllerExtension
+      if defined?(ActiveSupport::Concern)
+        # Rails 2
+        extend ActiveSupport::Concern
+      else
+        def self.included(mod)
+          im = InstanceMethods
+          cm = ClassMethods
+          mod.class_eval do
+            include im
+            extend cm
+          end
+        end
+      end
+
+      module InstanceMethods
+        def td_access_log
+          request.env['td.access_log'] ||= {}
+        end
       end
-    end
 
-    module ControllerModuleMethods
+      module ClassMethods
+      end
     end
 
   end
 end
 end
-
-def self.access_log
-  Thread.current['td.access_log']
-end
-
 end

data/lib/td/logger/agent/rails/model.rb

@@ -4,75 +4,94 @@ module Agent
   module Rails
 
     def self.init_model
-      ms = ModelMethods
-      modms = ModelModuleMethods
-      require 'active_record' unless defined?(ActiveRecord)
-      ActiveRecord::Base.class_eval do
-        include ms
-        extend modms
+      unless defined?(::ActiveRecord)
+        # disable model extension if Rails > 3 and
+        # ActiveRecord is not loaded (other ORM is used)
+        if ::Rails.respond_to?(:version) && ::Rails.version =~ /^3/
+          return
+        end
+        require 'active_record'
       end
+      ::ActiveRecord::Base.send(:include, ModelExtension)
     end
 
-    module ModelMethods
-    end
+    module ModelExtension
+      if defined?(ActiveSupport::Concern)
+        # Rails 2
+        extend ActiveSupport::Concern
+      else
+        def self.included(mod)
+          im = InstanceMethods
+          cm = ClassMethods
+          mod.class_eval do
+            include im
+            extend cm
+          end
+        end
+      end
 
-    module ModelModuleMethods
-      def td_enable_model_tracer(tag, options={})
-        only = nil
-        except = nil
-        static = {}
+      module InstanceMethods
+      end
 
-        if o = options[:only]
-          only = case o
-            when Array
-              o
-            else
-              [o]
-            end.map {|e| e.to_s }
-        end
+      module ClassMethods
+        def td_enable_model_tracer(tag, options={})
+          only = nil
+          except = nil
+          static = {}
 
-        if o = options[:except]
-          except = case o
-            when Array
-              o
-            else
-              [o]
-            end.map {|e| e.to_s }
-        end
+          if o = options[:only]
+            only = case o
+                   when Array
+                     o
+                   else
+                     [o]
+                   end.map {|e| e.to_s }
+          end
 
-        if o = options[:static]
-          o.each_pair {|k,v|
-            static[k.to_s] = v
-          }
-        end
+          if o = options[:except]
+            except = case o
+                     when Array
+                       o
+                     else
+                       [o]
+                     end.map {|e| e.to_s }
+          end
 
-        if defined?(after_commit)
-          # Rails 3
-          m = :after_commit
-        else
-          # Rails 2
-          m = :after_save
-        end
+          if o = options[:static]
+            o.each_pair {|k,v|
+              static[k.to_s] = v
+            }
+          end
+
+          if defined?(after_commit)
+            # Rails 3
+            m = :after_commit
+          else
+            # Rails 2
+            m = :after_save
+          end
 
-        __send__(m) do |record|
-          data = {}
-          record.attribute_names.each {|name|
-            name = name.to_s
-            if (!only || only.include?(name)) && (!except || !except.include?(name))
-              data[name] = record.read_attribute(name)
+          __send__(m) do |record|
+            data = {}
+            record.attribute_names.each {|name|
+              name = name.to_s
+              if (!only || only.include?(name)) && (!except || !except.include?(name))
+                data[name] = record.read_attribute(name)
+              end
+            }
+            static.each_pair {|k,v|
+              data[k] = v
+            }
+            if time = data['updated_at'] && time.is_a?(Time)
+              data['time'] = time.to_i
+              data.delete('updated_at')
             end
-          }
-          static.each_pair {|k,v|
-            data[k] = v
-          }
-          if time = data['updated_at'] && time.is_a?(Time)
-            data['time'] = time.to_i
-            data.delete('updated_at')
+            TreasureData.log(tag, data)
           end
-          TreasureData.log(tag, data)
         end
       end
     end
+
   end
 end
 end

data/lib/td/logger/agent/rails.rb

@@ -1,11 +1,6 @@
 module TreasureData
 module Logger
 module Agent
-  require 'td/logger/agent/middleware'
-  require 'td/logger/agent/access_log'
-  require 'td/logger/agent/rails/controller'
-  require 'td/logger/agent/rails/model'
-
   module Rails
 
     CONFIG_PATH = 'config/treasure_data.yml'
@@ -28,22 +23,6 @@ production:
 test:
 EOF
 
-    def self.rails_env
-      if defined?(RAILS_ENV) && RAILS_ENV.to_s != ''
-        RAILS_ENV.to_s
-      else
-        ::Rails.env
-      end
-    end
-    
-    def self.rails_root
-      if defined?(RAILS_ROOT) && RAILS_ROOT.to_s != ''
-        RAILS_ROOT.to_s
-      else
-        ::Rails.root
-      end
-    end
-
     class Config
       def initialize(conf)
         if agent = conf['agent']
@@ -97,14 +76,14 @@ EOF
         end
         return Config.new({
           'apikey' => apikey,
-          'database' => ENV['TREASURE_DATA_DB'] || "rails_#{rails_env}",
+          'database' => ENV['TREASURE_DATA_DB'] || "rails_#{::Rails.env}",
           'access_log_table' => ENV['TREASURE_DATA_TABLE'] || 'web_access',
           'auto_create_table' => true
         })
       end
 
       begin
-        src = File.read("#{rails_root}/#{CONFIG_PATH}")
+        src = File.read("#{::Rails.root}/#{CONFIG_PATH}")
         yaml = ERB.new(src).result
         env_conf = YAML.load(yaml)
       rescue
@@ -115,9 +94,9 @@ EOF
         return
       end
 
-      conf = env_conf[rails_env]
+      conf = env_conf[::Rails.env]
       unless conf
-        logger.warn "#{CONFIG_PATH} doesn't include setting for current environment (#{rails_env})."
+        logger.warn "#{CONFIG_PATH} doesn't include setting for current environment (#{::Rails.env})."
         logger.warn "Disabling Treasure Data logger."
         return
       end
@@ -132,6 +111,11 @@ EOF
     end
 
     def self.init(rails)
+      require 'td/logger/agent/middleware'
+      require 'td/logger/agent/access_log'
+      require 'td/logger/agent/rails/controller'
+      require 'td/logger/agent/rails/model'
+
       c = read_config(rails)
       return unless c
 
@@ -155,17 +139,17 @@ end
 end
 end
 
-if defined? Rails
-  if Rails.respond_to?(:version) && Rails.version =~ /^3/
+if defined? ::Rails
+  if ::Rails.respond_to?(:version) && ::Rails.version =~ /^3/
     module TreasureData
-      class Railtie < Rails::Railtie
+      class Railtie < ::Rails::Railtie
         initializer "treasure_data_agent.start_plugin" do |app|
           TreasureData::Logger::Agent::Rails.init(app.config)
         end
       end
     end
   else
-    TreasureData::Logger::Agent::Rails.init(Rails.configuration)
+    TreasureData::Logger::Agent::Rails.init(::Rails.configuration)
   end
 end
 

data/lib/td/logger/version.rb

@@ -1,7 +1,7 @@
 module TreasureData
 module Logger
 
-VERSION = '0.2.4'
+VERSION = '0.2.5'
 
 end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: td-logger
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 29
   prerelease: false
   segments: 
   - 0
   - 2
-  - 4
-  version: 0.2.4
+  - 5
+  version: 0.2.5
 platform: ruby
 authors: 
 - Sadayuki Furuhashi
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-13 00:00:00 +09:00
+date: 2011-09-30 00:00:00 +09:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency