logstasher 1.2.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9a60d2be7649b262d3f67ea619acfb55098bcdd8
-  data.tar.gz: ceae4aaaf89e942b71cde7fa7d7458e059d1242c
+SHA256:
+  metadata.gz: e438a36935fc002e2de28f362171174d01908e321a432a45c0b6d5ba607593ff
+  data.tar.gz: 2076d9f4e694686bafc239e90f3c426feee7fcc74a9904352700704b1c8d2bd5
 SHA512:
-  metadata.gz: 83e416250549c5bd16dad2f153726c501426338067e51b9757dfab5c805abfa6e173c0facc7684767545dcd5728be6bac3aa0a571786839793a5101619e34cac
-  data.tar.gz: d5d930fb52ce3bbe1b3dd6d0f915bda97864d6079a496fde69c742d881777a5cc3b1d7a5c2f9d9a8f7c2305d27e14c839ae084906fb8d13e4f13eb61d5237570
+  metadata.gz: 7b8face2936949f9cf382336ef8e88da96ff848ea8f088f70eeedba7d6e76f923cb206b06b9cbb10b03ad28dda22cea70415d1686f662617a8175c9f6b7b2aa2
+  data.tar.gz: 7aa9af505594a1109b438c85a5196cfa5d46ac9591c53a4d3425790ed40d02f812c067a760d387b222bebbce8bae74585437d2a2e47cc8baa92e908d24c9aaee

data/lib/logstasher.rb

@@ -6,6 +6,7 @@ require 'logstasher/action_view/log_subscriber' if defined?(ActionView)
 require 'logstasher/active_job/log_subscriber' if defined?(ActiveJob)
 require 'logstasher/rails_ext/action_controller/base'
 require 'logstasher/custom_fields'
+require 'logstasher/event'
 require 'request_store'
 require 'active_support/core_ext/module/attribute_accessors'
 require 'active_support/core_ext/string/inflections'
@@ -17,7 +18,8 @@ module LogStasher
   REQUEST_CONTEXT_KEY = :logstasher_request_context
 
   attr_accessor :logger, :logger_path, :enabled, :log_controller_parameters, :source, :backtrace,
-    :controller_monkey_patch, :field_renaming
+                :controller_monkey_patch, :field_renaming
+
   # Setting the default to 'unknown' to define the default behaviour
   @source = 'unknown'
   # By default log the backtrace of exceptions
@@ -26,27 +28,25 @@ module LogStasher
   def remove_existing_log_subscriptions
     ::ActiveSupport::LogSubscriber.log_subscribers.each do |subscriber|
       case subscriber.class.name
-        when 'ActionView::LogSubscriber'
-          unsubscribe(:action_view, subscriber)
-        when 'ActionController::LogSubscriber'
-          unsubscribe(:action_controller, subscriber)
-        when 'ActionMailer::LogSubscriber'
-          unsubscribe(:action_mailer, subscriber)
-        when 'ActiveRecord::LogSubscriber'
-          unsubscribe(:active_record, subscriber)
-        when 'ActiveJob::Logging::LogSubscriber'
-          unsubscribe(:active_job, subscriber)
+      when 'ActionView::LogSubscriber'
+        unsubscribe(:action_view, subscriber)
+      when 'ActionController::LogSubscriber'
+        unsubscribe(:action_controller, subscriber)
+      when 'ActionMailer::LogSubscriber'
+        unsubscribe(:action_mailer, subscriber)
+      when 'ActiveRecord::LogSubscriber'
+        unsubscribe(:active_record, subscriber)
+      when 'ActiveJob::Logging::LogSubscriber'
+        unsubscribe(:active_job, subscriber)
       end
     end
   end
 
   def unsubscribe(component, subscriber)
-    events = subscriber.public_methods(false).reject{ |method| method.to_s == 'call' }
+    events = subscriber.public_methods(false).reject { |method| method.to_s == 'call' }
     events.each do |event|
       ::ActiveSupport::Notifications.notifier.listeners_for("#{event}.#{component}").each do |listener|
-        if listener.instance_variable_get('@delegate') == subscriber
-          ::ActiveSupport::Notifications.unsubscribe listener
-        end
+        ::ActiveSupport::Notifications.unsubscribe listener if listener.instance_variable_get('@delegate') == subscriber
       end
     end
   end
