rails_semantic_logger 4.16.0 → 4.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7da18e2122c13f2b4325a6f3000dd74d22517608b3a32355ca3d2bf4e5f08789
-  data.tar.gz: b0503c3227cb0bfa5faa1c6f00b408968783c8d09092a960497ab9f004798875
+  metadata.gz: db5e6b03ccd16cbe212ef23f0fad1e7f14138f8b2e22e7572613aa3e52d5b66d
+  data.tar.gz: d46ee20a271e77d51f551926629257d221db96301facefe7be9a641d9ddffc77
 SHA512:
-  metadata.gz: 30446e6a7553868e37cb56550d0a3e5c15b137991609e2cbb7aee84c7c7f5a75abe0bdd7f5e6263418546645f7a0892472e042ee09e0764be9f0ff9d90311917
-  data.tar.gz: 051ff94e24b1d9a4231f01d4148a966333b8d7b57539f7fa15ab953ad0a2fc9c998b61413ae2350716763f323eafa6d7302893b0c7b691e165c2200f7a8f3ef1
+  metadata.gz: f07be5e786b9f93669b278027cf2ba578132dc90ec3e6aa575c0df7b85fdd851d9d54965172a59bf7e9b40ad002d4fd0bd1a677ee8c3b77de129010c2b93b781
+  data.tar.gz: ebcc3799d581accf18af62739310ed25d183346c72a5006fa32a5a82f828a7371a9607df9646664574fd164be524ab76fa0c23f3845632285d76457134ed90f7

data/README.md

@@ -87,7 +87,7 @@ The queue latency is the time between when the job was enqueued and when it was
 filter environment = "production"
 filter level = "info"
 filter metric = "sidekiq.queue.latency"
-timechart duration:avg(duration), group_by(name)
+timechart latency:avg(metric_amount/1000), group_by(string(named_tags.queue))
 ~~~
 
 * http://github.com/reidmorrison/rails_semantic_logger
@@ -100,8 +100,12 @@ For complete documentation see: https://logger.rocketjob.io/rails
 
 Rails Semantic Logger now supports Sidekiq metrics. 
 Below are the metrics that are now available when the JSON logging format is used:
-- `sidekiq.job.perform` - The duration of each Sidekiq job.
-- `sidekiq.queue.latency` - The time between when a Sidekiq job was enqueued and when it was started.
+- `sidekiq.job.perform`
+  - The duration of each Sidekiq job.
+  - `duration` contains the time in milliseconds that the job took to run.
+- `sidekiq.queue.latency` 
+  - The time between when a Sidekiq job was enqueued and when it was started.
+  - `metric_amount` contains the time in milliseconds that the job was waiting in the queue.
 
 ## Upgrading to Semantic Logger v4.15 & V4.16 - Sidekiq Support
 

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

@@ -108,12 +108,31 @@ module RailsSemanticLogger
       Resque.logger        = SemanticLogger[Resque] if defined?(Resque) && Resque.respond_to?(:logger=)
 
       # Replace the Sidekiq 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] }
+      if defined?(::Sidekiq)
+        ::Sidekiq.configure_client do |config|
+          config.logger = ::SemanticLogger[::Sidekiq]
+        end
+
+        ::Sidekiq.configure_server do |config|
+          config.logger = ::SemanticLogger[::Sidekiq]
+          if config.respond_to?(:options)
+            config.options[:job_logger] = RailsSemanticLogger::Sidekiq::JobLogger
+          else
+            config[:job_logger] = RailsSemanticLogger::Sidekiq::JobLogger
+          end
+
+          # Add back the default console logger unless already added
+          SemanticLogger.add_appender(io: $stdout, formatter: :color) unless SemanticLogger.appenders.console_output?
+
+          # Replace default error handler when present
+          existing = RailsSemanticLogger::Sidekiq::Defaults.delete_default_error_handler(config.error_handlers)
+          config.error_handlers << RailsSemanticLogger::Sidekiq::Defaults::ERROR_HANDLER if existing
+        end
+
+        if defined?(::Sidekiq::Job) && (::Sidekiq::VERSION.to_i != 5)
+          ::Sidekiq::Job.singleton_class.prepend(RailsSemanticLogger::Sidekiq::Loggable)
+        else
+          ::Sidekiq::Worker.singleton_class.prepend(RailsSemanticLogger::Sidekiq::Loggable)
         end
       end
 
@@ -154,7 +173,7 @@ module RailsSemanticLogger
 
       if config.rails_semantic_logger.semantic
         # Active Job
