rails_semantic_logger 4.14.0 → 4.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b41a1fee07d074d18bcaed7538592f123ecbbbe0f232b52cbca96133654ac256
-  data.tar.gz: df2d6ef10cb8aa051f56a3b916064d1c51afcc3c9ef6f834c2c26be5a3dfc9b4
+  metadata.gz: ce106635bd9397c23bea233bc0bf69fd1e1e4fad2b4bbb28df80c1d29d25a8e4
+  data.tar.gz: 1690e46c1ae45b6a9846e6deff99338797a2a85f5088138465de58ee99dcefe1
 SHA512:
-  metadata.gz: 70dec27d9976ae2edfc028bdfd03f51b3eade4cf1562681096ba3a882e2f0aacc9fba893cacd5ac7604f3810b2d6e3b880d2411d78a4372ad5b53ab579e41878
-  data.tar.gz: 635c69136356a8c3ad62a81e0b2db7e397031878619c381fe52240405c2c0b720b9f4900fc2d2ae886d8c23943f8ebd1649444b35357c6178016bb99f036e7dd
+  metadata.gz: ed31c93a5312ef92bf632167e3e58c5cb421cfbe623b9af95c7119e1d88259938cee6b1870d956733002536fa154b20ff69813e5d7c86bfaa6e508feb121d551
+  data.tar.gz: e2aa37e8f1203cd9910ae9550fa9d60211c341b36f8b5e5b13e777f7dc9ec0361dd21adbdc4b560ffd8ba3f12e0eb1791da485ab01401f6784ff90ba25204fbb

data/README.md