@@ -56,14 +56,14 @@ module LogStasher
     payload[:route] = "#{request.params[:controller]}##{request.params[:action]}"
     payload[:request_id] = request.env['action_dispatch.request_id']
     LogStasher::CustomFields.add(:ip, :route, :request_id)
-    if self.log_controller_parameters
+    if log_controller_parameters
       payload[:parameters] = payload[:params].except(*::ActionController::LogSubscriber::INTERNAL_PARAMS)
       LogStasher::CustomFields.add(:parameters)
     end
   end
 
   def add_custom_fields(&block)
-    wrapped_block = Proc.new do |fields|
+    wrapped_block = proc do |fields|
       LogStasher::CustomFields.add(*LogStasher.store.keys)
       instance_exec(fields, &block)
     end
@@ -72,7 +72,7 @@ module LogStasher
   end
 
   def add_custom_fields_to_request_context(&block)
-    wrapped_block = Proc.new do |fields|
+    wrapped_block = proc do |fields|
       instance_exec(fields, &block)
       LogStasher::CustomFields.add(*fields.keys)
     end
@@ -100,27 +100,27 @@ module LogStasher
 
   def setup(config)
     # Path instrumentation class to insert our hook
-    if (! config.controller_monkey_patch && config.controller_monkey_patch != false) || config.controller_monkey_patch == true
+    if (!config.controller_monkey_patch && config.controller_monkey_patch != false) || config.controller_monkey_patch == true
       require 'logstasher/rails_ext/action_controller/metal/instrumentation'
     end
-    self.suppress_app_logs(config)
+    suppress_app_logs(config)
     self.logger_path = config.logger_path || "#{Rails.root}/log/logstash_#{Rails.env}.log"
-    self.logger = config.logger || new_logger(self.logger_path)
-    self.logger.level = config.log_level || Logger::WARN
+    self.logger = config.logger || new_logger(logger_path)
+    logger.level = config.log_level || Logger::WARN
     self.source = config.source unless config.source.nil?
-    self.log_controller_parameters = !! config.log_controller_parameters
-    self.backtrace = !! config.backtrace unless config.backtrace.nil?
-    self.set_data_for_rake
-    self.set_data_for_console
+    self.log_controller_parameters = !!config.log_controller_parameters
+    self.backtrace = !!config.backtrace unless config.backtrace.nil?
+    set_data_for_rake
+    set_data_for_console
     self.field_renaming = Hash(config.field_renaming)
   end
 
   def set_data_for_rake
-    self.request_context['request_id'] = ::Rake.application.top_level_tasks if self.called_as_rake?
+    request_context['request_id'] = ::Rake.application.top_level_tasks if called_as_rake?
   end
 
   def set_data_for_console
-    self.request_context['request_id'] = "#{Process.pid}" if self.called_as_console?
+    request_context['request_id'] = Process.pid.to_s if called_as_console?
   end
 
   def called_as_rake?
@@ -132,7 +132,7 @@ module LogStasher
   end
 
   def has_active_job?
-    Rails::VERSION::MAJOR > 4 || (Rails::VERSION::MAJOR == 4 && Rails::VERSION::MINOR >= 2)
+    defined?(ActiveJob)
   end
 
   def suppress_app_logs(config)
@@ -158,10 +158,10 @@ module LogStasher
   #   LogStasher.info("message", tags:["tag1", "tag2"])
   #   LogStasher.info("message", timing:1234)
   #   LogStasher.info(custom1:"yes", custom2:"no")
-  def log(severity, message, additional_fields={})
-    if self.logger && self.logger.send("#{severity}?")
+  def log(severity, message, additional_fields = {})
+    if logger && logger.send("#{severity}?")
 
-      data = {'level' => severity}
+      data = { 'level' => severity }
       if message.respond_to?(:to_hash)
         data.merge!(message.to_hash)
       else
@@ -172,16 +172,16 @@ module LogStasher
       tags = Array(additional_fields.delete(:tags) || 'log')
 
       data.merge!(additional_fields)
-      self.logger << build_logstash_event(data, tags).to_json + "\n"
+      logger << build_logstash_event(data, tags).to_json + "\n"
 
     end
   end
 
   def build_logstash_event(data, tags)
     field_renaming.each do |old_name, new_name|
