rails_semantic_logger 4.11.0 → 4.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6944c99a390bc385a4d5a83daea0fc340dbd4dd2913631ae3a812590ec1503e4
-  data.tar.gz: ebb36106bde192de58b716077fc4c1b5c51d474ee9e86e5a93ef4a77fc25d1be
+  metadata.gz: b82f4b18da96047400658caaf0cbdb073ac21d0d9dfc9f8e89a270fae80550af
+  data.tar.gz: fcef56ce1f917619d302b3dced8680748f0945c3a5a16763aadf21007ef1a00d
 SHA512:
-  metadata.gz: 1e1cf6df574f6dd146029407d80d2a4b51e1bfb222dbf511dbc6b540070e8d7432cff0eaf4cf94227b2d5440eb21c2ebab7222db774dd9408ebda613ae0df3bf
-  data.tar.gz: 2da852f09a5417bc91e155f1bb80d9a1c50baa823cd39c46ee2ea7a9ecfa366f95b551c996a3a295d6074424224fd5aaf390c14c7f08b88effdcae31486d3bc4
+  metadata.gz: 6ca5b2a92ca494065abb52d7d44eb71e06ba044f190c10b710549b609f78924542eb4f5eb126c54f98bc1248daaa7e1e29b35139c527081f178c1119be76acdc
+  data.tar.gz: 604c669579b6bf2e25b718008406fd2a5bfcacd32f39a5714b05656773e59634d15d10d3afd0277c098bc73f5836e577ad1412669947598b206f22e5af4379d4

data/lib/rails_semantic_logger/action_controller/log_subscriber.rb

@@ -14,12 +14,22 @@ module RailsSemanticLogger
 
           # Unused, but needed for Devise 401 status code monkey patch to still work.
           ::ActionController::Base.log_process_action(payload)
+          
+          params = payload[:params]
 
-          # According to PR https://github.com/reidmorrison/rails_semantic_logger/pull/37/files
-          # payload[:params] is not always a Hash.
-          payload[:params] = payload[:params].to_unsafe_h unless payload[:params].is_a?(Hash)
-          payload[:params] = payload[:params].except(*INTERNAL_PARAMS)
-          payload.delete(:params) if payload[:params].empty?
+          if params.kind_of?(Hash) || params.kind_of?(::ActionController::Parameters)
+            # According to PR https://github.com/reidmorrison/rails_semantic_logger/pull/37/files
+            # params is not always a Hash.
+            payload[:params] = params.to_unsafe_h unless params.is_a?(Hash)
+            payload[:params] = params.except(*INTERNAL_PARAMS)
+
+            if payload[:params].empty?
+              payload.delete(:params)
+            elsif params["file"]
+              # When logging to JSON the entire tempfile is logged, so convert it to a string.
+              payload[:params]["file"] = params["file"].inspect
+            end
+          end
 
           format           = payload[:format]
           payload[:format] = format.to_s.upcase if format.is_a?(Symbol)
@@ -48,12 +58,6 @@ module RailsSemanticLogger
           payload.delete(:request)
           payload.delete(:response)
 
