logstasher 2.0.1 → 2.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c4f5c6311cd4d8ae8883aaff46a0238f688f456af9f8774abd79619e5cbba28
-  data.tar.gz: 654cdd782f29136fa87517fff5468ce45bd4e861783d9d305b344943cfbbacc0
+  metadata.gz: 59cdc11b4f36e90443fcc8ea7332552874da2ad2205f38e4efac48c8e4dda63a
+  data.tar.gz: 997cb22cb6799f67d28562e986e326fa23597ee5168a635bdc917d6a9bb65c6b
 SHA512:
-  metadata.gz: efbf0988e5ba529f52bbe17f57088473099b8d9931f147f9c8c572dcd71f5e9a5154e4486ffe381186fb2c5514e9ed34324bb5b3552a4c5f5fbad5eab28b1064
-  data.tar.gz: 411ac7f12e116ac6a2b2a2f6db01d08c76df82553eaf8a29bcd93bd2fb94df62e6b0c11c7eabe7748a97a662900b33f5fa0860888d3c557e4c1fa76b6868650c
+  metadata.gz: dd6d94a4055566fd119a570107724ce1fc1c1f3f1781f2929c248e4f2b227a3f95adb010b6e059f44cf49991f5baa1d9f3271f272efb5a97415104a265eb0e1b
+  data.tar.gz: 35d3e80b5e460753033b327e41d51149d24b20c7b1321189a2ec24373ac5aa9c713189eba701ddc3ec5904fbf86a2b98657deff4c2a02fcfcee20f93c31fd9f9

data/lib/logstasher.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'logstasher/version'
 require 'logstasher/active_support/log_subscriber'
 require 'logstasher/active_support/mailer_log_subscriber'
@@ -18,7 +20,7 @@ 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, :backtrace_filter
 
   # Setting the default to 'unknown' to define the default behaviour
   @source = 'unknown'
@@ -36,7 +38,9 @@ module LogStasher
         unsubscribe(:action_mailer, subscriber)
       when 'ActiveRecord::LogSubscriber'
         unsubscribe(:active_record, subscriber)
-      when 'ActiveJob::Logging::LogSubscriber'
+      when 'ActiveJob::LogSubscriber' # For Rails 6
+        unsubscribe(:active_job, subscriber)
+      when 'ActiveJob::Logging::LogSubscriber' # For Rails 5
         unsubscribe(:active_job, subscriber)
       end
     end
@@ -107,8 +111,9 @@ module LogStasher
     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.log_controller_parameters = !config.log_controller_parameters.nil?
+    self.backtrace = !config.backtrace.nil? unless config.backtrace.nil?
+    self.backtrace_filter = config.backtrace_filter
     set_data_for_rake
     set_data_for_console
     self.field_renaming = Hash(config.field_renaming)
@@ -123,7 +128,7 @@ module LogStasher
   end
 
   def called_as_rake?
-    File.basename($0) == 'rake'
+    File.basename($PROGRAM_NAME) == 'rake'
   end
 
   def called_as_console?
@@ -158,7 +163,7 @@ module LogStasher
   #   LogStasher.info("message", timing:1234)
   #   LogStasher.info(custom1:"yes", custom2:"no")
   def log(severity, message, additional_fields = {})
-    if logger && logger.send("#{severity}?")
+    if logger&.send("#{severity}?")
 
       data = { 'level' => severity }
       if message.respond_to?(:to_hash)
@@ -171,7 +176,7 @@ module LogStasher
       tags = Array(additional_fields.delete(:tags) || 'log')
 
       data.merge!(additional_fields)
-      logger << build_logstash_event(data, tags).to_json + "\n"
+      logger << "#{build_logstash_event(data, tags).to_json}\n"
 
     end
   end

data/lib/logstasher/action_view/log_subscriber.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support/notifications'
 require 'action_view/log_subscriber'
 require 'logstasher/custom_fields'
@@ -31,7 +33,7 @@ module LogStasher
 
         tags = []
         tags.push('exception') if data[:exception]
-        logger << LogStasher.build_logstash_event(data, tags).to_json + "\n"
+        logger << "#{LogStasher.build_logstash_event(data, tags).to_json}\n"
       end
 
       def extract_data(data)

data/lib/logstasher/active_job/log_subscriber.rb

@@ -1,91 +1,98 @@
-begin
-  # `rescue nil` didn't work for some Ruby versions
+# frozen_string_literal: true
+
+# For Rails 6.0 or below, require the logging module which contains LogSubscriber
+if ActiveJob::VERSION::MAJOR < 6 || (ActiveJob::VERSION::MAJOR == 6 && ActiveJob::VERSION::MINOR.zero?)
   require 'active_job/logging'
-rescue LoadError
+else
+  require 'active_job/log_subscriber'
 end
 
-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
+module LogStasher
+  module ActiveJob
+    BASE_SUBSCRIBER = if defined?(::ActiveJob::LogSubscriber)
+                        ::ActiveJob::LogSubscriber
+                      else
+                        ::ActiveJob::Logging::LogSubscriber
+                      end
+
+    class LogSubscriber < BASE_SUBSCRIBER
+      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)
+        ::ActiveJob::Arguments.serialize(job.arguments)
       end
     end
   end

data/lib/logstasher/active_record/log_subscriber.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support/notifications'
 require 'active_record/log_subscriber'
 require 'logstasher/custom_fields'
@@ -9,7 +11,7 @@ module LogStasher
 
       def identity(event)
         lsevent = logstash_event(event)
