lograge 0.3.1 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7e83952d334c15f42c841f0ed45c8e1538e795ab
-  data.tar.gz: 581be0bc6a70dfa1abaad4bbefef0a80115f837c
+SHA256:
+  metadata.gz: 0d989dce1202da74220c6ac7926c3ef413502644e6f456589a334278ea357a4d
+  data.tar.gz: be68c46645948d5cc157a475b8820f50453fecaf9cc5e0f23bc842ec432eaa48
 SHA512:
-  metadata.gz: f21494756b287b5d0c95594f9a285b70e2af281f9b25a19f4e2c90a4656058cadc869337f9671002af5403ffc2331b8a3e1230ba3363e0c7b861e7569f8fb30c
-  data.tar.gz: 09f4b1e38c61db6caff08c51019ffdb982f2b7ca536ea5be7edbbd9a113fb48ca3dbb041603737cedaf810cbcb85c48b9d9a166fd330de7ca0639523d53ccb3d
+  metadata.gz: 273878d74ebdf36f2e703f6c4f0c70e6e17633f13dfc82bc7297ee5b209bb640a09da601768d16d4ca839bb22dfad7f0b8ee832676e4d94d4a96a90b1b5bfadc
+  data.tar.gz: c8503e3b547652a44076a858d0d566b1c75a273ef3efc6357398f7d5c41be7b656cf09687f96c1fe2437d16e4d8c8a657bfb7665055dab16e3a05230adf80e40

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) Mathias Meyer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/lib/lograge/formatters/cee.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lograge
   module Formatters
     class Cee

data/lib/lograge/formatters/graylog2.rb

@@ -1,21 +1,15 @@
+# frozen_string_literal: true
+
 module Lograge
   module Formatters
     class Graylog2
-      def call(data)
-        # Cloning because we don't want to mess with the original when mutating keys.
-        data_clone = data.clone
-
-        base = {
-          short_message: short_message(data_clone)
-        }
+      include Lograge::Formatters::Helpers::MethodAndPath
 
+      def call(data)
         # Add underscore to every key to follow GELF additional field syntax.
-        data_clone.keys.each do |key|
-          data_clone[underscore_prefix(key)] = data_clone[key]
-          data_clone.delete(key)
-        end
-
-        data_clone.merge(base)
+        data.transform_keys { |k| underscore_prefix(k) }.merge(
+          short_message: short_message(data)
+        )
       end
 
       def underscore_prefix(key)
@@ -23,7 +17,7 @@ module Lograge
       end
 
       def short_message(data)
-        "[#{data[:status]}] #{data[:method]} #{data[:path]} (#{data[:controller]}##{data[:action]})"
+        "[#{data[:status]}]#{method_and_path_string(data)}(#{data[:controller]}##{data[:action]})"
       end
     end
   end

data/lib/lograge/formatters/helpers/method_and_path.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Lograge
+  module Formatters
+    module Helpers
+      module MethodAndPath
+        def method_and_path_string(data)
+          method_and_path = [data[:method], data[:path]].compact
+          method_and_path.any?(&:present?) ? " #{method_and_path.join(' ')} " : ' '
+        end
+      end
+    end
+  end
+end

data/lib/lograge/formatters/json.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'json'
 module Lograge
   module Formatters

data/lib/lograge/formatters/key_value.rb

@@ -1,29 +1,32 @@
+# frozen_string_literal: true
+
 module Lograge
   module Formatters
     class KeyValue
       def call(data)
-        fields = fields_to_display(data)
-
-        event = fields.map { |key| format(key, data[key]) }
-        event.join(' ')
+        fields_to_display(data)
+          .map { |key| format(key, data[key]) }
+          .join(' ')
       end
 
+      protected
+
       def fields_to_display(data)
         data.keys
       end
 
       def format(key, value)
