Sidekiq versions

Author: reidmorrison

lib/rails_semantic_logger/extensions/sidekiq/sidekiq_v4.rb

@@ -4,31 +4,29 @@
 #   Sidekiq.configure_server do |config|
 #     SemanticLogger.add_appender(io: $stdout, level: :debug, formatter: :color)
 #   end
+require "sidekiq/exception_handler"
 require "sidekiq/logging"
-# Replace Sidekiq context with Semantic Logger
+require "sidekiq/middleware/server/logging"
+require "sidekiq/processor"
+require "sidekiq/worker"
 module Sidekiq
+  # Replace Sidekiq context with Semantic Logger
   module Logging
     def self.with_context(msg, &block)
       SemanticLogger.tagged(msg, &block)
     end
   end
-end
 
-require "sidekiq/processor"
-# Convert string to machine readable format
-module Sidekiq
+  # Convert string to machine readable format
   class Processor
     def log_context(item)
-      event       = { jid: item["jid".freeze] }
-      event[:bid] = item["bid".freeze] if item["bid".freeze]
+      event       = { jid: item["jid"] }
+      event[:bid] = item["bid"] if item["bid"]
       event
     end
   end
-end
 
-require "sidekiq/middleware/server/logging"
-# Let Semantic Logger handle duration logging
-module Sidekiq
+  # Let Semantic Logger handle duration logging
   module Middleware
     module Server
       class Logging
@@ -46,11 +44,8 @@ def call(worker, item, queue)
       end
     end
   end
-end
 
-require "sidekiq/worker"
-# Logging within each worker should use its own logger
-module Sidekiq
+  # Logging within each worker should use its own logger
   module Worker
     attr_accessor :jid
 
@@ -64,11 +59,8 @@ def self.included(base)
       base.class_attribute :sidekiq_retries_exhausted_block
     end
   end
-end
 
-require "sidekiq/exception_handler"
-# Exception is already logged by Semantic Logger during the perform call
-module Sidekiq
+  # Exception is already logged by Semantic Logger during the perform call
   module ExceptionHandler
     class Logger
       def call(ex, ctxHash)

lib/rails_semantic_logger/extensions/sidekiq/sidekiq_v5.rb

@@ -0,0 +1,66 @@
+# Sidekiq v5 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
+require "sidekiq/exception_handler"
+require "sidekiq/job_logger"
+require "sidekiq/logging"
+require "sidekiq/worker"
+# Replace Sidekiq context with Semantic Logger
+module Sidekiq
+  module Logging
+    def self.with_context(msg, &block)
+      SemanticLogger.tagged(msg, &block)
+    end
+
+    def self.job_hash_context(job_hash)
+      # If we're using a wrapper class, like ActiveJob, use the "wrapped"
+      # attribute to expose the underlying thing.
+      klass       = job_hash["wrapped"] || job_hash["class"]
+      event       = { class: klass, jid: job_hash["jid"] }
+      event[:bid] = job_hash["bid"] if job_hash["bid"]
+      event
+    end
+  end
+
+  # Let Semantic Logger handle duration logging
+  class JobLogger
+    def call(item, queue)
+      logger.info("Start #perform")
+      klass = item["wrapped"] || item["class"]
+      metric = "Sidekiq/#{klass}/perform" if klass
+      logger.measure_info(
+        "Completed #perform",
+        on_exception_level: :error,
+        log_exception: :full,
+        metric: metric
+      ) do
+        yield
+      end
+    end
+  end
+
+  # Logging within each worker should use its own logger
+  module Worker
+    def self.included(base)
+      raise ArgumentError, "You cannot include Sidekiq::Worker in an ActiveJob: #{base.name}" if base.ancestors.any? { |c| c.name == "ActiveJob::Base" }
+
+      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
+
+  # Exception is already logged by Semantic Logger during the perform call
+  module ExceptionHandler
+    class Logger
+      def call(ex, ctxHash)
+        Sidekiq.logger.warn(ctxHash) if !ctxHash.empty?
+      end
+    end
+  end
+end

lib/rails_semantic_logger/extensions/sidekiq/sidekiq_v6.rb

@@ -0,0 +1,59 @@
+# Sidekiq v6.2 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
+require "sidekiq/exception_handler"
+require "sidekiq/job_logger"
+require "sidekiq/worker"
+module Sidekiq
+  # Let Semantic Logger handle duration logging
+  class JobLogger
+    def call(item, queue)
+      klass = item["wrapped"] || item["class"]
+      metric = "Sidekiq/#{klass}/perform" if klass
+      logger = klass ? SemanticLogger[klass] : Sidekiq.logger
+      logger.info("Start #perform")
+      logger.measure_info(
+        "Completed #perform",
+        on_exception_level: :error,
+        log_exception: :full,
+        metric: metric
+      ) do
+        yield
+      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
+  end
+
+  # Logging within each worker should use its own logger
+  module Worker
+    def self.included(base)
+      raise ArgumentError, "Sidekiq::Worker cannot be included in an ActiveJob: #{base.name}" if base.ancestors.any? { |c| c.name == "ActiveJob::Base" }
+
+      base.include(Options)
+      base.extend(ClassMethods)
+      base.include(SemanticLogger::Loggable)
+    end
+  end
+
+  # Exception is already logged by Semantic Logger during the perform call
+  module ExceptionHandler
+    class Logger
+      def call(ex, ctx)
+        Sidekiq.logger.warn(ctx) if !ctx.empty?
+      end
+    end
+  end
+end