sidekiq-logstash 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '09e505554a5ed16d442f68da725e3647a2cd77d12f36897a657d54ff8a3cb8b8'
-  data.tar.gz: 917723b1952886cfd29070668209e254198d2d9f3d2807aabbd10af0a5b46608
+  metadata.gz: 7da540744ff32bbe1218075f40fa979c9b5a9bdb7211c45df40ec8191b2b51cc
+  data.tar.gz: '09e58a7cd2504538079fc8493e7fef3a59a9217736a0b1bf1425f6ba208f20c8'
 SHA512:
-  metadata.gz: f168b77deb49ef0eab0ff308ddfc8539d2b9cf6e1756373ed82301b5a7d5ac063ebefb16fd8a9941b4f0995066b5afcae54b8c9abf6caa1eea190841ca192c15
-  data.tar.gz: ad292af73bb01ef763a1e171d1e960c345775db0128f2d904f32ee7166a654a33c065f2d0838c766e2f4057d5a84c054051c21e1945e1728ebb92bfbbb7018ce
+  metadata.gz: 746c123b2341c14f1d565d830f489a5eddb6591ba56f6c72ffaafd737524126cd24df17fdc808af5b8271fa88f94c5e5356d37e923ba5327cf849a56080d7d7e
+  data.tar.gz: f79226102532246d67bffcbe478d6e30781838d995d7c50f627e6a309f49f1a1b347aa7dbc1720733985a217a98d9c97d77db71ff53097d4b29c8fcd217012bc

data/.rubocop.yml

@@ -13,6 +13,9 @@ Metrics/BlockLength:
   Exclude:
     - spec/**/*.rb
 
+Metrics/ModuleLength:
+  Enabled: false 
+
 Layout/LineLength:
   Max: 120
   Exclude:

data/README.md

@@ -83,6 +83,13 @@ Sidekiq::Logstash.configure do |config|
   # by default, sidekiq-logstash removes the default error handler
   # to keep it, simply set this to true
   config.keep_default_error_handler = true
+
+  # To enable a log structure that includes details about exception causes,
+  # uncomment the following lines:
+  #
+  # config.log_job_exception_with_causes = true
+  # # To specify the maximum depth of causes to log:
+  # config.causes_logging_max_depth = 3 # Default is 2
 end
 ```
 

data/lib/sidekiq/exception_utils.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+# Utility that allows us to get a hash representation of an exception
+module ExceptionUtils
+  module_function
+
+  def get_exception_with_cause_hash(exc, parent_backtrace = nil, max_depth_left: 1)
+    error_hash = {
+      'class' => exc.class.to_s,
+      'message' => exc.message,
+      'backtrace' => backtrace_for(exc, parent_backtrace)
+    }
+
+    if (cause = exc.cause) && max_depth_left.positive?
+      # Pass the current backtrace as the parent_backtrace to the cause to shorten cause's backtrace list
+      error_hash['cause'] = get_exception_with_cause_hash(cause, exc.backtrace, max_depth_left: max_depth_left - 1)
+    end
+
+    error_hash
+  end
+
+  def backtrace_for(exception, parent_backtrace = nil)
+    backtrace = exception.backtrace || []
+    if parent_backtrace
+      common_lines = backtrace.reverse.zip(parent_backtrace.reverse).take_while { |a, b| a == b }
+
+      backtrace = backtrace[0...-common_lines.length] if common_lines.any?
+    end
+
+    backtrace
+  end
+end

data/lib/sidekiq/logging/shared.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'sidekiq/exception_utils'
+
 module Sidekiq
   module Logging
     # Shared module with all the logics used by job loggers.
@@ -50,10 +52,24 @@ module Sidekiq
         payload['message'] += ": fail: #{payload['duration']} sec"
         payload['job_status'] = 'fail'
 
-        exc = exc.cause || exc if exc.is_a? Sidekiq::JobRetry::Handled
-        payload['error_message'] = exc.message
-        payload['error'] = exc.class
-        payload['error_backtrace'] = %('#{exc.backtrace.join("\n")}')
+        config = Sidekiq::Logstash.configuration
+        if config.log_job_exception_with_causes
+          payload['error'] = ExceptionUtils.get_exception_with_cause_hash(
+            exc, max_depth_left: config.causes_logging_max_depth
+          )
+        else
+          exc = exc.cause || exc if exc.is_a? Sidekiq::JobRetry::Handled
+          payload['error_message'] = exc.message
+          payload['error'] = exc.class.to_s
+          payload['error_backtrace'] = %('#{exc.backtrace.join("\n")}')
+          if (cause = exc.cause)
+            payload['error_cause'] = {
+              'class' => cause.class.to_s,
+              'message' => cause.message,
+              'backtrace' => ExceptionUtils.backtrace_for(cause, exc.backtrace)
+            }
+          end
+        end
 
         process_payload(payload)
       end

data/lib/sidekiq/logstash/configuration.rb

@@ -4,11 +4,18 @@ module Sidekiq
   module Logstash
     # Class that allows to configure the gem behaviour.
     class Configuration
-      attr_accessor :custom_options, :filter_args, :job_start_log, :keep_default_error_handler
+      attr_accessor :custom_options,
+                    :filter_args,
+                    :job_start_log,
+                    :keep_default_error_handler,
+                    :log_job_exception_with_causes,
+                    :causes_logging_max_depth
 
       def initialize
         @filter_args = []
         @job_start_log = false
+        @log_job_exception_with_causes = false
+        @causes_logging_max_depth = 2
       end
 
       # Added to ensure custom_options is a Proc

data/lib/sidekiq/logstash/version.rb

@@ -2,6 +2,6 @@
 
 module Sidekiq
   module Logstash
-    VERSION = '3.1.0'
+    VERSION = '3.2.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-logstash
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Mattia Giuffrida
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-09-03 00:00:00.000000000 Z
+date: 2024-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstash-event
@@ -60,6 +60,7 @@ files:
 - bin/console
 - bin/setup
 - bin/test_console
+- lib/sidekiq/exception_utils.rb
 - lib/sidekiq/logging/argument_filter.rb
 - lib/sidekiq/logging/logstash_formatter.rb
 - lib/sidekiq/logging/shared.rb