rails_semantic_logger 4.6.1 → 4.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0816ddc6820dfc94fed6b737d023c2cfdc6e6df3019d34ff1e71c40a2a6ccb2f'
-  data.tar.gz: b0c7f329c6e1ecf72687617155d994b6c37ef731d5166e30b76543a41e825efb
+  metadata.gz: 73a37ac27f2cf94d083cc75aa557a778f32e2de852b3be6447b072dc1da89047
+  data.tar.gz: 681f2145e71def6b336792fe3d581dfd89da6fd3ca471befcbd8ffa4f11abb50
 SHA512:
-  metadata.gz: c42fadbc4b768c9f64f719e36cdf453bc80b88639fd8fe169704ae5b37375be8706b59d3ede6ef8a6eac090a0433be1fe514e90ea306f2f1288f026042e48b18
-  data.tar.gz: f16dec6c5a4336c0d0a0a2862891ec2117cbf103257a759e8611376725167476bc090c2444a7011df7b4c4e323583f2d5392dd498dea72e03f23f3555c45bde8
+  metadata.gz: 8d299a14cb4c3eaf282e4bf502d8e60c2a36095b138c17969cf0a8f79b0431a731adbe8963ae2017bf429f12b7f42fe65d5c199a2c5f88e984a71d4605766bea
+  data.tar.gz: d837dc46c0dcd38b19dcf2a62c926c91ef1775542d55c8919d3a76db2e62764ab8675890238da78ab19b157f3b920e9d92257d5b2e347bb66d0c5a2bde60441f

data/README.md

@@ -21,7 +21,7 @@ SemanticLogger::Processor.instance.instance_variable_set(:@queue, Queue.new)
 
 ## Supports
 