-        if key == :error
-          # Exactly preserve the previous output
-          # Parsing this can be ambigious if the error messages contains
-          # a single quote
-          value = "'#{value}'"
-        else
-          # Ensure that we always have exactly two decimals
-          value = Kernel.format('%.2f', value) if value.is_a? Float
-        end
+        "#{key}=#{parse_value(key, value)}"
+      end
+
+      def parse_value(key, value)
+        # Exactly preserve the previous output
+        # Parsing this can be ambigious if the error messages contains
+        # a single quote
+        return "'#{value}'" if key == :error
+        return Kernel.format('%.2f', value) if value.is_a? Float
 
-        "#{key}=#{value}"
+        value
       end
     end
   end

data/lib/lograge/formatters/key_value_deep.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Lograge
+  module Formatters
+    class KeyValueDeep < KeyValue
+      def call(data)
+        super flatten_keys(data)
+      end
+
+      protected
+
+      def flatten_keys(data, prefix = '')
+        return flatten_object(data, prefix) if [Hash, Array].include? data.class
+
+        data
+      end
+
+      def flatten_object(data, prefix)
+        result = {}
+        loop_on_object(data) do |key, value|
+          key = "#{prefix}_#{key}" unless prefix.empty?
+          if [Hash, Array].include? value.class
+            result.merge!(flatten_keys(value, key))
+          else
+            result[key] = value
+          end
+        end
+        result
+      end
+
+      def loop_on_object(data, &block)
+        if data.instance_of? Array
+          data.each_with_index do |value, index|
+            yield index, value
+          end
+          return
+        end
+        data.each(&block)
+      end
+    end
+  end
+end

data/lib/lograge/formatters/l2met.rb

@@ -1,27 +1,48 @@
+# frozen_string_literal: true
+
 require 'lograge/formatters/key_value'
 
 module Lograge
   module Formatters
     class L2met < KeyValue
-      L2MET_FIELDS = [
-        :method, :path, :format, :source, :status, :error,
-        :duration, :view, :db, :location
-      ]
+      L2MET_FIELDS = %i[
+        method
+        path
+        format
+        source
+        status
+        error
+        duration
+        view
+        db
+        location
+      ].freeze
+
+      UNWANTED_FIELDS = %i[
+        controller
+        action
+      ].freeze
 
       def call(data)
         super(modify_payload(data))
       end
 
+      protected
+
+      def fields_to_display(data)
+        L2MET_FIELDS + additional_fields(data)
+      end
+
+      def additional_fields(data)
+        (data.keys - L2MET_FIELDS) - UNWANTED_FIELDS
+      end
+
       def format(key, value)
         key = "measure#page.#{key}" if value.is_a?(Float)
 
         super(key, value)
       end
 
-      def fields_to_display(data)
-        L2MET_FIELDS + (data.keys - L2MET_FIELDS) - [:controller, :action]
-      end
-
       def modify_payload(data)
         data[:source] = source_field(data) if data[:controller] && data[:action]
 
@@ -29,7 +50,7 @@ module Lograge
       end
 
       def source_field(data)
-        "#{data[:controller].to_s.gsub('/', '-')}:#{data[:action]}"
+        "#{data[:controller].to_s.tr('/', '-')}:#{data[:action]}"
       end
     end
   end

data/lib/lograge/formatters/lines.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lograge
   module Formatters
     class Lines

data/lib/lograge/formatters/logstash.rb

@@ -1,11 +1,15 @@
+# frozen_string_literal: true
+
 module Lograge
   module Formatters
     class Logstash
+      include Lograge::Formatters::Helpers::MethodAndPath
+
       def call(data)
         load_dependencies
         event = LogStash::Event.new(data)
 
-        event.message = "[#{data[:status]}] #{data[:method]} #{data[:path]} (#{data[:controller]}##{data[:action]})"
+        event['message'] = "[#{data[:status]}]#{method_and_path_string(data)}(#{data[:controller]}##{data[:action]})"
         event.to_json
       end
 

