rails_semantic_logger 4.17.0 → 4.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a96d9dc4eb844eb8561d52f66dc27e2e07edb6b61da2163b0351ce3b12759ff
-  data.tar.gz: 34145d723bd89d14e5377200862df57829739b2ee5e5422a58f1d0edd4cbff0f
+  metadata.gz: db5e6b03ccd16cbe212ef23f0fad1e7f14138f8b2e22e7572613aa3e52d5b66d
+  data.tar.gz: d46ee20a271e77d51f551926629257d221db96301facefe7be9a641d9ddffc77
 SHA512:
-  metadata.gz: e99c63ad9e4d02377d5ea25ba528f5de4fa8f83a2aadd7ef19ef2e3b8f52fc67cd2d08130ec18478ab4e5a2785657928f4e863024d8214a76de3bff4618b6891
-  data.tar.gz: 2d6ccc0cb9e385a2ca3a0fdc65023948f968a83b044768fc9bc9ccfb78452d7d4325731cdc4c5397bb097efa1ad72a1ce05d5576429cb2eb05b8c984fa7f06bb
+  metadata.gz: f07be5e786b9f93669b278027cf2ba578132dc90ec3e6aa575c0df7b85fdd851d9d54965172a59bf7e9b40ad002d4fd0bd1a677ee8c3b77de129010c2b93b781
+  data.tar.gz: ebcc3799d581accf18af62739310ed25d183346c72a5006fa32a5a82f828a7371a9607df9646664574fd164be524ab76fa0c23f3845632285d76457134ed90f7

data/lib/rails_semantic_logger/action_controller/log_subscriber.rb

@@ -3,9 +3,13 @@ module RailsSemanticLogger
     class LogSubscriber < ActiveSupport::LogSubscriber
       INTERNAL_PARAMS = %w[controller action format _method only_path].freeze
 
+      class << self
+        attr_accessor :action_message_format
+      end
+
       # Log as debug to hide Processing messages in production
       def start_processing(event)
-        controller_logger(event).debug { "Processing ##{event.payload[:action]}" }
+        controller_logger(event).debug { action_message("Processing", event.payload) }
       end
 
       def process_action(event)
@@ -59,7 +63,7 @@ module RailsSemanticLogger
           payload.delete(:response)
 
           {
-            message:  "Completed ##{payload[:action]}",
+            message:  action_message("Completed", event.payload),
             duration: event.duration,
             payload:  payload
           }
@@ -122,6 +126,14 @@ module RailsSemanticLogger
         index = path.index("?")
         index ? path[0, index] : path
       end
+
+      def action_message(message, payload)
+        if self.class.action_message_format
+          self.class.action_message_format.call(message, payload)
+        else
+          "#{message} ##{payload[:action]}"
+        end
+      end
     end
   end
 end

data/lib/rails_semantic_logger/active_record/log_subscriber.rb

@@ -33,6 +33,7 @@ module RailsSemanticLogger
         log_payload[:binds] = bind_values(payload) unless (payload[:binds] || []).empty?
         log_payload[:allocations] = event.allocations if event.respond_to?(:allocations)
         log_payload[:cached] = event.payload[:cached]