-For the complete list of supported Ruby and Rails versions, see the [Testing file](https://github.com/reidmorrison/rails_semantic_logger/blob/master/.travis.yml).
+For the complete list of supported Ruby and Rails versions, see the [Testing file](https://github.com/reidmorrison/rails_semantic_logger/blob/master/.github/workflows/ci.yml).
 
 ## Author
 

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

@@ -0,0 +1,135 @@
+require "active_support/log_subscriber"
+require "action_mailer"
+
+module RailsSemanticLogger
+  module ActionMailer
+    class LogSubscriber < ::ActiveSupport::LogSubscriber
+      def deliver(event)
+        ex = event.payload[:exception_object]
+        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|
+            {
+              message: "Error delivering mail #{message_id} (#{duration}ms)",
+              exception: ex
+            }
+          end
+        else
+          message = begin
+            if event.payload[:perform_deliveries]
+              "Delivered mail #{message_id} (#{duration}ms)"
+            else
+              "Skipped delivery of mail #{message_id} as `perform_deliveries` is false"
+            end
+          end
+          log_with_formatter event: event, log_duration: true do |fmt|
+            { message: message }
+          end
+        end
+      end
+
+      # An email was generated.
+      def process(event)
+        mailer   = event.payload[:mailer]
+        action   = event.payload[:action]
+        duration = event.duration.round(1)
+        log_with_formatter event: event do |fmt|
+          { message: "#{mailer}##{action}: processed outbound mail in #{duration}ms" }
+        end
+      end
+
+      private
+
+      class EventFormatter
+        def initialize(event:, log_duration: false)
+          @event = event
+          @log_duration = log_duration
+        end
+
+        def mailer
+          event.payload[:mailer]
+        end
+
+        def payload
+          {}.tap do |h|
+            h[:event_name]         = event.name
+            h[:mailer]             = mailer
+            h[:action]             = action
+            h[:message_id]         = event.payload[:message_id]
+            h[:perform_deliveries] = event.payload[:perform_deliveries]
+            h[:subject]            = event.payload[:subject]
+            h[:to]                 = event.payload[:to]
+            h[:from]               = event.payload[:from]
+            h[:bcc]                = event.payload[:bcc]
+            h[:cc]                 = event.payload[:cc]
+            h[:date]               = date
+            h[:duration]           = event.duration.round(2) if log_duration?
+            h[:args]               = formatted_args
+          end
+        end
+
+        def date
+          if event.payload[:date].respond_to?(:to_time)
+            event.payload[:date].to_time.utc
+          elsif event.payload[:date].is_a?(String)
+            Time.parse(date).utc
+          else
+            nil
+          end
+        end
+
+        private
+
+        attr_reader :event
+
+        def mailer
+          event.payload[:mailer]
+        end
+
+        def action
+          event.payload[:action]
+        end
+
+        def formatted_args
+          if defined?(mailer.contantize.log_arguments?) && !mailer.contantize.log_arguments?
+            ""
+          else
+            JSON.pretty_generate(event.payload[:args].map { |arg| format(arg) }) if event.payload[:args].present?
+          end
+        end
+
+        def format(arg)
+          case arg
+          when Hash
+            arg.transform_values { |value| format(value) }
+          when Array
+            arg.map { |value| format(value) }
+          when GlobalID::Identification
+            begin
+              arg.to_global_id
+            rescue StandardError
+              arg
+            end
+          else
+            arg
+          end
+        end
+
+        def log_duration?
+          @log_duration
+        end
+      end
+
+      def log_with_formatter(level: :info, **kw_args)
+        fmt = EventFormatter.new(**kw_args)
+        msg = yield fmt
+        logger.public_send(level, **msg, payload: fmt.payload)
+      end
+
+      def logger
+        ::ActionMailer::Base.logger
+      end
+    end
+  end
+end

data/lib/rails_semantic_logger/active_record/log_subscriber.rb

@@ -198,7 +198,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
+      elsif (Rails::VERSION::MAJOR == 6 && Rails::VERSION::MINOR > 0) || # ~> 6.1.0
+            Rails::VERSION::MAJOR == 7
         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

@@ -1,6 +1,4 @@
 require "rails"
-require "action_controller/log_subscriber"
-require "action_view/log_subscriber"
 require "rails_semantic_logger/options"
 
 module RailsSemanticLogger
@@ -55,16 +53,16 @@ module RailsSemanticLogger
             formatter  = {color: {ap: ap_options}} if (formatter == :default) && (config.colorize_logging != false)
 
             # Set internal logger to log to file only, in case another appender experiences errors during writes
-            appender                         = SemanticLogger::Appender::File.new(
-              file_name: path,
-              level:     config.log_level,
-              formatter: formatter
-            )
+            appender                         = SemanticLogger::Appender::File.new(path, formatter: formatter)
             appender.name                    = "SemanticLogger"
             SemanticLogger::Processor.logger = appender
 
             # Check for previous file or stdout loggers
-            SemanticLogger.appenders.each { |app| app.formatter = formatter if app.is_a?(SemanticLogger::Appender::File) }
+            SemanticLogger.appenders.each do |app|
+              next unless app.is_a?(SemanticLogger::Appender::File) || app.is_a?(SemanticLogger::Appender::IO)
+
+              app.formatter = formatter
+            end
             SemanticLogger.add_appender(file_name: path, formatter: formatter, filter: config.rails_semantic_logger.filter)
           end
 
@@ -73,8 +71,8 @@ module RailsSemanticLogger
           # If not able to log to file, log to standard error with warning level only
           SemanticLogger.default_level = :warn
 
-          SemanticLogger::Processor.logger = SemanticLogger::Appender::File.new(io: STDERR)
-          SemanticLogger.add_appender(io: STDERR)
+          SemanticLogger::Processor.logger = SemanticLogger::Appender::IO.new($stderr)
+          SemanticLogger.add_appender(io: $stderr)
 
           logger = SemanticLogger[Rails]
           logger.warn(
@@ -107,13 +105,20 @@ module RailsSemanticLogger
       Mongo::Logger.logger = SemanticLogger[Mongo] if defined?(Mongo::Logger)
 
       # Replace the Resque Logger
-      Resque.logger        = SemanticLogger[Resque] if defined?(Resque) && Resque.respond_to?(:logger)
+      Resque.logger        = SemanticLogger[Resque] if defined?(Resque) && Resque.respond_to?(:logger=)
 
       # Replace the Sidekiq logger
-      Sidekiq.logger       = SemanticLogger[Sidekiq] if defined?(Sidekiq)
+      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.logger       = SemanticLogger[Sidetiq] if defined?(Sidetiq) && Sidetiq.respond_to?(:logger=)
 
       # Replace the DelayedJob logger
       if defined?(Delayed::Worker)
@@ -123,6 +128,9 @@ module RailsSemanticLogger
 
       # Replace the Bugsnag logger
       Bugsnag.configure { |config| config.logger = SemanticLogger[Bugsnag] } if defined?(Bugsnag)
+
+      # Set the IOStreams PGP logger
+      IOStreams::Pgp.logger = SemanticLogger["IOStreams::Pgp"] if defined?(IOStreams)
     end
 
     # After any initializers run, but after the gems have been loaded
@@ -182,19 +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
+        if defined?(::ActionMailer)
+          require "action_mailer/log_subscriber"
+
+          RailsSemanticLogger.swap_subscriber(
+            ::ActionMailer::LogSubscriber,
+            RailsSemanticLogger::ActionMailer::LogSubscriber,
+            :action_mailer
+          )
+        end
       end
 
       #
@@ -218,7 +245,10 @@ module RailsSemanticLogger
       console do |_app|
         # Don't use a background thread for logging
         SemanticLogger.sync!
-        SemanticLogger.add_appender(io: STDERR, formatter: :color)
+        # Add a stderr logger when running inside a Rails console unless one has already been added.
+        if config.rails_semantic_logger.console_logger && !SemanticLogger.appenders.console_output?
+          SemanticLogger.add_appender(io: STDERR, formatter: :color)
+        end
 
         # Include method names on log entries in the console
         SemanticLogger.backtrace_level = SemanticLogger.default_level

data/lib/rails_semantic_logger/extensions/action_cable/tagged_logger_proxy.rb

@@ -1,4 +1,4 @@
-ActionCable::Connection::TaggedLoggerProxy
+require "action_cable/connection/tagged_logger_proxy"
 
 module ActionCable
   module Connection

data/lib/rails_semantic_logger/extensions/action_controller/live.rb

@@ -1,5 +1,6 @@
 # Log actual exceptions, not a string representation
-ActionController::Live
+require "action_controller"
+
 module ActionController
   module Live
     undef_method :log_error

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

@@ -1,5 +1,6 @@
 # Log actual exceptions, not a string representation
-ActionDispatch::DebugExceptions
+require "action_dispatch"
+
 module ActionDispatch
   class DebugExceptions
     private

data/lib/rails_semantic_logger/extensions/action_view/streaming_template_renderer.rb

@@ -1,5 +1,5 @@
 # Log actual exceptions, not a string representation
-ActionView::StreamingTemplateRenderer
+require "action_view/renderer/streaming_template_renderer"
 
 module ActionView
   class StreamingTemplateRenderer

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

@@ -7,6 +7,7 @@ module ActiveJob
 
     private
 
+    undef_method :tag_logger
     def tag_logger(*tags, &block)
       logger.tagged(*tags, &block)
     end

data/lib/rails_semantic_logger/extensions/rails/server.rb

@@ -1,13 +1,15 @@
 # Patch the Rails::Server log_to_stdout so that it logs via SemanticLogger
-Rails::Server
+require "rails"
+
 module Rails
   class Server
     private
-
+    
+    undef_method :log_to_stdout if method_defined?(:log_to_stdout)
     def log_to_stdout
       wrapped_app # touch the app so the logger is set up
 
-      SemanticLogger.add_appender(io: $stdout, formatter: :color)
+      SemanticLogger.add_appender(io: $stdout, formatter: :color) unless SemanticLogger.appenders.console_output?
     end
   end
 end

data/lib/rails_semantic_logger/options.rb

@@ -40,7 +40,7 @@ module RailsSemanticLogger
   #       When Semantic Logger fails to log to an appender it logs the error to an
   #       internal logger, which by default writes to STDERR.
   #       Example, change the default internal logger to log to stdout:
-  #         SemanticLogger::Processor.logger = SemanticLogger::Appender::File.new(io: STDOUT, level: :warn)
+  #         SemanticLogger::Processor.logger = SemanticLogger::Appender::IO.new($stdout, level: :warn)
   #
   #       config.rails_semantic_logger.add_file_appender = true
   #
@@ -48,6 +48,10 @@ module RailsSemanticLogger
   #
   #     config.rails_semantic_logger.quiet_assets = false
   #
+  # * Disable automatic logging to stderr when running a Rails console.
+  #
+  #     config.rails_semantic_logger.console_logger = false
+  #
   # * Override the output format for the primary Rails log file.
   #
   #     Valid options:
@@ -98,7 +102,7 @@ module RailsSemanticLogger
   #   config.rails_semantic_logger.named_tags = nil
   class Options
     attr_accessor :semantic, :started, :processing, :rendered, :ap_options, :add_file_appender,
-                  :quiet_assets, :format, :named_tags, :filter
+                  :quiet_assets, :format, :named_tags, :filter, :console_logger
 
     # Setup default values
     def initialize
@@ -112,6 +116,7 @@ module RailsSemanticLogger
       @format            = :default
       @named_tags        = nil
       @filter            = nil
+      @console_logger    = true
     end
   end
 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.6.1".freeze
+  VERSION = "4.12.0".freeze
 end

data/lib/rails_semantic_logger.rb

@@ -6,6 +6,9 @@ module RailsSemanticLogger
   module ActionController
     autoload :LogSubscriber, "rails_semantic_logger/action_controller/log_subscriber"
   end
+  module ActionMailer
+    autoload :LogSubscriber, "rails_semantic_logger/action_mailer/log_subscriber"
+  end
   module ActionView
     autoload :LogSubscriber, "rails_semantic_logger/action_view/log_subscriber"
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_semantic_logger
 version: !ruby/object:Gem::Version
-  version: 4.6.1
+  version: 4.12.0
 platform: ruby
 authors:
 - Reid Morrison
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-15 00:00:00.000000000 Z
+date: 2023-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -30,28 +30,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '5.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: semantic_logger
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.8'
+        version: '4.13'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.8'
+        version: '4.13'
 description:
 email:
 executables: []
@@ -63,6 +63,7 @@ files:
 - Rakefile
 - lib/rails_semantic_logger.rb
 - lib/rails_semantic_logger/action_controller/log_subscriber.rb
+- lib/rails_semantic_logger/action_mailer/log_subscriber.rb
 - lib/rails_semantic_logger/action_view/log_subscriber.rb
 - lib/rails_semantic_logger/active_job/log_subscriber.rb
 - lib/rails_semantic_logger/active_record/log_subscriber.rb
@@ -85,7 +86,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/4.12.0
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -101,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.4.9
 signing_key:
 specification_version: 4
 summary: Feature rich logging framework that replaces the Rails logger.