data/lib/lograge/formatters/ltsv.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Lograge
+  module Formatters
+    class LTSV
+      def call(data)
+        fields = fields_to_display(data)
+
+        event = fields.map { |key| format(key, data[key]) }
+        event.join("\t")
+      end
+
+      def fields_to_display(data)
+        data.keys
+      end
+
+      def format(key, value)
+        if key == :error
+          # Exactly preserve the previous output
+          # Parsing this can be ambigious if the error messages contains
+          # a single quote
+          value = "'#{escape value}'"
+        elsif value.is_a? Float
+          value = Kernel.format('%.2f', value)
+        end
+
+        "#{key}:#{value}"
+      end
+
+      private
+
+      def escape(string)
+        value = string.is_a?(String) ? string.dup : string.to_s
+
+        value.gsub!('\\', '\\\\')
+        value.gsub!('\n', '\\n')
+        value.gsub!('\r', '\\r')
+        value.gsub!('\t', '\\t')
+
+        value
+      end
+    end
+  end
+end

data/lib/lograge/formatters/raw.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lograge
   module Formatters
     class Raw

data/lib/lograge/log_subscribers/action_cable.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Lograge
+  module LogSubscribers
+    class ActionCable < Base
+      %i[perform_action subscribe unsubscribe connect disconnect].each do |method_name|
+        define_method(method_name) do |event|
+          process_main_event(event)
+        end
+      end
+
+      private
+
+      def initial_data(payload)
+        {
+          method: nil,
+          path: nil,
+          format: nil,
+          params: payload[:data],
+          controller: payload[:channel_class] || payload[:connection_class],
+          action: payload[:action]
+        }
+      end
+
+      def default_status
+        200
+      end
+
+      def extract_runtimes(event, _payload)
+        { duration: event.duration.to_f.round(2) }
+      end
+    end
+  end
+end

data/lib/lograge/log_subscribers/action_controller.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Lograge
+  module LogSubscribers
+    class ActionController < Base
+      def process_action(event)
+        process_main_event(event)
+      end
+
+      def redirect_to(event)
+        RequestStore.store[:lograge_location] = event.payload[:location]
+      end
+
+      def unpermitted_parameters(event)
+        RequestStore.store[:lograge_unpermitted_params] ||= []
+        RequestStore.store[:lograge_unpermitted_params].concat(event.payload[:keys])
+      end
+
+      private
+
+      def initial_data(payload)
+        {
+          method: payload[:method],
+          path: extract_path(payload),
+          format: extract_format(payload),
+          controller: payload[:controller],
+          action: payload[:action]
+        }
+      end
+
+      def extract_path(payload)
+        path = payload[:path]
+        strip_query_string(path)
+      end
+
+      def strip_query_string(path)
+        index = path.index('?')
+        index ? path[0, index] : path
+      end
+
+      if ::ActionPack::VERSION::MAJOR == 3 && ::ActionPack::VERSION::MINOR.zero?
+        def extract_format(payload)
+          payload[:formats].first
+        end
+      else
+        def extract_format(payload)
+          payload[:format]
+        end
+      end
+
+      def extract_runtimes(event, payload)
+        data = { duration: event.duration.to_f.round(2) }
+        data[:view] = payload[:view_runtime].to_f.round(2) if payload.key?(:view_runtime)
+        data[:db] = payload[:db_runtime].to_f.round(2) if payload.key?(:db_runtime)
+        data
+      end
+
+      def extract_location
+        location = RequestStore.store[:lograge_location]
+        return {} unless location
+
+        RequestStore.store[:lograge_location] = nil
+        { location: strip_query_string(location) }
+      end
+
+      def extract_unpermitted_params
+        unpermitted_params = RequestStore.store[:lograge_unpermitted_params]
+        return {} unless unpermitted_params
+
+        RequestStore.store[:lograge_unpermitted_params] = nil
+        { unpermitted_params: unpermitted_params }
+      end
+    end
+  end
+end