-        logger << lsevent.to_json + "\n" if logger && lsevent
+        logger << "#{lsevent.to_json}\n" if logger && lsevent
       end
       alias sql identity
 
@@ -21,9 +23,13 @@ module LogStasher
 
       def logstash_event(event)
         self.class.runtime += event.duration
-        data = event.payload
+        data = event.payload.dup
+
+        return if data[:name] == 'SCHEMA'
 
-        return if 'SCHEMA' == data[:name]
+        # A connection cannot be converted to JSON as it fails with
+        # SystemStackError when running against ActiveSupport JSON patches.
+        data.delete(:connection)
 
         data.merge! runtimes(event)
         data.merge! extract_sql(data)

data/lib/logstasher/active_support/log_subscriber.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support/core_ext/class/attribute'
 require 'active_support/log_subscriber'
 require 'logstasher/custom_fields'
@@ -20,7 +22,7 @@ module LogStasher
 
         tags = ['request']
         tags.push('exception') if payload[:exception]
-        logger << LogStasher.build_logstash_event(data, tags).to_json + "\n"
+        logger << "#{LogStasher.build_logstash_event(data, tags).to_json}\n"
       end
 
       def redirect_to(event)
@@ -48,11 +50,7 @@ module LogStasher
       end
 
       def extract_format(payload)
-        if ::ActionPack::VERSION::MAJOR == 3 && ::ActionPack::VERSION::MINOR == 0
-          payload[:formats].first
-        else
-          payload[:format]
-        end
+        payload[:format]        
       end
 
       def extract_status(payload)
@@ -88,10 +86,14 @@ module LogStasher
           exception, message = payload[:exception]
           status = ::ActionDispatch::ExceptionWrapper.status_code_for_exception(exception)
           backtrace = if LogStasher.backtrace
-                        $!.backtrace.join("\n")
-                      else
-                        $!.backtrace.first
-                      end
+            if LogStasher.backtrace_filter.respond_to?(:call)
+              LogStasher.backtrace_filter.call($!.backtrace).join("\n")
+            else
+              $!.backtrace.join("\n")
+            end
+          else
+            $!.backtrace.first
+          end
           message = "#{exception}\n#{message}\n#{backtrace}"
           { status: status, error: message }
         else

data/lib/logstasher/active_support/mailer_log_subscriber.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support/core_ext/class/attribute'
 require 'active_support/log_subscriber'
 
@@ -10,6 +12,11 @@ module LogStasher
         process_event(event, %w[mailer deliver])
       end
 
+      # This method will only be invoked on Rails 6.0 and prior.
+      # Starting in Rails 6.0 the receive method was deprecated in
+      # favor of ActionMailbox.  The receive method was removed
+      # from ActionMailer in Rails 6.1, and there doesn't appear to
+      # be corresponding instrumentation for ActionMailbox.
       def receive(event)
         process_event(event, %w[mailer receive])
       end
@@ -26,7 +33,7 @@ module LogStasher
 
       def process_event(event, tags)
         data = LogStasher.request_context.merge(extract_metadata(event.payload))
-        logger << LogStasher.build_logstash_event(data, tags).to_json + "\n"
+        logger << "#{LogStasher.build_logstash_event(data, tags).to_json}\n"
       end
 
       def extract_metadata(payload)

data/lib/logstasher/custom_fields.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module LogStasher
   module CustomFields
     module LogSubscriber

data/lib/logstasher/device/redis.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'redis'
 
 module LogStasher
@@ -22,7 +24,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.reject { |k, _v| default_keys.include?(k) }
         end
 
         @redis_options

data/lib/logstasher/event.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'json'
 require 'time'
 require 'date'

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module LogStasher
   module ActionController
     module Instrumentation

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActionController
   module Instrumentation
     alias orig_process_action process_action

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails/rack/logger'
 
 module Rails

data/lib/logstasher/railtie.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails/railtie'
 require 'action_view/log_subscriber'
 require 'action_controller/log_subscriber'
@@ -20,7 +22,7 @@ module LogStasher
     config_file = File.expand_path './config/logstasher.yml'
 
     # Load and ERB templating of YAML files
-    LOGSTASHER = File.exist?(config_file) ? YAML.load(ERB.new(File.read(config_file)).result).symbolize_keys : nil
+    LOGSTASHER = File.exist?(config_file) ? YAML.safe_load(ERB.new(File.read(config_file)).result).symbolize_keys : nil
 
     initializer :logstasher, before: :load_config_initializers do |app|
       if LOGSTASHER.present?
@@ -42,7 +44,7 @@ module LogStasher
     end
 
     def rack_cache_hashlike?(app)
-      app.config.action_dispatch.rack_cache && app.config.action_dispatch.rack_cache.respond_to?(:[]=)
+      app.config.action_dispatch.rack_cache&.respond_to?(:[]=)
     end
   end
 
@@ -55,7 +57,7 @@ module LogStasher
       # 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
+      address_info&.ip_address
     else
       IPSocket.getaddress(Socket.gethostname)
     end

data/lib/logstasher/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module LogStasher
-  VERSION = '2.0.1'.freeze
+  VERSION = '2.1.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstasher
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.3
 platform: ruby
 authors:
 - Shadab Ahmed
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-28 00:00:00.000000000 Z
+date: 2020-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: request_store
   requirement: !ruby/object:Gem::Requirement
@@ -38,20 +38,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: activerecord
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +58,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -134,7 +120,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Awesome rails logs