-        if defined?(::ActiveJob) && defined?(::ActiveJob::Logging::LogSubscriber)
+        if defined?(::ActiveJob::Logging::LogSubscriber)
           RailsSemanticLogger.swap_subscriber(
             ::ActiveJob::Logging::LogSubscriber,
             RailsSemanticLogger::ActiveJob::LogSubscriber,
@@ -162,7 +181,7 @@ module RailsSemanticLogger
           )
         end
 
-        if defined?(::ActiveJob) && defined?(::ActiveJob::LogSubscriber)
+        if defined?(::ActiveJob::LogSubscriber)
           RailsSemanticLogger.swap_subscriber(
             ::ActiveJob::LogSubscriber,
             RailsSemanticLogger::ActiveJob::LogSubscriber,
@@ -207,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,
@@ -246,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/extensions/sidekiq/sidekiq.rb

@@ -1,89 +1,14 @@
 # Sidekiq patches
-#
-# To re-enable stdout logging for sidekiq server processes, add the following snippet to config/initializers/sidekiq.rb:
-#   Sidekiq.configure_server do |config|
-#     SemanticLogger.add_appender(io: $stdout, level: :debug, formatter: :color)
-#   end
 if Sidekiq::VERSION.to_i == 4
-  require "sidekiq/exception_handler"
   require "sidekiq/logging"
   require "sidekiq/middleware/server/logging"
   require "sidekiq/processor"
-  require "sidekiq/worker"
 elsif Sidekiq::VERSION.to_i == 5
-  require "sidekiq/exception_handler"
-  require "sidekiq/job_logger"
   require "sidekiq/logging"
-  require "sidekiq/worker"
-elsif Sidekiq::VERSION.to_i == 6 && Sidekiq::VERSION.to_f < 6.5
-  require "sidekiq/exception_handler"
-  require "sidekiq/job_logger"
-  require "sidekiq/worker"
-elsif Sidekiq::VERSION.to_i == 6
-  require "sidekiq/job_logger"
-  require "sidekiq/worker"
-else
-  require "sidekiq/config"
-  require "sidekiq/job_logger"
-  require "sidekiq/job"
 end
 
 module Sidekiq
-  # Sidekiq > v4
-  if defined?(::Sidekiq::JobLogger)
-    # Let Semantic Logger handle duration logging
-    class JobLogger
-      def call(item, queue, &block)
-        klass  = item["wrapped"] || item["class"]
-        logger = klass ? SemanticLogger[klass] : Sidekiq.logger
-
-        SemanticLogger.tagged(queue: queue) do
-          # Latency is the time between when the job was enqueued and when it started executing.
-          logger.info(
-            "Start #perform",
-            metric:        "sidekiq.queue.latency",
-            metric_amount: job_latency_ms(item)
-          )
-
-          # Measure the duration of running the job
-          logger.measure_info(
-            "Completed #perform",
-            on_exception_level: :error,
-            log_exception:      :full,
-            metric:             "sidekiq.job.perform",
-            &block
-          )
-        end
-      end
-
-      def prepare(job_hash, &block)
-        level = job_hash["log_level"]
-        if level
-          SemanticLogger.silence(level) do
-            SemanticLogger.tagged(job_hash_context(job_hash), &block)
-          end
-        else
-          SemanticLogger.tagged(job_hash_context(job_hash), &block)
-        end
-      end
-
-      def job_hash_context(job_hash)
-        h         = {jid: job_hash["jid"]}
-        h[:bid]   = job_hash["bid"] if job_hash["bid"]
-        h[:tags]  = job_hash["tags"] if job_hash["tags"]
-        h[:queue] = job_hash["queue"] if job_hash["queue"]
-        h
-      end
-
-      def job_latency_ms(job)
-        return unless job && job["enqueued_at"]
-
-        (Time.now.to_f - job["enqueued_at"].to_f) * 1000
-      end
-    end
-  end
-
-  # Sidekiq <= v6
+  # Sidekiq v4 & v5
   if defined?(::Sidekiq::Logging)
     # Replace Sidekiq logging context
     module Logging
@@ -100,106 +25,8 @@ module Sidekiq
     end
   end
 
-  # Exception is already logged by Semantic Logger during the perform call
-  if defined?(::Sidekiq::ExceptionHandler)
-    # Sidekiq <= v6.5
-    module ExceptionHandler
-      class Logger
-        def call(_exception, ctx)
-          return if ctx.empty?
-
-          job_hash = ctx[:job] || {}
-          klass    = job_hash["display_class"] || job_hash["wrapped"] || job_hash["class"]
-          logger   = klass ? SemanticLogger[klass] : Sidekiq.logger
-          ctx[:context] ? logger.warn(ctx[:context], ctx) : logger.warn(ctx)
-        end
-      end
-    end
-  elsif defined?(::Sidekiq::Config)
-    # Sidekiq >= v7
-    class Config
-      remove_const :ERROR_HANDLER
-
-      ERROR_HANDLER = ->(ex, ctx, cfg = Sidekiq.default_configuration) do
-        unless ctx.empty?
-          job_hash = ctx[:job] || {}
-          klass    = job_hash["display_class"] || job_hash["wrapped"] || job_hash["class"]
-          logger   = klass ? SemanticLogger[klass] : Sidekiq.logger
-          ctx[:context] ? logger.warn(ctx[:context], ctx) : logger.warn(ctx)
-        end
-      end
-    end
-  else
-    # Sidekiq >= 6.5
-    Sidekiq.error_handlers.delete(Sidekiq::DEFAULT_ERROR_HANDLER)
-    Sidekiq.error_handlers << ->(ex, ctx) do
-      unless ctx.empty?
-        job_hash = ctx[:job] || {}
-        klass = job_hash["display_class"] || job_hash["wrapped"] || job_hash["class"]
-        logger = klass ? SemanticLogger[klass] : Sidekiq.logger
-        ctx[:context] ? logger.warn(ctx[:context], ctx) : logger.warn(ctx)
-      end
-    end
-  end
-
-  # Logging within each worker should use its own logger
-  case Sidekiq::VERSION.to_i
-  when 4
-    module Worker
-      def self.included(base)
-        if base.ancestors.any? { |c| c.name == "ActiveJob::Base" }
-          raise ArgumentError, "You cannot include Sidekiq::Worker in an ActiveJob: #{base.name}"
-        end
-
-        base.extend(ClassMethods)
-        base.include(SemanticLogger::Loggable)
-        base.class_attribute :sidekiq_options_hash
-        base.class_attribute :sidekiq_retry_in_block
-        base.class_attribute :sidekiq_retries_exhausted_block
-      end
-    end
-  when 5
-    module Worker
-      def self.included(base)
-        if base.ancestors.any? { |c| c.name == "ActiveJob::Base" }
-          raise ArgumentError, "You cannot include Sidekiq::Worker in an ActiveJob: #{base.name}"
-        end
-
-        base.extend(ClassMethods)
-        base.include(SemanticLogger::Loggable)
-        base.sidekiq_class_attribute :sidekiq_options_hash
-        base.sidekiq_class_attribute :sidekiq_retry_in_block
-        base.sidekiq_class_attribute :sidekiq_retries_exhausted_block
-      end
-    end
-  when 6
-    module Worker
-      def self.included(base)
-        if base.ancestors.any? { |c| c.name == "ActiveJob::Base" }
-          raise ArgumentError, "Sidekiq::Worker cannot be included in an ActiveJob: #{base.name}"
-        end
-
-        base.include(Options)
-        base.extend(ClassMethods)
-        base.include(SemanticLogger::Loggable)
-      end
-    end
-  else
-    module Job
-      def self.included(base)
-        if base.ancestors.any? { |c| c.name == "ActiveJob::Base" }
-          raise ArgumentError, "Sidekiq::Job cannot be included in an ActiveJob: #{base.name}"
-        end
-
-        base.include(Options)
-        base.extend(ClassMethods)
-        base.include(SemanticLogger::Loggable)
-      end
-    end
-  end
-
+  # Sidekiq v4
   if defined?(::Sidekiq::Middleware::Server::Logging)
-    # Sidekiq v4
     # Convert string to machine readable format
     class Processor
       def log_context(job_hash)
@@ -214,6 +41,7 @@ module Sidekiq
     module Middleware
       module Server
         class Logging
+          # rubocop:disable Style/ExplicitBlockArgument
           def call(worker, item, queue)
             SemanticLogger.tagged(queue: queue) do
               worker.logger.info(

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

@@ -0,0 +1,40 @@
+module RailsSemanticLogger
+  module Sidekiq
+    module Defaults
+      # Prevent exception logging during standard error handling since the Job Logger below already logs the exception.
+      ERROR_HANDLER =
+        if ::Sidekiq::VERSION.to_f < 7.1 ||
+           (::Sidekiq::VERSION.to_f == 7.1 && ::Sidekiq::VERSION.split(".").last.to_i < 6)
+          lambda do |_ex, ctx|
+            unless ctx.empty?
+              job_hash = ctx[:job] || {}
+              klass    = job_hash["display_class"] || job_hash["wrapped"] || job_hash["class"]
+              logger   = klass ? SemanticLogger[klass] : ::Sidekiq.logger
+              ctx[:context] ? logger.warn(ctx[:context], ctx) : logger.warn(ctx)
+            end
+          end
+        else
+          lambda do |_ex, ctx, _default_configuration|
+            unless ctx.empty?
+              job_hash = ctx[:job] || {}
+              klass    = job_hash["display_class"] || job_hash["wrapped"] || job_hash["class"]
+              logger   = klass ? SemanticLogger[klass] : ::Sidekiq.logger
+              ctx[:context] ? logger.warn(ctx[:context], ctx) : logger.warn(ctx)
+            end
+          end
+        end
+
+      # Returns the default logger after removing from the supplied list.
+      # Returns [nil] when the default logger was not present.
+      def self.delete_default_error_handler(error_handlers)
+        return error_handlers.delete(::Sidekiq::Config::ERROR_HANDLER) if defined?(::Sidekiq::Config::ERROR_HANDLER)
+        return error_handlers.delete(::Sidekiq::DEFAULT_ERROR_HANDLER) if defined?(::Sidekiq::DEFAULT_ERROR_HANDLER)
+
+        return unless defined?(::Sidekiq::ExceptionHandler)
+
+        existing = error_handlers.find { |handler| handler.is_a?(::Sidekiq::ExceptionHandler::Logger) }
+        error_handlers.delete(existing) if existing
+      end
+    end
+  end
+end

data/lib/rails_semantic_logger/sidekiq/job_logger.rb

@@ -0,0 +1,59 @@
+module RailsSemanticLogger
+  module Sidekiq
+    class JobLogger
+      # Sidekiq 6.5 does not take any arguments, whereas v7 is given a logger
+      def initialize(*_args)
+      end
+
+      def call(item, queue, &block)
+        klass  = item["wrapped"] || item["class"]
+        logger = klass ? SemanticLogger[klass] : Sidekiq.logger
+
+        SemanticLogger.tagged(queue: queue) do
+          # Latency is the time between when the job was enqueued and when it started executing.
+          logger.info(
+            "Start #perform",
+            metric:        "sidekiq.queue.latency",
+            metric_amount: job_latency_ms(item)
+          )
+
+          # Measure the duration of running the job
+          logger.measure_info(
+            "Completed #perform",
+            on_exception_level: :error,
+            log_exception:      :full,
+            metric:             "sidekiq.job.perform",
+            &block
+          )
+        end
+      end
+
+      def prepare(job_hash, &block)
+        level = job_hash["log_level"]
+        if level
+          SemanticLogger.silence(level) do
+            SemanticLogger.tagged(job_hash_context(job_hash), &block)
+          end
+        else
+          SemanticLogger.tagged(job_hash_context(job_hash), &block)
+        end
+      end
+
+      private
+
+      def job_hash_context(job_hash)
+        h         = {jid: job_hash["jid"]}
+        h[:bid]   = job_hash["bid"] if job_hash["bid"]
+        h[:tags]  = job_hash["tags"] if job_hash["tags"]
+        h[:queue] = job_hash["queue"] if job_hash["queue"]
+        h
+      end
+
+      def job_latency_ms(job)
+        return unless job && job["enqueued_at"]
+
+        (Time.now.to_f - job["enqueued_at"].to_f) * 1000
+      end
+    end
+  end
+end

data/lib/rails_semantic_logger/sidekiq/loggable.rb

@@ -0,0 +1,10 @@
+module RailsSemanticLogger
+  module Sidekiq
+    module Loggable
+      def included(base)
+        super
+        base.include(SemanticLogger::Loggable)
+      end
+    end
+  end
+end

data/lib/rails_semantic_logger/version.rb

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

data/lib/rails_semantic_logger.rb

@@ -31,6 +31,12 @@ module RailsSemanticLogger
     autoload :Plugin, "rails_semantic_logger/delayed_job/plugin"
   end
 
+  module Sidekiq
+    autoload :Defaults, "rails_semantic_logger/sidekiq/defaults"
+    autoload :JobLogger, "rails_semantic_logger/sidekiq/job_logger"
+    autoload :Loggable, "rails_semantic_logger/sidekiq/loggable"
+  end
+
   autoload :Options, "rails_semantic_logger/options"
 
   # Swap an existing subscriber with a new one
@@ -43,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)
@@ -61,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.16.0
+  version: 4.18.0
 platform: ruby
 authors:
 - Reid Morrison
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-01 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -44,16 +43,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.13'
+        version: '4.16'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.13'
-description:
-email:
+        version: '4.16'
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -85,6 +82,9 @@ files:
 - lib/rails_semantic_logger/extensions/sidekiq/sidekiq.rb
 - lib/rails_semantic_logger/options.rb
 - lib/rails_semantic_logger/rack/logger.rb
+- lib/rails_semantic_logger/sidekiq/defaults.rb
+- lib/rails_semantic_logger/sidekiq/job_logger.rb
+- lib/rails_semantic_logger/sidekiq/loggable.rb
 - lib/rails_semantic_logger/version.rb
 homepage: https://logger.rocketjob.io
 licenses:
@@ -92,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.16.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
@@ -109,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: []