@@ -3,12 +3,116 @@
 
 Rails Semantic Logger replaces the Rails default logger with [Semantic Logger](https://logger.rocketjob.io/)
 
+When any large Rails application is deployed to production one of the first steps is to move to centralized logging, so that logs can be viewed and searched from a central location.
+
+Centralized logging quickly falls apart when trying to consume the current human readable log files:
+- Log entries often span multiple lines, resulting in unrelated log lines in the centralized logging system. For example, stack traces.
+- Complex Regular Expressions are needed to parse the text lines and make them machine readable. For example to build queries, or alerts that are looking for specific elements in the message.
+- Writing searches, alerts, or dashboards based on text logs is incredibly brittle, since a small change to the text logged can often break the parsing of those logs.
+- Every log entry often has a completely different format, making it difficult to make consistent searches against the data.
+
+For these and many other reasons switching to structured logging, or logs in JSON format, in testing and production makes centralized logging incredibly powerful.
+
+For example, adding these lines to `config/application.rb` and removing any other log overrides from other environments, will switch automatically to structured logging when running inside Kubernetes:
+~~~ruby
+    # Setup structured logging
+    config.semantic_logger.application = "my_application"
+    config.semantic_logger.environment = ENV["STACK_NAME"] || Rails.env
+    config.log_level = ENV["LOG_LEVEL"] || :info
+
+    # Switch to JSON Logging output to stdout when running on Kubernetes
+    if ENV["LOG_TO_CONSOLE"] || ENV["KUBERNETES_SERVICE_HOST"]
+      config.rails_semantic_logger.add_file_appender = false
+      config.semantic_logger.add_appender(io: $stdout, formatter: :json)
+    end
+~~~
+
+Then configure the centralized logging system to tell it that the data is in JSON format, so that it will parse it for you into a hierarchy.
+
+For example, the following will instruct [Observe](https://www.observeinc.com/) to parse the JSON data and create machine readable data from it:
+~~~ruby
+interface "log", "log":log
+
+make_col event:parse_json(log)
+
+make_col
+   time:parse_isotime(event.timestamp),
+   application:string(event.application),
+   environment:string(event.environment),
+   duration:duration_ms(event.duration_ms),
+   level:string(event.level),
+   name:string(event.name),
+   message:string(event.message),
+   named_tags:event.named_tags,
+   payload:event.payload,
+   metric:string(event.metric),
+   metric_amount:float64(event.metric_amount),
+   tags:array(event.tags),
+   exception:event.exception,
+   host:string(event.host),
+   pid:int64(event.pid),
+   thread:string(event.thread),
+   file:string(event.file),
+   line:int64(event.line),
+   dimensions:event.dimensions,
+   backtrace:array(event.backtrace),
+   level_index:int64(event.level_index)
+
+set_valid_from(time)
+drop_col timestamp, log, event, stream
+rename_col timestamp:time
+~~~
+
+Now queries can be built to drill down into each of these fields, including `payload` which is a nested object.
+
+For example to find all failed Sidekiq job calls where the causing exception class name is `NoMethodError`:
+~~~ruby
+filter environment = "uat2"
+filter level = "error"
+filter metric = "sidekiq.job.perform"
+filter (string(exception.cause.name) = "NoMethodError")
+~~~
+
+Example: create a dashboard showing the duration of all successful Sidekiq jobs:
+~~~ruby
+filter environment = "production"
+filter level = "info"
+filter metric = "sidekiq.job.perform"
+timechart duration:avg(duration), group_by(name)
+~~~
+
+Example: create a dashboard showing the queue latency of all Sidekiq jobs. 
+The queue latency is the time between when the job was enqueued and when it was started:
+~~~ruby
+filter environment = "production"
+filter level = "info"
+filter metric = "sidekiq.queue.latency"
+timechart latency:avg(metric_amount/1000), group_by(string(named_tags.queue))
+~~~
+
 * http://github.com/reidmorrison/rails_semantic_logger
 
 ## Documentation
 
 For complete documentation see: https://logger.rocketjob.io/rails
 
+## Upgrading to Semantic Logger V4.16 - Sidekiq Metrics Support
+
+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.
+  - `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
+
+Rails Semantic Logger introduces direct support for Sidekiq v4, v5, v6, and v7. 
+Please remove any previous custom patches or configurations to make Sidekiq work with Semantic Logger.
+To see the complete list of patches being made, and to contribute your own changes, see: [Sidekiq Patches](https://github.com/reidmorrison/rails_semantic_logger/blob/master/lib/rails_semantic_logger/extensions/sidekiq/sidekiq.rb)
+
 ## Upgrading to Semantic Logger v4.4
 
 With some forking frameworks it is necessary to call `reopen` after the fork. With v4.4 the
@@ -19,7 +123,18 @@ I.e. Please remove the following line if being called anywhere:
 SemanticLogger::Processor.instance.instance_variable_set(:@queue, Queue.new)
 ~~~
 
-## Supports
+## New Versions of Rails, etc.
+
+The primary purpose of the Rails Semantic Logger gem is to patch other gems, primarily Rails, to make them support structured logging though Semantic Logger.
+
+When new versions of Rails and other gems are published they often make changes to the internals, so the existing patches stop working.
+
+Rails Semantic Logger survives only when someone in the community upgrades to a newer Rails or other supported libraries, runs into problems, 
+and then contributes the fix back to the community by means of a pull request.
+
+Additionally, when new popular gems come out, we rely only the community to supply the necessary patches in Rails Semantic Logger to make those gems support structured logging.
+
+## Supported Platforms
 
 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).
 

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

@@ -2,17 +2,24 @@ module RailsSemanticLogger
   module ActiveRecord
     class LogSubscriber < ActiveSupport::LogSubscriber
       IGNORE_PAYLOAD_NAMES = %w[SCHEMA EXPLAIN].freeze
+      RAILS_VERSION_ENDING_SET_RUNTIME_SUPPORT = Gem::Version.new( "8.0.3")
 
       class << self
         attr_reader :logger
       end
 
       def self.runtime=(value)
-        ::ActiveRecord::RuntimeRegistry.sql_runtime = value
+        return if Rails.version >= RAILS_VERSION_ENDING_SET_RUNTIME_SUPPORT
+
+        ::ActiveRecord::RuntimeRegistry.respond_to?(:stats) ?
+          ::ActiveRecord::RuntimeRegistry.stats.sql_runtime = value :
+          ::ActiveRecord::RuntimeRegistry.sql_runtime = value
       end
 
       def self.runtime
-        ::ActiveRecord::RuntimeRegistry.sql_runtime ||= 0
+        ::ActiveRecord::RuntimeRegistry.respond_to?(:stats) ?
+          ::ActiveRecord::RuntimeRegistry.stats.sql_runtime ||= 0 :
+          ::ActiveRecord::RuntimeRegistry.sql_runtime ||= 0
       end
 
       def self.reset_runtime
@@ -33,6 +40,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 +62,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 +218,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,
@@ -185,7 +204,7 @@ module RailsSemanticLogger
         RailsSemanticLogger::Rack::Logger.started_request_log_level = :info if config.rails_semantic_logger.started
 
         # Silence asset logging by applying a filter to the Rails logger itself, not any of the appenders.
-        if config.rails_semantic_logger.quiet_assets && config.assets.prefix
+        if config.rails_semantic_logger.quiet_assets && config.respond_to?(:assets) && config.assets.prefix
           assets_root                                     = config.relative_url_root.to_s + config.assets.prefix
           assets_regex                                    = %r(\A/{0,2}#{assets_root})
           RailsSemanticLogger::Rack::Logger.logger.filter = ->(log) { log.payload[:path] !~ assets_regex if log.payload }
@@ -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,
@@ -224,6 +244,8 @@ module RailsSemanticLogger
             :action_mailer
           )
         end
+
+        require("rails_semantic_logger/extensions/sidekiq/sidekiq") if defined?(::Sidekiq)
       end
 
       #
@@ -239,11 +261,17 @@ module RailsSemanticLogger
       end
 
       # Re-open appenders after Resque has forked a worker
-      Resque.after_fork { |_job| ::SemanticLogger.reopen } if defined?(Resque)
+      Resque.after_fork { |_job| ::SemanticLogger.reopen } if defined?(Resque.after_fork)
 
       # 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

@@ -6,9 +6,21 @@ module ActionDispatch
     private
 
     undef_method :log_error
-    def log_error(_request, wrapper)
-      ActiveSupport::Deprecation.silence do
-        ActionController::Base.logger.fatal(wrapper.exception)
+    if (Rails::VERSION::MAJOR == 7 && Rails::VERSION::MINOR >= 1) || Rails::VERSION::MAJOR > 7
+      def log_error(request, wrapper)
+        Rails.application.deprecators.silence do
+          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
+          level = wrapper.respond_to?(:rescue_response?) && wrapper.rescue_response? ? :debug : :fatal
+          ActionController::Base.logger.log(level, wrapper.exception)
+        end
       end
     end
   end

data/lib/rails_semantic_logger/extensions/sidekiq/sidekiq.rb

@@ -0,0 +1,70 @@
+# Sidekiq patches
+if Sidekiq::VERSION.to_i == 4
+  require "sidekiq/logging"
+  require "sidekiq/middleware/server/logging"
+  require "sidekiq/processor"
+elsif Sidekiq::VERSION.to_i == 5
+  require "sidekiq/logging"
+end
+
+module Sidekiq
+  # Sidekiq v4 & v5
+  if defined?(::Sidekiq::Logging)
+    # Replace Sidekiq logging context
+    module Logging
+      def self.with_context(msg, &block)
+        SemanticLogger.tagged(msg, &block)
+      end
+
+      def self.job_hash_context(job_hash)
+        h         = {jid: job_hash["jid"]}
+        h[:bid]   = job_hash["bid"] if job_hash["bid"]
+        h[:queue] = job_hash["queue"] if job_hash["queue"]
+        h
+      end
+    end
+  end
+
+  # Sidekiq v4
+  if defined?(::Sidekiq::Middleware::Server::Logging)
+    # Convert string to machine readable format
+    class Processor
+      def log_context(job_hash)
+        h         = {jid: job_hash["jid"]}
+        h[:bid]   = job_hash["bid"] if job_hash["bid"]
+        h[:queue] = job_hash["queue"] if job_hash["queue"]
+        h
+      end
+    end
+
+    # Let Semantic Logger handle duration logging
+    module Middleware
+      module Server
+        class Logging
+          # rubocop:disable Style/ExplicitBlockArgument
+          def call(worker, item, queue)
+            SemanticLogger.tagged(queue: queue) do
+              worker.logger.info(
+                "Start #perform",
+                metric:        "sidekiq.queue.latency",
+                metric_amount: job_latency_ms(item)
+              )
+              worker.logger.measure_info(
+                "Completed #perform",
+                on_exception_level: :error,
+                log_exception:      :full,
+                metric:             "sidekiq.job.perform"
+              ) { yield }
+            end
+          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
+  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

@@ -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.14.0".freeze
+  VERSION = "4.19.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,12 +67,26 @@ 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)
 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)
+
+begin
+  require "rackup"
+rescue LoadError
+  # No need to do anything, will fall back to Rack
+end
 if defined?(Rackup::Server)
   require("rails_semantic_logger/extensions/rackup/server")
 elsif defined?(Rack::Server)

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rails_semantic_logger
 version: !ruby/object:Gem::Version
-  version: 4.14.0
+  version: 4.19.0
 platform: ruby
 authors:
 - Reid Morrison
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-16 00:00:00.000000000 Z
+date: 2025-12-09 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: []
@@ -82,8 +79,12 @@ files:
 - lib/rails_semantic_logger/extensions/rack/server.rb
 - lib/rails_semantic_logger/extensions/rackup/server.rb
 - lib/rails_semantic_logger/extensions/rails/server.rb
+- 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:
@@ -91,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.14.0
+  source_code_uri: https://github.com/reidmorrison/rails_semantic_logger/tree/v4.19.0
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -108,8 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.9
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Feature rich logging framework that replaces the Rails logger.
 test_files: []