-          params = payload[:params]
-          if params
-            # When logging to JSON the entire tempfile is logged, so convert it to a string.
-            params["file"] = params["file"].inspect if params["file"]
-          end
-
           {
             message:  "Completed ##{payload[:action]}",
             duration: event.duration,

data/lib/rails_semantic_logger/action_mailer/log_subscriber.rb

@@ -9,7 +9,7 @@ module RailsSemanticLogger
         message_id = event.payload[:message_id]
         duration = event.duration.round(1)
         if ex
-         log_with_formatter event: event, log_duration: true, level: :error do |fmt|
+          log_with_formatter event: event, log_duration: true, level: :error do |fmt|
             {
               message: "Error delivering mail #{message_id} (#{duration}ms)",
               exception: ex
@@ -17,7 +17,7 @@ module RailsSemanticLogger
           end
         else
           message = begin
-          if event.payload[:perform_deliveries]
+            if event.payload[:perform_deliveries]
               "Delivered mail #{message_id} (#{duration}ms)"
             else
               "Skipped delivery of mail #{message_id} as `perform_deliveries` is false"
@@ -92,7 +92,7 @@ module RailsSemanticLogger
         end
 
         def formatted_args
-          if defined?(mailer.contantize.log_arguments?) && !mailer.contantize.log_arguments?
+          if defined?(mailer.constantize.log_arguments?) && !mailer.constantize.log_arguments?
             ""
           else
             JSON.pretty_generate(event.payload[:args].map { |arg| format(arg) }) if event.payload[:args].present?

data/lib/rails_semantic_logger/action_view/log_subscriber.rb

@@ -19,10 +19,10 @@ module RailsSemanticLogger
       def render_template(event)
         return unless should_log?
 
-        payload = {
+        payload               = {
           template: from_rails_root(event.payload[:identifier])
         }
-        payload[:within] = from_rails_root(event.payload[:layout]) if event.payload[:layout]
+        payload[:within]      = from_rails_root(event.payload[:layout]) if event.payload[:layout]
         payload[:allocations] = event.allocations if event.respond_to?(:allocations)
 
         logger.measure(
@@ -36,11 +36,11 @@ module RailsSemanticLogger
       def render_partial(event)
         return unless should_log?
 
-        payload = {
+        payload               = {
           partial: from_rails_root(event.payload[:identifier])
         }
-        payload[:within] = from_rails_root(event.payload[:layout]) if event.payload[:layout]
-        payload[:cache]  = event.payload[:cache_hit] unless event.payload[:cache_hit].nil?
+        payload[:within]      = from_rails_root(event.payload[:layout]) if event.payload[:layout]
+        payload[:cache]       = event.payload[:cache_hit] unless event.payload[:cache_hit].nil?
         payload[:allocations] = event.allocations if event.respond_to?(:allocations)
 
         logger.measure(
@@ -56,11 +56,11 @@ module RailsSemanticLogger
 
         identifier = event.payload[:identifier] || "templates"
 
-        payload = {
+        payload               = {
           template: from_rails_root(identifier),
           count:    event.payload[:count]
         }
-        payload[:cache_hits] = event.payload[:cache_hits] if event.payload[:cache_hits]
+        payload[:cache_hits]  = event.payload[:cache_hits] if event.payload[:cache_hits]
         payload[:allocations] = event.allocations if event.respond_to?(:allocations)
 
         logger.measure(
@@ -72,16 +72,58 @@ module RailsSemanticLogger
       end
 
       def start(name, id, payload)
-        if (name == "render_template.action_view") && should_log?
-          payload          = {template: from_rails_root(payload[:identifier])}
+        if (name == "render_template.action_view" || name == "render_layout.action_view") && should_log?
+          qualifier        = " layout" if name == "render_layout.action_view"
+          payload          = { template: from_rails_root(payload[:identifier]) }
           payload[:within] = from_rails_root(payload[:layout]) if payload[:layout]
 
-          logger.send(self.class.rendered_log_level, message: "Rendering", payload: payload)
+          logger.send(self.class.rendered_log_level, message: "Rendering#{qualifier}", payload: payload)
         end
 
         super
       end
 
+      if (Rails::VERSION::MAJOR == 7 && Rails::VERSION::MINOR >= 1) || Rails::VERSION::MAJOR > 7
+        class Start # :nodoc:
+          def start(name, id, payload)
+            return unless %w[render_template.action_view render_layout.action_view].include?(name)
+
+            qualifier        = " layout" if name == "render_layout.action_view"
+            payload          = { template: from_rails_root(payload[:identifier]) }
+            payload[:within] = from_rails_root(payload[:layout]) if payload[:layout]
+
+            logger.debug(message: "Rendering#{qualifier}", payload: payload)
+          end
+
+          def finish(name, id, payload) end
+
+          private
+
+          def from_rails_root(string)
+            string = string.sub(rails_root, "")
+            string.sub!(VIEWS_PATTERN, "")
+            string
+          end
+
+          def rails_root # :doc:
+            @root ||= "#{Rails.root}/"
+          end
+
+          def logger
+            @logger ||= SemanticLogger["ActionView"]
+          end
+        end
+
+        def self.attach_to(*)
+          ActiveSupport::Notifications.unsubscribe("render_template.action_view")
+          ActiveSupport::Notifications.unsubscribe("render_layout.action_view")
+          ActiveSupport::Notifications.subscribe("render_template.action_view", RailsSemanticLogger::ActionView::LogSubscriber::Start.new)
+          ActiveSupport::Notifications.subscribe("render_layout.action_view", RailsSemanticLogger::ActionView::LogSubscriber::Start.new)
+
+          super
+        end
+      end
+
       private
 
       @logger             = SemanticLogger["ActionView"]

data/lib/rails_semantic_logger/active_job/log_subscriber.rb

@@ -4,14 +4,44 @@ module RailsSemanticLogger
   module ActiveJob
     class LogSubscriber < ::ActiveSupport::LogSubscriber
       def enqueue(event)
-        log_with_formatter event: event do |fmt|
-          {message: "Enqueued #{fmt.job_info}"}
+        ex = event.payload[:exception_object]
+
+        if ex
+          log_with_formatter level: :error, event: event do |fmt|
+            {
+              message: "Failed enqueuing #{fmt.job_info} (#{ex.class} (#{ex.message})",
+              exception: ex
+            }
+          end
+        elsif event.payload[:aborted]
+          log_with_formatter level: :info, event: event do |fmt|
+            { message: "Failed enqueuing #{fmt.job_info}, a before_enqueue callback halted the enqueuing execution." }
+          end
+        else
+          log_with_formatter event: event do |fmt|
+            { message: "Enqueued #{fmt.job_info}" }
+          end
         end
       end
 
       def enqueue_at(event)
-        log_with_formatter event: event do |fmt|
-          {message: "Enqueued #{fmt.job_info} at #{fmt.scheduled_at}"}
+        ex = event.payload[:exception_object]
+
+        if ex
+          log_with_formatter level: :error, event: event do |fmt|
+            {
+              message: "Failed enqueuing #{fmt.job_info} (#{ex.class} (#{ex.message})",
+              exception: ex
+            }
+          end
+        elsif event.payload[:aborted]
+          log_with_formatter level: :info, event: event do |fmt|
+            { message: "Failed enqueuing #{fmt.job_info}, a before_enqueue callback halted the enqueuing execution." }
+          end
+        else
+          log_with_formatter event: event do |fmt|
+            {message: "Enqueued #{fmt.job_info} at #{fmt.scheduled_at}"}
+          end
         end
       end
 

data/lib/rails_semantic_logger/engine.rb

@@ -1,7 +1,4 @@
 require "rails"
-require "action_controller/log_subscriber"
-require "action_view/log_subscriber"
-require "action_mailer/log_subscriber"
 require "rails_semantic_logger/options"
 
 module RailsSemanticLogger
@@ -111,7 +108,14 @@ module RailsSemanticLogger
       Resque.logger        = SemanticLogger[Resque] if defined?(Resque) && Resque.respond_to?(:logger=)
 
       # Replace the Sidekiq logger
-      Sidekiq.logger       = SemanticLogger[Sidekiq] if defined?(Sidekiq) && Sidekiq.respond_to?(:logger=)
+      if defined?(Sidekiq)
+        if Sidekiq.respond_to?(:logger=)
+          Sidekiq.logger = SemanticLogger[Sidekiq]
+        elsif Sidekiq::VERSION[0..1] == '7.'
+          method = Sidekiq.server? ? :configure_server : :configure_client
+          Sidekiq.public_send(method) { |cfg| cfg.logger = SemanticLogger[Sidekiq] }
+        end
+      end
 
       # Replace the Sidetiq logger
       Sidetiq.logger       = SemanticLogger[Sidetiq] if defined?(Sidetiq) && Sidetiq.respond_to?(:logger=)
@@ -123,7 +127,7 @@ module RailsSemanticLogger
       end
 
       # Replace the Bugsnag logger
-      Bugsnag.configure { |config| config.logger = SemanticLogger[Bugsnag] } if defined?(Bugsnag)
+      Bugsnag.configure(false) { |config| config.logger = SemanticLogger[Bugsnag] } if defined?(Bugsnag)
 
       # Set the IOStreams PGP logger
       IOStreams::Pgp.logger = SemanticLogger["IOStreams::Pgp"] if defined?(IOStreams)
@@ -134,7 +138,7 @@ module RailsSemanticLogger
       config = Rails.application.config
 
       # Replace the Bugsnag logger
-      Bugsnag.configure { |bugsnag_config| bugsnag_config.logger = SemanticLogger[Bugsnag] } if defined?(Bugsnag)
+      Bugsnag.configure(false) { |bugsnag_config| bugsnag_config.logger = SemanticLogger[Bugsnag] } if defined?(Bugsnag)
 
       # Rails Patches
       require("rails_semantic_logger/extensions/action_cable/tagged_logger_proxy") if defined?(::ActionCable)
@@ -186,26 +190,38 @@ module RailsSemanticLogger
         end
 
         # Action View
-        RailsSemanticLogger::ActionView::LogSubscriber.rendered_log_level = :info if config.rails_semantic_logger.rendered
-        RailsSemanticLogger.swap_subscriber(
-          ::ActionView::LogSubscriber,
-          RailsSemanticLogger::ActionView::LogSubscriber,
-          :action_view
-        )
+        if defined?(::ActionView)
+          require "action_view/log_subscriber"
+
+          RailsSemanticLogger::ActionView::LogSubscriber.rendered_log_level = :info if config.rails_semantic_logger.rendered
+          RailsSemanticLogger.swap_subscriber(
+            ::ActionView::LogSubscriber,
+            RailsSemanticLogger::ActionView::LogSubscriber,
+            :action_view
+          )
+        end
 
         # Action Controller
-        RailsSemanticLogger.swap_subscriber(
-          ::ActionController::LogSubscriber,
-          RailsSemanticLogger::ActionController::LogSubscriber,
-          :action_controller
-        )
+        if defined?(::ActionController)
+          require "action_controller/log_subscriber"
+
+          RailsSemanticLogger.swap_subscriber(
+            ::ActionController::LogSubscriber,
+            RailsSemanticLogger::ActionController::LogSubscriber,
+            :action_controller
+          )
+        end
 
         # Action Mailer
-        RailsSemanticLogger.swap_subscriber(
-          ::ActionMailer::LogSubscriber,
-          RailsSemanticLogger::ActionMailer::LogSubscriber,
-          :action_mailer
-        )
+        if defined?(::ActionMailer)
+          require "action_mailer/log_subscriber"
+
+          RailsSemanticLogger.swap_subscriber(
+            ::ActionMailer::LogSubscriber,
+            RailsSemanticLogger::ActionMailer::LogSubscriber,
+            :action_mailer
+          )
+        end
       end
 
       #

data/lib/rails_semantic_logger/extensions/active_job/logging.rb

@@ -9,7 +9,11 @@ module ActiveJob
 
     undef_method :tag_logger
     def tag_logger(*tags, &block)
-      logger.tagged(*tags, &block)
+      if logger.respond_to?(:tagged)
+        logger.tagged(*tags, &block)
+      else
+        yield
+      end
     end
   end
 end

data/lib/rails_semantic_logger/extensions/active_support/log_subscriber.rb

@@ -0,0 +1,11 @@
+require "active_support/log_subscriber"
+
+module ActiveSupport
+  class LogSubscriber
+    # @override Rails 7.1
+    def silenced?(event)
+      native_log_level = @event_levels.fetch(event, ::Logger::Severity::FATAL)
+      logger.nil? || SemanticLogger::Levels.index(logger.level) > SemanticLogger::Levels.index(native_log_level)
+    end
+  end
+end

data/lib/rails_semantic_logger/extensions/active_support/logger.rb

@@ -4,7 +4,15 @@ module ActiveSupport
   # More hacks to try and stop Rails from being it's own worst enemy.
   class Logger
     class << self
-      undef :logger_outputs_to?, :broadcast
+      undef :logger_outputs_to?
+
+      # Prevent broadcasting since SemanticLogger already supports multiple loggers
+      if method_defined?(:broadcast)
+        undef :broadcast
+        def broadcast(logger)
+          Module.new
+        end
+      end
     end
 
     # Prevent Console from trying to merge loggers
@@ -12,11 +20,6 @@ module ActiveSupport
       true
     end
 
-    # Prevent broadcasting since SemanticLogger already supports multiple loggers
-    def self.broadcast(logger)
-      Module.new
-    end
-
     def self.new(*args, **kwargs)
       SemanticLogger[self]
     end

data/lib/rails_semantic_logger/rack/logger.rb

@@ -35,16 +35,18 @@ module RailsSemanticLogger
       @started_request_log_level = :debug
 
       def call_app(request, env)
-        instrumenter = ActiveSupport::Notifications.instrumenter
-        instrumenter.start "request.action_dispatch", request: request
+        instrumenter        = ActiveSupport::Notifications.instrumenter
+        instrumenter_state  = instrumenter.start "request.action_dispatch", request: request
+        instrumenter_finish = -> () {
+          instrumenter.finish_with_state(instrumenter_state, "request.action_dispatch", request: request)
+        }
 
         logger.send(self.class.started_request_log_level) { started_request_message(request) }
-
         status, headers, body = @app.call(env)
-        body                  = ::Rack::BodyProxy.new(body) { finish(request) }
+        body                  = ::Rack::BodyProxy.new(body, &instrumenter_finish)
         [status, headers, body]
       rescue Exception
-        finish(request)
+        instrumenter_finish.call
         raise
       end
 
@@ -90,11 +92,6 @@ module RailsSemanticLogger
         tagged
       end
 
-      def finish(request)
-        instrumenter = ActiveSupport::Notifications.instrumenter
-        instrumenter.finish "request.action_dispatch", request: request
-      end
-
       def logger
         self.class.logger
       end

data/lib/rails_semantic_logger/version.rb

@@ -1,3 +1,3 @@
 module RailsSemanticLogger
-  VERSION = "4.11.0".freeze
+  VERSION = "4.13.0".freeze
 end

data/lib/rails_semantic_logger.rb

@@ -58,4 +58,5 @@ end
 
 require("rails_semantic_logger/extensions/mongoid/config") if defined?(Mongoid)
 require("rails_semantic_logger/extensions/active_support/logger") if defined?(ActiveSupport::Logger)
+require("rails_semantic_logger/extensions/active_support/log_subscriber") if defined?(ActiveSupport::LogSubscriber)
 require("rails_semantic_logger/extensions/rack/server") if defined?(Rack::Server)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_semantic_logger
 version: !ruby/object:Gem::Version
-  version: 4.11.0
+  version: 4.13.0
 platform: ruby
 authors:
 - Reid Morrison
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-10 00:00:00.000000000 Z
+date: 2023-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.9'
+        version: '4.13'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.9'
+        version: '4.13'
 description:
 email:
 executables: []
@@ -75,6 +75,7 @@ files:
 - lib/rails_semantic_logger/extensions/action_view/streaming_template_renderer.rb
 - lib/rails_semantic_logger/extensions/active_job/logging.rb
 - lib/rails_semantic_logger/extensions/active_model_serializers/logging.rb
+- lib/rails_semantic_logger/extensions/active_support/log_subscriber.rb
 - lib/rails_semantic_logger/extensions/active_support/logger.rb
 - lib/rails_semantic_logger/extensions/active_support/tagged_logging.rb
 - lib/rails_semantic_logger/extensions/mongoid/config.rb
@@ -86,7 +87,11 @@ files:
 homepage: https://logger.rocketjob.io
 licenses:
 - Apache-2.0
-metadata: {}
+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.13.0
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -102,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.4.9
 signing_key:
 specification_version: 4
 summary: Feature rich logging framework that replaces the Rails logger.