+        log_payload[:async] = true if event.payload[:async]
 
         log = {
           message:  name,
@@ -54,11 +55,25 @@ module RailsSemanticLogger
 
       # When multiple values are received for a single bound field, it is converted into an array
       def add_bind_value(binds, key, value)
-        key        = key.downcase.to_sym unless key.nil?
-        value      = (Array(binds[key]) << value) if binds.key?(key)
+        key = key.downcase.to_sym unless key.nil?
+
+        if rails_filter_params_include?(key)
+          value = "[FILTERED]"
+        elsif binds.key?(key)
+          value = (Array(binds[key]) << value)
+        end
+
         binds[key] = value
       end
 
+      def rails_filter_params_include?(key)
+        filter_parameters = Rails.configuration.filter_parameters
+
+        return filter_parameters.first.match? key if filter_parameters.first.is_a? Regexp
+
+        filter_parameters.include? key
+      end
+
       def logger
         self.class.logger
       end
@@ -196,8 +211,8 @@ module RailsSemanticLogger
         alias bind_values bind_values_v5_0_3
         alias render_bind render_bind_v5_0_3
         alias type_casted_binds type_casted_binds_v5_0_3
-      elsif (Rails::VERSION::MAJOR == 6 && Rails::VERSION::MINOR > 0) || # ~> 6.1.0
-            Rails::VERSION::MAJOR == 7
+      elsif (Rails::VERSION::MAJOR == 6 && Rails::VERSION::MINOR > 0) ||
+            Rails::VERSION::MAJOR >= 7 # ~> 6.1.0 && >= 7.x.x
         alias bind_values bind_values_v6_1
         alias render_bind render_bind_v6_1
         alias type_casted_binds type_casted_binds_v5_1_5

data/lib/rails_semantic_logger/engine.rb

@@ -226,6 +226,7 @@ module RailsSemanticLogger
         if defined?(::ActionController)
           require "action_controller/log_subscriber"
 
+          RailsSemanticLogger::ActionController::LogSubscriber.action_message_format = config.rails_semantic_logger.action_message_format
           RailsSemanticLogger.swap_subscriber(
             ::ActionController::LogSubscriber,
             RailsSemanticLogger::ActionController::LogSubscriber,
@@ -265,6 +266,12 @@ module RailsSemanticLogger
       # Re-open appenders after Spring has forked a process
       Spring.after_fork { |_job| ::SemanticLogger.reopen } if defined?(Spring.after_fork)
 
+      # Re-open appenders after SolidQueue worker/dispatcher/scheduler has finished booting
+      SolidQueue.on_start { ::SemanticLogger.reopen } if defined?(SolidQueue.on_start)
+      SolidQueue.on_worker_start { ::SemanticLogger.reopen } if defined?(SolidQueue.on_worker_start)
+      SolidQueue.on_dispatcher_start { ::SemanticLogger.reopen } if defined?(SolidQueue.on_dispatcher_start)
+      SolidQueue.on_scheduler_start { ::SemanticLogger.reopen } if defined?(SolidQueue.on_scheduler_start)
+
       console do |_app|
         # Don't use a background thread for logging
         SemanticLogger.sync!

data/lib/rails_semantic_logger/extensions/action_dispatch/debug_exceptions.rb

@@ -7,15 +7,19 @@ module ActionDispatch
 
     undef_method :log_error
     if (Rails::VERSION::MAJOR == 7 && Rails::VERSION::MINOR >= 1) || Rails::VERSION::MAJOR > 7
-      def log_error(_request, wrapper)
+      def log_error(request, wrapper)
         Rails.application.deprecators.silence do
-          ActionController::Base.logger.fatal(wrapper.exception)
+          return if !log_rescued_responses?(request) && wrapper.rescue_response?
+
+          level = request.get_header("action_dispatch.debug_exception_log_level")
+          ActionController::Base.logger.log(level, wrapper.exception)
         end
       end
     else
       def log_error(_request, wrapper)
         ActiveSupport::Deprecation.silence do
-          ActionController::Base.logger.fatal(wrapper.exception)
+          level = wrapper.respond_to?(:rescue_response?) && wrapper.rescue_response? ? :debug : :fatal
+          ActionController::Base.logger.log(level, wrapper.exception)
         end
       end
     end

data/lib/rails_semantic_logger/options.rb

@@ -22,14 +22,14 @@ module RailsSemanticLogger
   #
   #     config.rails_semantic_logger.rendered = false
   #
-  # * Override the Awesome Print options for logging Hash data as text:
+  # * Override the Amazing Print options for logging Hash data as text:
   #
-  #     Any valid AwesomePrint option for rendering data.
+  #     Any valid Amazing Print option for rendering data.
   #     The defaults can changed be creating a `~/.aprc` file.
-  #     See: https://github.com/michaeldv/awesome_print
+  #     See: https://github.com/amazing-print/amazing_print
   #
   #     Note: The option :multiline is set to false if not supplied.
-  #     Note: Has no effect if Awesome Print is not installed.
+  #     Note: Has no effect if Amazing Print is not installed.
   #
   #        config.rails_semantic_logger.ap_options = {multiline: false}
   #
@@ -100,23 +100,32 @@ module RailsSemanticLogger
   # * named_tags: *DEPRECATED*
   #   Instead, supply a Hash to config.log_tags
   #   config.rails_semantic_logger.named_tags = nil
+  #
+  # * Change the message format of Action Controller action.
+  #   A block that will be called to format the message.
+  #   It is supplied with the `message` and `payload` and should return the formatted data.
+  #
+  #     config.rails_semantic_logger.action_message_format = -> (message, payload) do
+  #       "#{message} - #{payload[:controller]}##{payload[:action]}"
+  #     end
   class Options
     attr_accessor :semantic, :started, :processing, :rendered, :ap_options, :add_file_appender,
-                  :quiet_assets, :format, :named_tags, :filter, :console_logger
+                  :quiet_assets, :format, :named_tags, :filter, :console_logger, :action_message_format
 
     # Setup default values
     def initialize
-      @semantic          = true
-      @started           = false
-      @processing        = false
-      @rendered          = false
-      @ap_options        = {multiline: false}
-      @add_file_appender = true
-      @quiet_assets      = false
-      @format            = :default
-      @named_tags        = nil
-      @filter            = nil
-      @console_logger    = true
+      @semantic              = true
+      @started               = false
+      @processing            = false
+      @rendered              = false
+      @ap_options            = {multiline: false}
+      @add_file_appender     = true
+      @quiet_assets          = false
+      @format                = :default
+      @named_tags            = nil
+      @filter                = nil
+      @console_logger        = true
+      @action_message_format = nil
     end
   end
 end

data/lib/rails_semantic_logger/rack/logger.rb

@@ -36,10 +36,18 @@ module RailsSemanticLogger
 
       def call_app(request, env)
         instrumenter        = ActiveSupport::Notifications.instrumenter
-        instrumenter_state  = instrumenter.start "request.action_dispatch", request: request
-        instrumenter_finish = lambda {
-          instrumenter.finish_with_state(instrumenter_state, "request.action_dispatch", request: request)
-        }
+        if (Rails::VERSION::MAJOR == 7 && Rails::VERSION::MINOR >= 1) || Rails::VERSION::MAJOR > 7
+          handle              = instrumenter.build_handle "request.action_dispatch", request: request
+          instrumenter_finish = lambda {
+            handle.finish
+          }
+          handle.start
+        else
+          instrumenter_state  = instrumenter.start "request.action_dispatch", request: request
+          instrumenter_finish = lambda {
+            instrumenter.finish_with_state(instrumenter_state, "request.action_dispatch", request: request)
+          }
+        end
 
         logger.send(self.class.started_request_log_level) { started_request_message(request) }
         status, headers, body = @app.call(env)

data/lib/rails_semantic_logger/sidekiq/defaults.rb

@@ -9,7 +9,7 @@ module RailsSemanticLogger
             unless ctx.empty?
               job_hash = ctx[:job] || {}
               klass    = job_hash["display_class"] || job_hash["wrapped"] || job_hash["class"]
-              logger   = klass ? SemanticLogger[klass] : Sidekiq.logger
+              logger   = klass ? SemanticLogger[klass] : ::Sidekiq.logger
               ctx[:context] ? logger.warn(ctx[:context], ctx) : logger.warn(ctx)
             end
           end
@@ -18,7 +18,7 @@ module RailsSemanticLogger
             unless ctx.empty?
               job_hash = ctx[:job] || {}
               klass    = job_hash["display_class"] || job_hash["wrapped"] || job_hash["class"]
-              logger   = klass ? SemanticLogger[klass] : Sidekiq.logger
+              logger   = klass ? SemanticLogger[klass] : ::Sidekiq.logger
               ctx[:context] ? logger.warn(ctx[:context], ctx) : logger.warn(ctx)
             end
           end

data/lib/rails_semantic_logger/version.rb

@@ -1,3 +1,3 @@
 module RailsSemanticLogger
-  VERSION = "4.17.0".freeze
+  VERSION = "4.18.0".freeze
 end

data/lib/rails_semantic_logger.rb

@@ -49,7 +49,7 @@ module RailsSemanticLogger
 
   def self.unattach(subscriber)
     subscriber_patterns(subscriber).each do |pattern|
-      ActiveSupport::Notifications.notifier.listeners_for(pattern).each do |sub|
+      listeners_for(ActiveSupport::Notifications.notifier, pattern).each do |sub|
         next unless sub.instance_variable_get(:@delegate) == subscriber
 
         ActiveSupport::Notifications.unsubscribe(sub)
@@ -67,7 +67,15 @@ module RailsSemanticLogger
     end
   end
 
-  private_class_method :subscriber_patterns, :unattach
+  def self.listeners_for(notifier, pattern)
+    if notifier.respond_to?(:all_listeners_for) # Rails >= 7.1
+      notifier.all_listeners_for(pattern)
+    else
+      notifier.listeners_for(pattern)
+    end
+  end
+
+  private_class_method :listeners_for, :subscriber_patterns, :unattach
 end
 
 require("rails_semantic_logger/extensions/mongoid/config") if defined?(Mongoid)

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rails_semantic_logger
 version: !ruby/object:Gem::Version
-  version: 4.17.0
+  version: 4.18.0
 platform: ruby
 authors:
 - Reid Morrison
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-05 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -52,8 +51,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.16'
-description:
-email:
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -95,9 +92,8 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/reidmorrison/rails_semantic_logger/issues
   documentation_uri: https://logger.rocketjob.io
-  source_code_uri: https://github.com/reidmorrison/rails_semantic_logger/tree/v4.17.0
+  source_code_uri: https://github.com/reidmorrison/rails_semantic_logger/tree/v4.18.0
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -112,8 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Feature rich logging framework that replaces the Rails logger.
 test_files: []