sidekiq-logstash 3.0.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de10e32b59ccde04045df621855e1257e4290003c08686be06ac2691ff3eadce
-  data.tar.gz: 2ae07b48658b5f72bef3fa621eef3f57eac826fbd976dcadd3ec2df6e4c74549
+  metadata.gz: 7da540744ff32bbe1218075f40fa979c9b5a9bdb7211c45df40ec8191b2b51cc
+  data.tar.gz: '09e58a7cd2504538079fc8493e7fef3a59a9217736a0b1bf1425f6ba208f20c8'
 SHA512:
-  metadata.gz: 85183e59824a52c5f8394ba5d45e0ca7a8df48dc6b1f668c2c0e880102713a3f7678e19f141172a78909bf030186210d644101b93684edf2f513ef31dceee3e0
-  data.tar.gz: a56567d1a6715345e11bc5292188bf20a7c3db4b11f433071def26f9a39e95a366e14ffbceaf537f56021211c0dc2607fc275b6bcf0a46da5fdef2a6154449ae
+  metadata.gz: 746c123b2341c14f1d565d830f489a5eddb6591ba56f6c72ffaafd737524126cd24df17fdc808af5b8271fa88f94c5e5356d37e923ba5327cf849a56080d7d7e
+  data.tar.gz: f79226102532246d67bffcbe478d6e30781838d995d7c50f627e6a309f49f1a1b347aa7dbc1720733985a217a98d9c97d77db71ff53097d4b29c8fcd217012bc

data/.github/workflows/ci.yml

@@ -10,16 +10,20 @@ env:
   GIT_COMMIT_SHA: ${{ github.sha }}
   GIT_BRANCH: ${{ github.ref }}
 
+permissions:
+  contents: read # to fetch code (actions/checkout)
+
 jobs:
   linting:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 2.7
+          ruby-version: 3
           bundler-cache: true
+
       - name: Run rubocop
         run: bundle exec rubocop --format progress
   build:
@@ -27,13 +31,14 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby: ['2.7', '3.0', '3.1']
+        ruby: ['3.0', '3.1', '3.2', '3.3']
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true
+
       - name: Run tests
         run: bundle exec rake

data/.github/workflows/publish.yml

@@ -10,12 +10,10 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@master
-
-      - name: Set up Ruby 2.7
-        uses: actions/setup-ruby@v1
+      - uses: actions/checkout@v4
+      - uses: actions/setup-ruby@v1
         with:
-          ruby-version: 2.7.x
+          ruby-version: 3
 
       - name: Publish to RubyGems
         run: |

data/.rubocop.yml

@@ -7,12 +7,15 @@ AllCops:
   DisplayCopNames: true
   DisplayStyleGuide: true
   NewCops: enable
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 3.0
 
 Metrics/BlockLength:
   Exclude:
     - spec/**/*.rb
 
+Metrics/ModuleLength:
+  Enabled: false 
+
 Layout/LineLength:
   Max: 120
   Exclude:

data/Gemfile

@@ -3,3 +3,9 @@
 source 'https://rubygems.org'
 
 gemspec
+
+gem 'factory_bot', github: 'thoughtbot/factory_bot', branch: 'main'
+gem 'rake'
+gem 'rspec'
+gem 'rspec-json_expectations'
+gem 'rubocop-performance'

data/README.md

@@ -33,6 +33,7 @@ Sidekiq::Logstash turns your [Sidekiq](https://github.com/mperham/sidekiq) log i
 Add one of the following lines to your application's Gemfile:
 
 ```ruby
+gem 'sidekiq-logstash', '~> 3.0' # Sidekiq 7
 gem 'sidekiq-logstash', '~> 2.0' # Sidekiq 6
 gem 'sidekiq-logstash', '< 2' # Sidekiq 5 or older
 ```
@@ -82,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/argument_filter.rb

@@ -27,7 +27,7 @@ module Sidekiq
 
       class CompiledFilter # :nodoc:
         def self.compile(filters)
-          return ->(args) { args.dup } if filters.empty?
+          return lambda(&:dup) if filters.empty?
 
           strings = []
           regexps = []

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.0.0'
+    VERSION = '3.2.0'
   end
 end

data/lib/sidekiq/logstash.rb

@@ -4,7 +4,6 @@ require 'sidekiq/logstash/configuration'
 require 'sidekiq/logstash/version'
 require 'sidekiq/logging/logstash_formatter'
 require 'sidekiq/logging/argument_filter'
-require 'sidekiq/logstash_job_logger'
 
 module Sidekiq
   # Main level module for Sidekiq::Logstash.
@@ -22,6 +21,8 @@ module Sidekiq
     def self.setup(_opts = {})
       # Calls Sidekiq.configure_server to inject logics
       Sidekiq.configure_server do |config|
+        require 'sidekiq/logstash_job_logger'
+
         # Remove default, noisy error handler,
         # unless LogStash.configuration.keep_default_error_handler is set to true
         unless configuration.keep_default_error_handler

data/sidekiq-logstash.gemspec

@@ -19,15 +19,10 @@ Gem::Specification.new do |spec|
 
   spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.require_paths = ['lib']
-  spec.required_ruby_version = '>= 2.7.0'
+  spec.required_ruby_version = '>= 3.0.0'
 
   spec.add_dependency 'logstash-event', '~> 1.2'
   spec.add_dependency 'sidekiq', '~> 7.0'
 
-  spec.add_development_dependency 'factory_bot', '~> 6.1'
-  spec.add_development_dependency 'rake', '>= 10'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rspec-json_expectations', '~> 2.1.0'
-  spec.add_development_dependency 'rubocop-performance', '~> 1.5'
   spec.metadata['rubygems_mfa_required'] = 'true'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-logstash
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Mattia Giuffrida
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-04 00:00:00.000000000 Z
+date: 2024-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstash-event
@@ -38,76 +38,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '7.0'
-- !ruby/object:Gem::Dependency
-  name: factory_bot
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.1'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '10'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '10'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: rspec-json_expectations
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.1.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.1.0
-- !ruby/object:Gem::Dependency
-  name: rubocop-performance
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
 description: 'Sidekiq::Logstash turns your Sidekiq log into an organised, aggregated,
   JSON-syntax log ready to be sent to a logstash server.
 
@@ -130,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
@@ -151,14 +82,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.4.19
 signing_key: 
 specification_version: 4
 summary: Logstash plugin for Sidekiq