data/lib/lograge/log_subscribers/base.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'action_pack'
+require 'active_support'
+require 'active_support/core_ext/class/attribute'
+require 'active_support/log_subscriber'
+require 'request_store'
+
+module Lograge
+  module LogSubscribers
+    class Base < ActiveSupport::LogSubscriber
+      def logger
+        Lograge.logger.presence || super
+      end
+
+      private
+
+      def process_main_event(event)
+        return if Lograge.ignore?(event)
+
+        payload = event.payload
+        data = extract_request(event, payload)
+        data = before_format(data, payload)
+        formatted_message = Lograge.formatter.call(data)
+        logger.send(Lograge.log_level, formatted_message)
+      end
+
+      def extract_request(event, payload)
+        data = initial_data(payload)
+        data.merge!(extract_status(payload))
+        data.merge!(extract_allocations(event))
+        data.merge!(extract_runtimes(event, payload))
+        data.merge!(extract_location)
+        data.merge!(extract_unpermitted_params)
+        data.merge!(custom_options(event))
+      end
+
+      %i[initial_data extract_status extract_runtimes
+         extract_location extract_unpermitted_params].each do |method_name|
+        define_method(method_name) { |*_arg| {} }
+      end
+
+      def extract_status(payload)
+        if (status = payload[:status])
+          { status: status.to_i }
+        elsif (error = payload[:exception])
+          exception, message = error
+          { status: get_error_status_code(exception), error: "#{exception}: #{message}" }
+        else
+          { status: default_status }
+        end
+      end
+
+      def default_status
+        0
+      end
+
+      def get_error_status_code(exception_class_name)
+        ActionDispatch::ExceptionWrapper.status_code_for_exception(exception_class_name)
+      end
+
+      def extract_allocations(event)
+        if (allocations = (event.respond_to?(:allocations) && event.allocations))
+          { allocations: allocations }
+        else
+          {}
+        end
+      end
+
+      def custom_options(event)
+        options = Lograge.custom_options(event) || {}
+        options.merge event.payload[:custom_payload] || {}
+      end
+
+      def before_format(data, payload)
+        Lograge.before_format(data, payload)
+      end
+    end
+  end
+end

data/lib/lograge/ordered_options.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'active_support'
+require 'active_support/ordered_options'
+
+module Lograge
+  class OrderedOptions < ActiveSupport::OrderedOptions
+    def custom_payload(&block)
+      self.custom_payload_method = block
+    end
+  end
+end

data/lib/lograge/rails_ext/action_cable/channel/base.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Lograge
+  module ActionCable
+    module ChannelInstrumentation
+      def subscribe_to_channel
+        ActiveSupport::Notifications.instrument('subscribe.action_cable', notification_payload('subscribe')) { super }
+      end
+
+      def unsubscribe_from_channel
+        ActiveSupport::Notifications.instrument('unsubscribe.action_cable', notification_payload('unsubscribe')) do
+          super
+        end
+      end
+
+      private
+
+      def notification_payload(method_name)
+        { channel_class: self.class.name, action: method_name }
+      end
+    end
+  end
+end
+
+ActionCable::Channel::Base.prepend(Lograge::ActionCable::ChannelInstrumentation)

data/lib/lograge/rails_ext/action_cable/connection/base.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Lograge
+  module ActionCable
+    module ConnectionInstrumentation
+      def handle_open
+        ActiveSupport::Notifications.instrument('connect.action_cable', notification_payload('connect')) { super }
+      end
+
+      def handle_close
+        ActiveSupport::Notifications.instrument('disconnect.action_cable', notification_payload('disconnect')) { super }
+      end
+
+      def notification_payload(method_name)
+        { connection_class: self.class.name, action: method_name, data: request.params }
+      end
+    end
+  end
+end
+
+ActionCable::Connection::Base.prepend(Lograge::ActionCable::ConnectionInstrumentation)

data/lib/lograge/rails_ext/action_cable/server/base.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module ActionCable
+  module Server
+    class Base
+      mattr_accessor :logger
+      self.logger = Lograge::SilentLogger.new(config.logger)
+    end
+  end
+end

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

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+
+require 'active_support'
 require 'active_support/concern'
 require 'rails/rack/logger'
 