-        data[new_name] = data.delete(old_name) if data.key?(old_name)
+      data[new_name] = data.delete(old_name) if data.key?(old_name)
     end
-    ::LogStash::Event.new(data.merge('source' => self.source, 'tags' => tags))
+    Event.new(data.merge('source' => source, 'tags' => tags))
   end
 
   def store
@@ -204,7 +204,7 @@ module LogStasher
     end
   end
 
-  %w( fatal error warn info debug unknown ).each do |severity|
+  %w[fatal error warn info debug unknown].each do |severity|
     eval <<-EOM, nil, __FILE__, __LINE__ + 1
       def #{severity}(message=nil, additional_fields={})
         self.log(:#{severity}, message, additional_fields)
@@ -213,7 +213,7 @@ module LogStasher
   end
 
   def enabled?
-    self.enabled || false
+    enabled || false
   end
 
   private

data/lib/logstasher/action_view/log_subscriber.rb

@@ -10,8 +10,8 @@ module LogStasher
       def render_template(event)
         logstash_event(event)
       end
-      alias :render_partial :render_template
-      alias :render_collection :render_template
+      alias render_partial render_template
+      alias render_collection render_template
 
       def logger
         LogStasher.logger
@@ -35,7 +35,7 @@ module LogStasher
       end
 
       def extract_data(data)
-        {  identifier: from_rails_root(data[:identifier]) }
+        { identifier: from_rails_root(data[:identifier]) }
       end
 
       def request_context
@@ -49,16 +49,15 @@ module LogStasher
       def event_data(event)
         {
           name: event.name,
-          transaction_id: event.transaction_id,
+          transaction_id: event.transaction_id
         }
       end
 
       def runtimes(event)
         {
-          duration: event.duration,
-        }.inject({}) do |runtimes, (name, runtime)|
+          duration: event.duration
+        }.each_with_object({}) do |(name, runtime), runtimes|
           runtimes[name] = runtime.to_f.round(2) if runtime
-          runtimes
         end
       end
     end

data/lib/logstasher/active_job/log_subscriber.rb

@@ -4,89 +4,89 @@ begin
 rescue LoadError
 end
 
-module LogStasher
-  module ActiveJob
-    class LogSubscriber < ::ActiveJob::Logging::LogSubscriber
-
-      def enqueue(event)
-        process_event(event, 'enqueue')
-      end
-
-      def enqueue_at(event)
-        process_event(event, 'enqueue_at')
-      end
-
-      def perform(event)
-        process_event(event, 'perform')
-
-        # Revert the request id back, in the event that the inline adapter is being used or a
-        # perform_now was used.
-        LogStasher.request_context[:request_id] = Thread.current[:old_request_id]
-        Thread.current[:old_request_id] = nil
-      end
-
-      def perform_start(event)
-        # Use the job_id as the request id, so that any custom logging done for a job
-        # shares a request id, and has the job id in each log line.
-        #
-        # It's not being set when the job is enqueued, so enqueuing a job will have it's default
-        # request_id. In a lot of cases, it will be because of a web request.
-        #
-        # Hang onto the old request id, so we can revert after the job is done being performed.
-        Thread.current[:old_request_id] = LogStasher.request_context[:request_id]
-        LogStasher.request_context[:request_id] = event.payload[:job].job_id
-
-        process_event(event, 'perform_start')
-      end
-
-      def logger
-        LogStasher.logger
-      end
-
-      private
-
-      def process_event(event, type)
-        data = extract_metadata(event)
-        data.merge! extract_exception(event)
-        data.merge! extract_scheduled_at(event) if type == 'enqueue_at'
-        data.merge! extract_duration(event) if type == 'perform'
-        data.merge! request_context
-
-        tags = ['job', type]
-        tags.push('exception') if data[:exception]
-        logger << LogStasher.build_logstash_event(data, tags).to_json + "\n"
+if defined?(::ActiveJob::Logging::LogSubscriber)
+  module LogStasher
+    module ActiveJob
+      class LogSubscriber < ::ActiveJob::Logging::LogSubscriber
+        def enqueue(event)
+          process_event(event, 'enqueue')
+        end
+
+        def enqueue_at(event)
+          process_event(event, 'enqueue_at')
+        end
+
+        def perform(event)
+          process_event(event, 'perform')
+
+          # Revert the request id back, in the event that the inline adapter is being used or a
+          # perform_now was used.
+          LogStasher.request_context[:request_id] = Thread.current[:old_request_id]
+          Thread.current[:old_request_id] = nil
+        end
+
+        def perform_start(event)
+          # Use the job_id as the request id, so that any custom logging done for a job
+          # shares a request id, and has the job id in each log line.
+          #
+          # It's not being set when the job is enqueued, so enqueuing a job will have it's default
+          # request_id. In a lot of cases, it will be because of a web request.
+          #
+          # Hang onto the old request id, so we can revert after the job is done being performed.
+          Thread.current[:old_request_id] = LogStasher.request_context[:request_id]
+          LogStasher.request_context[:request_id] = event.payload[:job].job_id
+
+          process_event(event, 'perform_start')
+        end
+
+        def logger
+          LogStasher.logger
+        end
+
+        private
+
+        def process_event(event, type)
+          data = extract_metadata(event)
+          data.merge! extract_exception(event)
+          data.merge! extract_scheduled_at(event) if type == 'enqueue_at'
+          data.merge! extract_duration(event) if type == 'perform'
+          data.merge! request_context
+
+          tags = ['job', type]
+          tags.push('exception') if data[:exception]
+          logger << LogStasher.build_logstash_event(data, tags).to_json + "\n"
+        end
+
+        def extract_metadata(event)
+          {
+            job_id: event.payload[:job].job_id,
+            queue_name: queue_name(event),
+            job_class: event.payload[:job].class.to_s,
+            job_args: args_info(event.payload[:job])
+          }
+        end
+
+        def extract_duration(event)
+          { duration: event.duration.to_f.round(2) }
+        end
+
+        def extract_exception(event)
+          event.payload.slice(:exception)
+        end
+
+        def extract_scheduled_at(event)
+          { scheduled_at: scheduled_at(event) }
+        end
+
+        def request_context
+          LogStasher.request_context
+        end
+
+        # The default args_info makes a string. We need objects to turn into JSON.
+        def args_info(job)
+          job.arguments.map { |arg| arg.try(:to_global_id).try(:to_s) || arg }
+        end
       end
