sidekiq-logstash 2.0.3 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d03d5f447dd18e3fc0989f94b3b79f74cd73a7ec671bafa8655660e90b8ad11b
-  data.tar.gz: c413e9d405d115d5731190e96dc35eaa853f32a19bf28f32c6556c301333d5d6
+  metadata.gz: '09e505554a5ed16d442f68da725e3647a2cd77d12f36897a657d54ff8a3cb8b8'
+  data.tar.gz: 917723b1952886cfd29070668209e254198d2d9f3d2807aabbd10af0a5b46608
 SHA512:
-  metadata.gz: 2e793efdad13027f544ca878392232c26db9f599f32f1d2aaf7c59ba60e94db318923bd6b754d35b0ff098ab748bba9a0a33a8e28c02895d849a76804bed047c
-  data.tar.gz: 93a5f3dc665067f09615d3958dfd69c192ca743d07fe444aec389859f72eae6229f60f60ced92799962bfdbabba917d8c2c63d5c8f8bec5dcbc9ce583d40b172
+  metadata.gz: f168b77deb49ef0eab0ff308ddfc8539d2b9cf6e1756373ed82301b5a7d5ac063ebefb16fd8a9941b4f0995066b5afcae54b8c9abf6caa1eea190841ca192c15
+  data.tar.gz: ad292af73bb01ef763a1e171d1e960c345775db0128f2d904f32ee7166a654a33c065f2d0838c766e2f4057d5a84c054051c21e1945e1728ebb92bfbbb7018ce

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
-          bundler-cache: true 
+          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.6', '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,7 +7,7 @@ AllCops:
   DisplayCopNames: true
   DisplayStyleGuide: true
   NewCops: enable
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 3.0
 
 Metrics/BlockLength:
   Exclude:

data/Gemfile

@@ -4,5 +4,8 @@ source 'https://rubygems.org'
 
 gemspec
 
-gem 'rubocop-rake'
-gem 'rubocop-rspec'
+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
 ```
@@ -78,6 +79,10 @@ Sidekiq::Logstash.configure do |config|
   config.custom_options = lambda do |payload|
     payload['my_custom_field'] = 'my_custom_value'
   end
+  
+  # by default, sidekiq-logstash removes the default error handler
+  # to keep it, simply set this to true
+  config.keep_default_error_handler = true
 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

@@ -130,7 +130,7 @@ module Sidekiq
       def deep_stringify!(args)
         case args
         when Hash
-          args.map { |key, value| [deep_stringify!(key), deep_stringify!(value)] }.to_h
+          args.to_h { |key, value| [deep_stringify!(key), deep_stringify!(value)] }
         when Array
           args.map! { |val| deep_stringify!(val) }
         else

data/lib/sidekiq/logstash/configuration.rb

@@ -4,7 +4,7 @@ module Sidekiq
   module Logstash
     # Class that allows to configure the gem behaviour.
     class Configuration
-      attr_accessor :custom_options, :filter_args, :job_start_log
+      attr_accessor :custom_options, :filter_args, :job_start_log, :keep_default_error_handler
 
       def initialize
         @filter_args = []

data/lib/sidekiq/logstash/version.rb

@@ -2,6 +2,6 @@
 
 module Sidekiq
   module Logstash
-    VERSION = '2.0.3'
+    VERSION = '3.1.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,21 +21,20 @@ module Sidekiq
     def self.setup(_opts = {})
       # Calls Sidekiq.configure_server to inject logics
       Sidekiq.configure_server do |config|
-        if defined?(Sidekiq::ExceptionHandler::Logger)
-          # Remove default Sidekiq error_handler that logs errors
-          # NOTE: this only exists up until Sidekiq 6.4.x
-          config.error_handlers.delete_if { |h| h.is_a?(Sidekiq::ExceptionHandler::Logger) }
-        end
+        require 'sidekiq/logstash_job_logger'
 
-        # Add logstash support
-        if config.respond_to?(:[]=)
-          # Only available from Sidekiq 6.5
-          config[:job_logger] = Sidekiq::LogstashJobLogger
-        else
-          # This is deprecated and will be removed in Sidekiq 7.0
-          config.options[:job_logger] = Sidekiq::LogstashJobLogger
+        # Remove default, noisy error handler,
+        # unless LogStash.configuration.keep_default_error_handler is set to true
+        unless configuration.keep_default_error_handler
+          config.error_handlers.delete(Sidekiq::Config::ERROR_HANDLER)
+          # Insert a no-op error handler to prevent Sidekiq from logging to STDOUT
+          # because of empty error_handlers (see link).
+          # https://github.com/mperham/sidekiq/blob/02153c17360e712d9a94c08406fe7c057c4d7635/lib/sidekiq/config.rb#L258
+          config.error_handlers << proc {}
         end
 
+        # Add logstash support
+        config[:job_logger] = Sidekiq::LogstashJobLogger
         # Set custom formatter for Sidekiq logger
         config.logger.formatter = Sidekiq::Logging::LogstashFormatter.new
       end

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.5.0'
+  spec.required_ruby_version = '>= 3.0.0'
 
   spec.add_dependency 'logstash-event', '~> 1.2'
-  spec.add_runtime_dependency 'sidekiq', '>= 6.0', '<7'
+  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: 2.0.3
+  version: 3.1.0
 platform: ruby
 authors:
 - Mattia Giuffrida
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-12 00:00:00.000000000 Z
+date: 2024-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstash-event
@@ -26,94 +26,18 @@ dependencies:
         version: '1.2'
 - !ruby/object:Gem::Dependency
   name: sidekiq
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '6.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '7'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '6.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '7'
-- !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
+        version: '7.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '7.0'
 description: 'Sidekiq::Logstash turns your Sidekiq log into an organised, aggregated,
   JSON-syntax log ready to be sent to a logstash server.
 
@@ -157,14 +81,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.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