@@ -9,17 +12,19 @@ module Rails
     # that say:
     # Started GET / for 192.168.2.1...
     class Logger
-      # Overwrites Rails 3.2 code that logs new requests
+      # Overwrites Rails code that logs new requests
       def call_app(*args)
         env = args.last
-        @app.call(env)
+        status, headers, body = @app.call(env)
+        # needs to have same return type as the Rails builtins being overridden, see https://github.com/roidrage/lograge/pull/333
+        # https://github.com/rails/rails/blob/be9d34b9bcb448b265114ebc28bef1a5b5e4c272/railties/lib/rails/rack/logger.rb#L37
+        [status, headers, ::Rack::BodyProxy.new(body) {}] # rubocop:disable Lint/EmptyBlock
       ensure
         ActiveSupport::LogSubscriber.flush_all!
       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/lograge/railtie.rb

@@ -1,13 +1,19 @@
+# frozen_string_literal: true
+
 require 'rails/railtie'
 require 'action_view/log_subscriber'
 require 'action_controller/log_subscriber'
 
 module Lograge
   class Railtie < Rails::Railtie
-    config.lograge = ActiveSupport::OrderedOptions.new
+    config.lograge = Lograge::OrderedOptions.new
     config.lograge.enabled = false
 
-    initializer :lograge do |app|
+    initializer :deprecator do |app|
+      app.deprecators[:lograge] = Lograge.deprecator if app.respond_to?(:deprecators)
+    end
+
+    config.after_initialize do |app|
       Lograge.setup(app) if app.config.lograge.enabled
     end
   end

data/lib/lograge/silent_logger.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'delegate'
+
+module Lograge
+  class SilentLogger < SimpleDelegator
+    %i[debug info warn error fatal unknown].each do |method_name|
+      # rubocop:disable Lint/EmptyBlock
+      define_method(method_name) { |*_args| }
+      # rubocop:enable Lint/EmptyBlock
+    end
+  end
+end

data/lib/lograge/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lograge
-  VERSION = '0.3.1'
+  VERSION = '0.14.0'
 end

data/lib/lograge.rb

@@ -1,17 +1,27 @@
+# frozen_string_literal: true
+
 require 'lograge/version'
+require 'lograge/formatters/helpers/method_and_path'
 require 'lograge/formatters/cee'
 require 'lograge/formatters/json'
 require 'lograge/formatters/graylog2'
 require 'lograge/formatters/key_value'
+require 'lograge/formatters/key_value_deep'
 require 'lograge/formatters/l2met'
 require 'lograge/formatters/lines'
 require 'lograge/formatters/logstash'
+require 'lograge/formatters/ltsv'
 require 'lograge/formatters/raw'
-require 'lograge/log_subscriber'
+require 'lograge/log_subscribers/base'
+require 'lograge/log_subscribers/action_cable'
+require 'lograge/log_subscribers/action_controller'
+require 'lograge/silent_logger'
+require 'lograge/ordered_options'
+require 'active_support'
 require 'active_support/core_ext/module/attribute_accessors'
 require 'active_support/core_ext/string/inflections'
-require 'active_support/ordered_options'
 
+# rubocop:disable Metrics/ModuleLength
 module Lograge
   module_function
 
@@ -26,7 +36,7 @@ module Lograge
   mattr_writer :custom_options
   self.custom_options = nil
 
-  def self.custom_options(event)
+  def custom_options(event)
     if @@custom_options.respond_to?(:call)
       @@custom_options.call(event)
     else
@@ -40,7 +50,7 @@ module Lograge
   mattr_writer :before_format
   self.before_format = nil
 
-  def self.before_format(data, payload)
+  def before_format(data, payload)
     result = nil
     result = @@before_format.call(data, payload) if @@before_format
     result || data
@@ -49,7 +59,7 @@ module Lograge
   # Set conditions for events that should be ignored
   #
   # Currently supported formats are:
-  #  - A single string representing a controller action, e.g. 'users#sign_in'
+  #  - A single string representing a controller action, e.g. 'UsersController#sign_in'
   #  - An array of strings representing controller actions
   #  - An object that responds to call with an event argument and returns
   #    true iff the event should be ignored.
@@ -58,18 +68,22 @@ module Lograge
   # are given to 'ignore'.  Both methods can be called multiple times, which
   # just adds more ignore conditions to a list that is checked before logging.
 
-  def self.ignore_actions(actions)
+  def ignore_actions(actions)
     ignore(lambda do |event|
-             params = event.payload[:params]
-             Array(actions).include?("#{params['controller']}##{params['action']}")
+             params = event.payload
+             Array(actions).include?("#{controller_field(params)}##{params[:action]}")
            end)
   end
 
+  def controller_field(params)
+    params[:controller] || params[:channel_class] || params[:connection_class]
+  end
+
   def ignore_tests
     @ignore_tests ||= []
   end
 
-  def self.ignore(test)
+  def ignore(test)
     ignore_tests.push(test) if test
   end
 
@@ -77,7 +91,7 @@ module Lograge
     @ignore_tests = []
   end
 
-  def self.ignore?(event)
+  def ignore?(event)
     ignore_tests.any? { |ignore_test| ignore_test.call(event) }
   end
 
@@ -92,7 +106,7 @@ module Lograge
   #  - :logstash - JSON formatted as a Logstash Event.
   mattr_accessor :formatter
 
-  def self.remove_existing_log_subscriptions
+  def remove_existing_log_subscriptions
     ActiveSupport::LogSubscriber.log_subscribers.each do |subscriber|
       case subscriber
       when ActionView::LogSubscriber
@@ -103,38 +117,98 @@ module Lograge
     end
   end
 
-  def self.unsubscribe(component, subscriber)
+  def unsubscribe(component, subscriber)
     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
+      Lograge.notification_listeners_for("#{event}.#{component}").each do |listener|
+        ActiveSupport::Notifications.unsubscribe listener if listener.instance_variable_get('@delegate') == subscriber
       end
     end
   end
 
-  def self.setup(app)
+  def setup(app)
     self.application = app
-    app.config.action_dispatch.rack_cache[:verbose] = false if app.config.action_dispatch.rack_cache
+    disable_rack_cache_verbose_output
+    keep_original_rails_log
+
+    attach_to_action_controller
+    attach_to_action_cable if defined?(ActionCable)
+
+    set_lograge_log_options
+    setup_custom_payload
+    support_deprecated_config # TODO: Remove with version 1.0
+    set_formatter
+    set_ignores
+  end
+
+  def set_ignores
+    Lograge.ignore_actions(lograge_config.ignore_actions)
+    Lograge.ignore(lograge_config.ignore_custom)
+  end
 
-    unless app.config.lograge.keep_original_rails_log
-      require 'lograge/rails_ext/rack/logger'
-      Lograge.remove_existing_log_subscriptions
+  def set_formatter
+    Lograge.formatter = lograge_config.formatter || Lograge::Formatters::KeyValue.new
+  end
+
+  def attach_to_action_controller
+    Lograge::LogSubscribers::ActionController.attach_to :action_controller
+  end
+
+  def attach_to_action_cable
+    require 'lograge/rails_ext/action_cable/channel/base'
+    require 'lograge/rails_ext/action_cable/connection/base'
+
+    Lograge::LogSubscribers::ActionCable.attach_to :action_cable
+  end
+
+  def setup_custom_payload
+    return unless lograge_config.custom_payload_method.respond_to?(:call)
+
+    base_classes = Array(lograge_config.base_controller_class)
+    base_classes.map! { |klass| klass.try(:constantize) }
+    base_classes << ActionController::Base if base_classes.empty?
+
+    base_classes.each do |base_class|
+      extend_base_class(base_class)
     end
+  end
 