-
-      def extract_metadata(event)
-        {
-          :job_id => event.payload[:job].job_id,
-          :queue_name => queue_name(event),
-          :job_class => event.payload[:job].class.to_s,
-          :job_args => args_info(event.payload[:job]),
-        }
-      end
-
-      def extract_duration(event)
-        { :duration => event.duration.to_f.round(2) }
-      end
-
-      def extract_exception(event)
-        event.payload.slice(:exception)
-      end
-
-      def extract_scheduled_at(event)
-        { :scheduled_at => scheduled_at(event) }
-      end
-
-      def request_context
-        LogStasher.request_context
-      end
-
-      # The default args_info makes a string. We need objects to turn into JSON.
-      def args_info(job)
-        job.arguments.map { |arg| arg.try(:to_global_id).try(:to_s) || arg }
-      end
-
     end
   end
-end if defined?(::ActiveJob::Logging::LogSubscriber)
+end

data/lib/logstasher/active_record/log_subscriber.rb

@@ -9,11 +9,9 @@ module LogStasher
 
       def identity(event)
         lsevent = logstash_event(event)
-        if logger && lsevent
-          logger << lsevent.to_json + "\n"
-        end
+        logger << lsevent.to_json + "\n" if logger && lsevent
       end
-      alias :sql :identity
+      alias sql identity
 
       def logger
         LogStasher.logger
@@ -22,6 +20,7 @@ module LogStasher
       private
 
       def logstash_event(event)
+        self.class.runtime += event.duration
         data = event.payload
 
         return if 'SCHEMA' == data[:name]
@@ -32,7 +31,7 @@ module LogStasher
         data.merge! LogStasher.store
         data.merge! extract_custom_fields(data)
 
-        tags = [ 'request' ]
+        tags = ['request']
         tags.push('exception') if data[:exception]
         LogStasher.build_logstash_event(data, tags)
       end
@@ -45,7 +44,7 @@ module LogStasher
         if event.duration
           { duration: event.duration.to_f.round(2) }
         else
-          {  }
+          {}
         end
       end
 

data/lib/logstasher/active_support/log_subscriber.rb

@@ -44,7 +44,7 @@ module LogStasher
       end
 
       def extract_path(payload)