-    Lograge.logger = app.config.lograge.logger
+  def extend_base_class(klass)
+    append_payload_method = klass.instance_method(:append_info_to_payload)
+    custom_payload_method = lograge_config.custom_payload_method
 
-    Lograge::RequestLogSubscriber.attach_to :action_controller
+    klass.send(:define_method, :append_info_to_payload) do |payload|
+      append_payload_method.bind(self).call(payload)
+      payload[:custom_payload] = custom_payload_method.call(self)
+    end
+  end
+
+  def set_lograge_log_options
+    Lograge.logger = lograge_config.logger
     Lograge.custom_options = lograge_config.custom_options
     Lograge.before_format = lograge_config.before_format
     Lograge.log_level = lograge_config.log_level || :info
-    support_deprecated_config # TODO: Remove with version 1.0
-    Lograge.formatter = lograge_config.formatter || Lograge::Formatters::KeyValue.new
-    Lograge.ignore_actions(lograge_config.ignore_actions)
-    Lograge.ignore(lograge_config.ignore_custom)
   end
 
+  def disable_rack_cache_verbose_output
+    application.config.action_dispatch.rack_cache[:verbose] = false if rack_cache_hashlike?(application)
+  end
+
+  def keep_original_rails_log
+    return if lograge_config.keep_original_rails_log
+
+    require 'lograge/rails_ext/rack/logger'
+
+    require 'lograge/rails_ext/action_cable/server/base' if defined?(ActionCable)
+
+    Lograge.remove_existing_log_subscriptions
+  end
+
+  def rack_cache_hashlike?(app)
+    app.config.action_dispatch.rack_cache&.respond_to?(:[]=)
+  end
+  private_class_method :rack_cache_hashlike?
+
   # TODO: Remove with version 1.0
 
   def support_deprecated_config
@@ -142,7 +216,7 @@ module Lograge
 
     legacy_log_format = lograge_config.log_format
     warning = 'config.lograge.log_format is deprecated. Use config.lograge.formatter instead.'
-    ActiveSupport::Deprecation.warn(warning, caller)
+    deprecator.warn(warning, caller)
     legacy_log_format = :key_value if legacy_log_format == :lograge
     lograge_config.formatter = "Lograge::Formatters::#{legacy_log_format.to_s.classify}".constantize.new
   end
@@ -150,6 +224,22 @@ module Lograge
   def lograge_config
     application.config.lograge
   end
+
+  def deprecator
+    @deprecator ||= ActiveSupport::Deprecation.new('1.0', 'Lograge')
+  end
+
+  if ::ActiveSupport::VERSION::MAJOR >= 8 ||
+     (::ActiveSupport::VERSION::MAJOR >= 7 && ::ActiveSupport::VERSION::MINOR >= 1)
+    def notification_listeners_for(name)
+      ActiveSupport::Notifications.notifier.all_listeners_for(name)
+    end
+  else
+    def notification_listeners_for(name)
+      ActiveSupport::Notifications.notifier.listeners_for(name)
+    end
+  end
 end
+# rubocop:enable Metrics/ModuleLength
 
 require 'lograge/railtie' if defined?(Rails)

metadata

@@ -1,112 +1,155 @@
 --- !ruby/object:Gem::Specification
 name: lograge
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.14.0
 platform: ruby
 authors:
 - Mathias Meyer
 - Ben Lovell
-autorequire: 
+- Michael Bianco
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-01-17 00:00:00.000000000 Z
+date: 2023-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.1'
 - !ruby/object:Gem::Dependency
-  name: guard-rspec
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.23'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.23'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+- !ruby/object:Gem::Dependency
+  name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '4'
 - !ruby/object:Gem::Dependency
-  name: actionpack
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: request_store
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description: Tame Rails' multi-line logging into a single line per request
 email:
 - meyer@paperplanes.de
 - benjamin.lovell@gmail.com
+- mike@mikebian.co
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE.txt
 - lib/lograge.rb
 - lib/lograge/formatters/cee.rb
 - lib/lograge/formatters/graylog2.rb
+- lib/lograge/formatters/helpers/method_and_path.rb
 - lib/lograge/formatters/json.rb
 - lib/lograge/formatters/key_value.rb
+- lib/lograge/formatters/key_value_deep.rb
 - lib/lograge/formatters/l2met.rb
 - lib/lograge/formatters/lines.rb
 - lib/lograge/formatters/logstash.rb
+- lib/lograge/formatters/ltsv.rb
 - lib/lograge/formatters/raw.rb
-- lib/lograge/log_subscriber.rb
+- lib/lograge/log_subscribers/action_cable.rb
+- lib/lograge/log_subscribers/action_controller.rb
+- lib/lograge/log_subscribers/base.rb
+- lib/lograge/ordered_options.rb
+- lib/lograge/rails_ext/action_cable/channel/base.rb
+- lib/lograge/rails_ext/action_cable/connection/base.rb
+- lib/lograge/rails_ext/action_cable/server/base.rb
 - lib/lograge/rails_ext/rack/logger.rb
 - lib/lograge/railtie.rb
+- lib/lograge/silent_logger.rb
 - lib/lograge/version.rb
 homepage: https://github.com/roidrage/lograge
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+  changelog_uri: https://github.com/roidrage/lograge/blob/master/CHANGELOG.md
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -114,16 +157,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: Tame Rails' multi-line logging into a single line per request
 test_files: []

data/lib/lograge/log_subscriber.rb

@@ -1,96 +0,0 @@
-require 'json'
-
-require 'active_support/core_ext/class/attribute'
-require 'active_support/log_subscriber'
-
-module Lograge
-  class RequestLogSubscriber < ActiveSupport::LogSubscriber
-    def process_action(event)
-      return if Lograge.ignore?(event)
-
-      payload = event.payload
-
-      data      = extract_request(payload)
-      extract_status(data, payload)
-      runtimes(data, event)
-      location(data)
-      custom_options(data, event)
-
-      data = before_format(data, payload)
-      formatted_message = Lograge.formatter.call(data)
-      logger.send(Lograge.log_level, formatted_message)
-    end
-
-    def redirect_to(event)
-      Thread.current[:lograge_location] = event.payload[:location]
-    end
-
-    def logger
-      Lograge.logger.presence || super
-    end
-
-    private
-
-    def extract_request(payload)
-      {
-        method: payload[:method],
-        path: extract_path(payload),
-        format: extract_format(payload),
-        controller: payload[:params]['controller'],
-        action: payload[:params]['action']
-      }
-    end
-
-    def extract_path(payload)
-      path = payload[:path]
-      index = path.index('?')
-      index ? path[0, index] : path
-    end
-
-    if ::ActionPack::VERSION::MAJOR == 3 && ::ActionPack::VERSION::MINOR == 0
-      def extract_format(payload)
-        payload[:formats].first
-      end
-    else
-      def extract_format(payload)
-        payload[:format]
-      end
-    end
-
-    def extract_status(data, payload)
-      if (status = payload[:status])
-        data[:status] = status.to_i
-      elsif (error = payload[:exception])
-        exception, message = error
-        data[:status] = 500
-        data[:error]  = "#{exception}:#{message}"
-      else
-        data[:status] = 0
-      end
-    end
-
-    def custom_options(data, event)
-      options = Lograge.custom_options(event)
-      data.merge! options if options
-    end
-
-    def before_format(data, payload)
-      Lograge.before_format(data, payload)
-    end
-
-    def runtimes(data, event)
-      payload = event.payload
-      data[:duration] = event.duration.to_f.round(2)
-      data[:view]     = payload[:view_runtime].to_f.round(2) if payload.key?(:view_runtime)
-      data[:db]       = payload[:db_runtime].to_f.round(2) if payload.key?(:db_runtime)
-    end
-
-    def location(data)
-      location = Thread.current[:lograge_location]
-      return unless location
-
-      Thread.current[:lograge_location] = nil
-      data[:location] = location
-    end
-  end
-end