-        payload[:path].split("?").first
+        payload[:path].split('?').first
       end
 
       def extract_format(payload)
@@ -57,27 +57,26 @@ module LogStasher
 
       def extract_status(payload)
         if payload[:status]
-          { :status => payload[:status].to_i }
+          { status: payload[:status].to_i }
         else
-          { :status => 0 }
+          { status: 0 }
         end
       end
 
       def runtimes(event)
         {
-          :duration => event.duration,
-          :view => event.payload[:view_runtime],
-          :db => event.payload[:db_runtime]
-        }.inject({}) do |runtimes, (name, runtime)|
+          duration: event.duration,
+          view: event.payload[:view_runtime],
+          db: event.payload[:db_runtime]
+        }.each_with_object({}) do |(name, runtime), runtimes|
           runtimes[name] = runtime.to_f.round(2) if runtime
-          runtimes
         end
       end
 
-      def location(event)
+      def location(_event)
         if location = Thread.current[:logstasher_location]
           Thread.current[:logstasher_location] = nil
-          { :location => location }
+          { location: location }
         else
           {}
         end
@@ -88,13 +87,13 @@ module LogStasher
         if payload[:exception]
           exception, message = payload[:exception]
           status = ::ActionDispatch::ExceptionWrapper.status_code_for_exception(exception)
-          if LogStasher.backtrace
-            backtrace = $!.backtrace.join("\n")
-          else
-            backtrace = $!.backtrace.first
-          end
+          backtrace = if LogStasher.backtrace
+                        $!.backtrace.join("\n")
+                      else
+                        $!.backtrace.first
+                      end
           message = "#{exception}\n#{message}\n#{backtrace}"
-          { :status => status, :error => message }
+          { status: status, error: message }
         else
           {}
         end

data/lib/logstasher/active_support/mailer_log_subscriber.rb

@@ -4,18 +4,18 @@ require 'active_support/log_subscriber'
 module LogStasher
   module ActiveSupport
     class MailerLogSubscriber < ::ActiveSupport::LogSubscriber
-      MAILER_FIELDS = [:mailer, :action, :message_id, :from, :to]
+      MAILER_FIELDS = %i[mailer action message_id from to].freeze
 
       def deliver(event)
-        process_event(event, ['mailer', 'deliver'])
+        process_event(event, %w[mailer deliver])
       end
 
       def receive(event)
-        process_event(event, ['mailer', 'receive'])
+        process_event(event, %w[mailer receive])
       end
 
       def process(event)
-        process_event(event, ['mailer', 'process'])
+        process_event(event, %w[mailer process])
       end
 
       def logger

data/lib/logstasher/custom_fields.rb

@@ -5,7 +5,7 @@ module LogStasher
         (!CustomFields.custom_fields.empty? && data.extract!(*CustomFields.custom_fields)) || {}
       end
     end
-    
+
     def self.clear
       Thread.current[:logstasher_custom_fields] = []
     end

data/lib/logstasher/device/redis.rb

@@ -3,7 +3,6 @@ require 'redis'
 module LogStasher
   module Device
     class Redis
-
       attr_reader :options, :redis
 
       def initialize(options = {})
@@ -23,7 +22,7 @@ module LogStasher
       def redis_options
         unless @redis_options
           default_keys = default_options.keys
-          @redis_options = options.select { |k, v| !default_keys.include?(k) }
+          @redis_options = options.select { |k, _v| !default_keys.include?(k) }
         end
 
         @redis_options
@@ -36,7 +35,7 @@ module LogStasher
         when 'channel'
           redis.publish(key, log)
         else
-          fail "Unknown data type #{data_type}"
+          raise "Unknown data type #{data_type}"
         end
       end
 
@@ -51,12 +50,12 @@ module LogStasher
       end
 
       def default_options
-          { key: 'logstash', data_type: 'list' }
+        { key: 'logstash', data_type: 'list' }
       end
 
       def validate_options
-        unless ['list', 'channel'].include?(options[:data_type])
-          fail 'Expected :data_type to be either "list" or "channel"'
+        unless %w[list channel].include?(options[:data_type])
+          raise 'Expected :data_type to be either "list" or "channel"'
         end
       end
     end

data/lib/logstasher/event.rb

@@ -0,0 +1,32 @@
+require 'json'
+require 'time'
+require 'date'
+
+module LogStasher
+  class Event
+    def initialize(data = {})
+      @cancelled = false
+
+      @data = data
+      if data.include?('@timestamp')
+        t = data['@timestamp']
+        data['@timestamp'] = Time.parse(t).gmtime.iso8601(3) if t.is_a?(String)
+      else
+        data['@timestamp'] = ::Time.now.utc.iso8601(3)
+      end
+      data['@version'] = '1' unless @data.include?('@version')
+    end
+
+    def to_s
+      to_json.to_s
+    end
+
+    def to_json(*args)
+      @data.to_json(*args)
+    end
+
+    def [](key)
+      @data[key]
+    end
+  end
+end

data/lib/logstasher/rails_ext/action_controller/base.rb

@@ -9,17 +9,17 @@ module LogStasher
         super(*args)
         LogStasher::CustomFields.clear
       end
-      
+
       private
 
       # this method is called from within super of process_action.
       def append_info_to_payload(payload) #:nodoc:
         LogStasher.add_default_fields_to_payload(payload, request)
-        if self.respond_to?(:logstasher_add_custom_fields_to_request_context)
+        if respond_to?(:logstasher_add_custom_fields_to_request_context)
           logstasher_add_custom_fields_to_request_context(LogStasher.request_context)
         end
 
-        if self.respond_to?(:logstasher_add_custom_fields_to_payload)
+        if respond_to?(:logstasher_add_custom_fields_to_payload)
           before_keys = payload.keys.clone
           logstasher_add_custom_fields_to_payload(payload)
           after_keys = payload.keys
@@ -38,7 +38,7 @@ module LogStasher
           payload[key] = value
         end
       end
-      
+
       def add_custom_fields_to_store
         LogStasher.store[:ip] = request.remote_ip
         LogStasher.store[:route] = "#{request.params[:controller]}##{request.params[:action]}"

data/lib/logstasher/rails_ext/action_controller/metal/instrumentation.rb

@@ -1,14 +1,18 @@
 module ActionController
   module Instrumentation
-    alias :orig_process_action :process_action
+    alias orig_process_action process_action
     def process_action(*args)
       raw_payload = {
-          :controller => self.class.name,
-          :action     => self.action_name,
-          :params     => request.filtered_parameters,
-          :format     => request.format.try(:ref),
-          :method     => request.method,
-          :path       => (request.fullpath rescue "unknown")
+        controller: self.class.name,
+        action: action_name,
+        params: request.filtered_parameters,
+        format: request.format.try(:ref),
+        method: request.method,
+        path: begin
+          request.fullpath
+        rescue StandardError
+          'unknown'
+        end
       }
 
       LogStasher.add_default_fields_to_payload(raw_payload, request)
@@ -16,14 +20,14 @@ module ActionController
       LogStasher.clear_request_context
       LogStasher.add_default_fields_to_request_context(request)
 
-      ActiveSupport::Notifications.instrument("start_processing.action_controller", raw_payload.dup)
+      ActiveSupport::Notifications.instrument('start_processing.action_controller', raw_payload.dup)
 
-      ActiveSupport::Notifications.instrument("process_action.action_controller", raw_payload) do |payload|
-        if self.respond_to?(:logstasher_add_custom_fields_to_request_context)
+      ActiveSupport::Notifications.instrument('process_action.action_controller', raw_payload) do |payload|
+        if respond_to?(:logstasher_add_custom_fields_to_request_context)
           logstasher_add_custom_fields_to_request_context(LogStasher.request_context)
         end
 
-        if self.respond_to?(:logstasher_add_custom_fields_to_payload)
+        if respond_to?(:logstasher_add_custom_fields_to_payload)
           before_keys = raw_payload.keys.clone
           logstasher_add_custom_fields_to_payload(raw_payload)
           after_keys = raw_payload.keys
@@ -45,6 +49,6 @@ module ActionController
         result
       end
     end
-    alias :logstasher_process_action :process_action
+    alias logstasher_process_action process_action
   end
 end

data/lib/logstasher/rails_ext/rack/logger.rb

@@ -17,8 +17,7 @@ module Rails
       end
 
       # Overwrites Rails 3.0/3.1 code that logs new requests
-      def before_dispatch(env)
-      end
+      def before_dispatch(env); end
     end
   end
 end

data/lib/logstasher/railtie.rb

@@ -17,12 +17,12 @@ module LogStasher
 
     # Try loading the config/logstasher.yml if present
     env = Rails.env.to_sym || :development
-    config_file = File.expand_path "./config/logstasher.yml"
+    config_file = File.expand_path './config/logstasher.yml'
 
     # Load and ERB templating of YAML files
-    LOGSTASHER = File.exists?(config_file) ? YAML.load(ERB.new(File.read(config_file)).result).symbolize_keys : nil
+    LOGSTASHER = File.exist?(config_file) ? YAML.load(ERB.new(File.read(config_file)).result).symbolize_keys : nil
 
-    initializer :logstasher, :before => :load_config_initializers do |app|
+    initializer :logstasher, before: :load_config_initializers do |app|
       if LOGSTASHER.present?
         # process common configs
         LogStasher.process_config(app.config.logstasher, LOGSTASHER)
@@ -30,7 +30,8 @@ module LogStasher
         LogStasher.process_config(app.config.logstasher, LOGSTASHER[env].symbolize_keys) if LOGSTASHER.key? env
       end
 
-      app.config.action_dispatch.rack_cache[:verbose] = false if app.config.action_dispatch.rack_cache
+      app.config.action_dispatch.rack_cache[:verbose] = false if rack_cache_hashlike?(app)
+
       LogStasher.setup_before(app.config.logstasher) if app.config.logstasher.enabled
     end
 
@@ -39,6 +40,25 @@ module LogStasher
         LogStasher.setup(config.logstasher) if config.logstasher.enabled
       end
     end
+
+    def rack_cache_hashlike?(app)
+      app.config.action_dispatch.rack_cache && app.config.action_dispatch.rack_cache.respond_to?(:[]=)
+    end
+  end
+
+  def default_source
+    case RUBY_PLATFORM
+    when /darwin/
+      # NOTE: MacOS Sierra and later are setting `.local`
+      # hostnames that even as real hostnames without the `.local` part,
+      # are still unresolvable. One reliable way to get an IP is to
+      # get all available IP address lists and use the first one.
+      # This will always be `127.0.0.1`.
+      address_info = Socket.ip_address_list.first
+      address_info && address_info.ip_address
+    else
+      IPSocket.getaddress(Socket.gethostname)
+    end
   end
 
   def process_config(config, yml_config)
@@ -54,10 +74,13 @@ module LogStasher
     config.suppress_app_log = yml_config[:suppress_app_log] if yml_config.key? :suppress_app_log
 
     # This line is optional, it allows you to set a custom value for the @source field of the log event
-    config.source = yml_config.key?(:source) ? yml_config[:source] : IPSocket.getaddress(Socket.gethostname)
+    config.source = yml_config.key?(:source) ? yml_config[:source] : default_source
 
     config.backtrace = yml_config[:backtrace] if yml_config.key? :backtrace
     config.logger_path = yml_config[:logger_path] if yml_config.key? :logger_path
     config.log_level = yml_config[:log_level] if yml_config.key? :log_level
+    if yml_config.key? :log_controller_parameters
+      config.log_controller_parameters = yml_config[:log_controller_parameters]
+    end
   end
 end

data/lib/logstasher/version.rb

@@ -1,3 +1,3 @@
 module LogStasher
-  VERSION = "1.2.0"
+  VERSION = '2.0.0'.freeze
 end

metadata

@@ -1,71 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: logstasher
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Shadab Ahmed
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-03-01 00:00:00.000000000 Z
+date: 2020-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: logstash-event
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: request_store
+  name: logstash-event
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: request_store
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -86,28 +86,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '2.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '2.14'
 description: Awesome rails logs
 email:
 - shadab.ansari@gmail.com
@@ -123,6 +123,7 @@ files:
 - lib/logstasher/active_support/mailer_log_subscriber.rb
 - lib/logstasher/custom_fields.rb
 - lib/logstasher/device/redis.rb
+- lib/logstasher/event.rb
 - lib/logstasher/rails_ext/action_controller/base.rb
 - lib/logstasher/rails_ext/action_controller/metal/instrumentation.rb
 - lib/logstasher/rails_ext/rack/logger.rb
@@ -132,7 +133,7 @@ homepage: https://github.com/shadabahmed/logstasher
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -147,9 +148,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: Awesome rails logs
 test_files: []