sidekiq-logstash 1.2.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 808f360cfd63cff59fc4bd8a80635a2dc8968dd0fdda23c29b6f67091f940a88
-  data.tar.gz: c01964667f42fc39b3e16e3a4d387e9ba5409b03b31dd568ba4b9d3c59e3605b
+  metadata.gz: 601ba193456b4d27b5ea6458e7fcddd106b66c00625034cd0e1d32d8dcd6208c
+  data.tar.gz: 7062a09bb4781feab169b361748335a3c5871f10d67dd7f6a34eb895bd77818d
 SHA512:
-  metadata.gz: 256a245e0b055e617a5dc715dad09d2f02c82aeb817465cfed9fb5a5556dc9a2f56e43a454ab54e28fcf179d1d2886099dd55a0c0238985b86bb3a4c24622162
-  data.tar.gz: f9dd368e75160a3422b9068a195f187241a71cb683d3bedb272c0dbfc7e7d16e11e3938f29b9fa1e139ba86ac7e043dc2421c76ac722028271222d31a7889d52
+  metadata.gz: 015ebbb8c4014677d5b39b2d944bc3ebb067b830dcf9e967a7e5c5e6998da028c6e3a75fac92089d936ccb7d2bdc9860aacbb4e3dae61e7fb8b64f1d98264bf1
+  data.tar.gz: f373b9c2e388188f22996dbb9ad938a04ebdbab114e61aa9815f57985898b5a136f6ba71b65081b6c95bd542a53e31a0afbd6b3de7d63921d5d1f5ea868a1c31

data/.github/workflows/ci.yml

@@ -0,0 +1,39 @@
+name: CI
+
+on:
+  pull_request:
+
+  push:
+    branches: [master]
+
+env:
+  GIT_COMMIT_SHA: ${{ github.sha }}
+  GIT_BRANCH: ${{ github.ref }}
+
+jobs:
+  linting:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.7
+          bundler-cache: true 
+      - name: Run rubocop
+        run: bundle exec rubocop --format progress
+  build:
+    needs: [linting]
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: ['2.6', '2.7', '3.0', '3.1']
+
+    steps:
+      - uses: actions/checkout@v2
+      - 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

@@ -0,0 +1,29 @@
+name: Publish
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    name: Publish to Rubygems
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@master
+
+      - name: Set up Ruby 2.7
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: 2.7.x
+
+      - name: Publish to RubyGems
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+          gem build sidekiq-logstash.gemspec
+          gem push sidekiq-logstash-*.gem
+        env:
+          GEM_HOST_API_KEY: ${{ secrets.RUBYGEMS_AUTH_TOKEN }}

data/.rubocop.yml

@@ -6,17 +6,18 @@ require:
 AllCops:
   DisplayCopNames: true
   DisplayStyleGuide: true
-  TargetRubyVersion: 2.3
+  NewCops: enable
+  TargetRubyVersion: 2.5
 
 Metrics/BlockLength:
   Exclude:
     - spec/**/*.rb
 
-Metrics/LineLength:
+Layout/LineLength:
   Max: 120
   Exclude:
     - spec/**/*.rb
 
 Style/Documentation:
   Exclude:
-    - 'spec/**/*'
+    - 'spec/**/*'

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2019-04-20 13:23:53 +0200 using RuboCop version 0.67.2.
+# on 2020-08-16 16:36:05 UTC using RuboCop version 0.89.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -11,31 +11,27 @@ Lint/DuplicateMethods:
   Exclude:
     - 'lib/sidekiq/logstash/configuration.rb'
 
-# Offense count: 4
+# Offense count: 3
+# Configuration parameters: IgnoredMethods.
 Metrics/AbcSize:
-  Max: 31
+  Max: 36
 
-# Offense count: 1
+# Offense count: 2
+# Configuration parameters: IgnoredMethods.
 Metrics/CyclomaticComplexity:
-  Max: 13
+  Max: 18
 
 # Offense count: 6
-# Configuration parameters: CountComments, ExcludedMethods.
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods.
 Metrics/MethodLength:
   Max: 28
 
 # Offense count: 1
+# Configuration parameters: IgnoredMethods.
 Metrics/PerceivedComplexity:
-  Max: 14
+  Max: 19
 
-# Offense count: 7
-Style/Documentation:
+# Offense count: 1
+Style/OptionalBooleanParameter:
   Exclude:
-    - 'spec/**/*'
-    - 'lib/sidekiq/logging/argument_filter.rb'
-    - 'lib/sidekiq/logging/logstash_formatter.rb'
-    - 'lib/sidekiq/logging/shared.rb'
-    - 'lib/sidekiq/logstash.rb'
-    - 'lib/sidekiq/logstash/configuration.rb'
-    - 'lib/sidekiq/logstash_job_logger.rb'
-    - 'lib/sidekiq/middleware/server/logstash_logging.rb'
+    - 'spec/workers/spec_worker.rb'

data/.ruby-version

@@ -1 +1 @@
-2.3.0
+2.7.1

data/Gemfile

@@ -2,6 +2,7 @@
 
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in sidekiq-logstash.gemspec
-
 gemspec
+
+gem 'rubocop-rake'
+gem 'rubocop-rspec'

data/README.md

@@ -1,7 +1,7 @@
 # Sidekiq::Logstash
 
-[![Gem Version](https://badge.fury.io/rb/sidekiq-logstash.svg)](https://badge.fury.io/rb/sidekiq-logstash) [<img src="https://travis-ci.org/iMacTia/sidekiq-logstash.svg?branch=master" alt="version" />](https://travis-ci.org/iMacTia/sidekiq-logstash)
-
+[![Gem Version](https://badge.fury.io/rb/sidekiq-logstash.svg)](https://badge.fury.io/rb/sidekiq-logstash)
+[![GitHub Actions CI](https://github.com/iMacTia/sidekiq-logstash/workflows/CI/badge.svg)](https://github.com/iMacTia/sidekiq-logstash/actions?query=workflow%3ACI)
 
 Sidekiq::Logstash turns your [Sidekiq](https://github.com/mperham/sidekiq) log into an organised, aggregated, JSON-syntax log ready to be sent to a logstash server.
 
@@ -30,10 +30,11 @@ Sidekiq::Logstash turns your [Sidekiq](https://github.com/mperham/sidekiq) log i
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add one of the following lines to your application's Gemfile:
 
 ```ruby
-gem 'sidekiq-logstash'
+gem 'sidekiq-logstash', '~> 2.0' # Sidekiq 6
+gem 'sidekiq-logstash', '< 2' # Sidekiq 5 or older
 ```
 
 And then execute:

data/bin/test_console

@@ -4,7 +4,7 @@
 require 'bundler/setup'
 require 'sidekiq/logstash'
 require_relative '../spec/spec_helper'
-FactoryGirl.find_definitions
+FactoryBot.find_definitions
 
 require 'irb'
 IRB.start

data/lib/sidekiq/logging/argument_filter.rb

@@ -14,7 +14,7 @@ module Sidekiq
       end
 
       # Filters argument by using the filters provided upon initialization.
-      # @param args [Array] the list of arguments.
+      # @param args [Hash] the list of arguments in a hash with key :args.
       def filter(args)
         compiled_filter.call(args)
       end
@@ -63,7 +63,7 @@ module Sidekiq
             parents.push(key) if deep_regexps
             if regexps.any? { |r| key =~ r }
               value = FILTERED
-            elsif deep_regexps && (joined = parents.join('.')) && deep_regexps.any? { |r| joined =~ r }
+            elsif deep_regexps && (joined = parents.join('.')) && deep_regexps.any? { |r| joined =~ r } # rubocop:disable Lint/DuplicateBranch
               value = FILTERED
             elsif value.is_a?(Hash)
               value = call(value, parents)
@@ -71,15 +71,15 @@ module Sidekiq
               value = value.map { |v| v.is_a?(Hash) ? call(v, parents) : v }
             elsif blocks.any?
               key = begin
-                      key.dup
-                    rescue StandardError
-                      key
-                    end
+                key.dup
+              rescue StandardError
+                key
+              end
               value = begin
-                        value.dup
-                      rescue StandardError
-                        value
-                      end
+                value.dup
+              rescue StandardError
+                value
+              end
               blocks.each { |b| b.call(key, value) }
             end
             parents.pop if deep_regexps

data/lib/sidekiq/logging/shared.rb

@@ -15,8 +15,8 @@ module Sidekiq
       rescue StandardError => e
         begin
           Sidekiq.logger.warn log_job_exception(job, started_at, e)
-        rescue StandardError => ex
-          log_standard_error(job, e, ex)
+        rescue StandardError => e
+          log_standard_error(job, e, e)
         end
         raise
       end
@@ -49,6 +49,8 @@ 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")}')
@@ -88,11 +90,11 @@ module Sidekiq
         payload['args'][-1] = ENCRYPTED if payload['encrypt']
 
         # Needs to map all args to strings for ElasticSearch compatibility
-        payload['args'].map!(&:to_s)
+        deep_stringify!(payload['args'])
 
         # Needs to map all unique_args to strings for ElasticSearch
         # compatibility in case sidekiq-unique-jobs is used
-        payload['unique_args']&.map!(&:to_s)
+        deep_stringify!(payload['unique_args'])
 
         if payload['retry'].is_a?(Integer)
           payload['max_retries'] = payload['retry']
@@ -124,6 +126,17 @@ module Sidekiq
       def filter_args
         Sidekiq::Logstash.configuration.filter_args
       end
+
+      def deep_stringify!(args)
+        case args
+        when Hash
+          args.map { |key, value| [deep_stringify!(key), deep_stringify!(value)] }.to_h
+        when Array
+          args.map! { |val| deep_stringify!(val) }
+        else
+          args.to_s
+        end
+      end
     end
   end
 end

data/lib/sidekiq/logstash/version.rb

@@ -2,6 +2,6 @@
 
 module Sidekiq
   module Logstash
-    VERSION = '1.2.0'
+    VERSION = '2.0.1'
   end
 end

data/lib/sidekiq/logstash.rb

@@ -2,7 +2,6 @@
 
 require 'sidekiq/logstash/configuration'
 require 'sidekiq/logstash/version'
-require 'sidekiq/middleware/server/logstash_logging'
 require 'sidekiq/logging/logstash_formatter'
 require 'sidekiq/logging/argument_filter'
 require 'sidekiq/logstash_job_logger'
@@ -27,15 +26,7 @@ module Sidekiq
         config.error_handlers.delete_if { |h| h.is_a?(Sidekiq::ExceptionHandler::Logger) }
 
         # Add logstash support
-        # The logging server middleware was removed in Sidekiq 5.0.0, see: https://github.com/mperham/sidekiq/blob/master/Changes.md
-        if Sidekiq::Middleware::Server.const_defined?(:Logging)
-          config.server_middleware do |chain|
-            chain.add Sidekiq::Middleware::Server::LogstashLogging
-            chain.remove Sidekiq::Middleware::Server::Logging
-          end
-        else
-          Sidekiq.options[:job_logger] = Sidekiq::LogstashJobLogger
-        end
+        config.options[:job_logger] = Sidekiq::LogstashJobLogger
 
         # Set custom formatter for Sidekiq logger
         config.logger.formatter = Sidekiq::Logging::LogstashFormatter.new

data/lib/sidekiq/logstash_job_logger.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 
+require 'sidekiq/job_logger'
 require 'sidekiq/logging/shared'
 
 module Sidekiq
-  # Class used to replace Sidekiq 5 job logger.
-  class LogstashJobLogger
+  # Class used to replace Sidekiq default job logger.
+  class LogstashJobLogger < ::Sidekiq::JobLogger
     include Sidekiq::Logging::Shared
 
     def call(job, _queue, &block)

data/sidekiq-logstash.gemspec

@@ -18,18 +18,16 @@ Gem::Specification.new do |spec|
   spec.license = 'MIT'
 
   spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir = 'exe'
-  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.5.0'
 
   spec.add_dependency 'logstash-event', '~> 1.2'
-  spec.add_runtime_dependency 'sidekiq', '>= 3.0', '<6'
+  spec.add_runtime_dependency 'sidekiq', '>= 6.0', '<7'
 
-  spec.add_development_dependency 'bundler', '< 2'
-  spec.add_development_dependency 'factory_girl', '~> 4.0'
-  spec.add_development_dependency 'rake', '~> 10.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', '~> 0.67.2'
-  spec.add_development_dependency 'rubocop-performance'
+  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: 1.2.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Mattia Giuffrida
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2019-04-24 00:00:00.000000000 Z
+date: 2022-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstash-event
@@ -30,62 +30,48 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '6.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
+        version: '6.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '7'
 - !ruby/object:Gem::Dependency
-  name: factory_girl
+  name: factory_bot
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '6.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '10'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -115,59 +101,43 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 2.1.0
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.67.2
+        version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.67.2
-- !ruby/object:Gem::Dependency
-  name: rubocop-performance
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        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.
 
-'
+  '
 email:
 - giuffrida.mattia@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
+- ".github/workflows/publish.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
 - ".ruby-gemset"
 - ".ruby-version"
-- ".travis.yml"
 - Gemfile
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
 - bin/test_console
-- gemfiles/sidekiq3.gemfile
-- gemfiles/sidekiq4.gemfile
-- gemfiles/sidekiq5.gemfile
 - lib/sidekiq/logging/argument_filter.rb
 - lib/sidekiq/logging/logstash_formatter.rb
 - lib/sidekiq/logging/shared.rb
@@ -175,12 +145,12 @@ files:
 - lib/sidekiq/logstash/configuration.rb
 - lib/sidekiq/logstash/version.rb
 - lib/sidekiq/logstash_job_logger.rb
-- lib/sidekiq/middleware/server/logstash_logging.rb
 - sidekiq-logstash.gemspec
 homepage: https://github.com/iMacTia/sidekiq-logstash
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -189,14 +159,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Logstash plugin for Sidekiq

data/.travis.yml

@@ -1,24 +0,0 @@
-language: ruby
-cache: bundler
-rvm:
-- 2.3
-- 2.4
-- 2.5
-- 2.6
-before_install:
-  - gem uninstall -v '>= 2' -i $(rvm gemdir)@global -ax bundler || true
-  - gem install bundler -v '~> 1.17'
-gemfile:
-- gemfiles/sidekiq3.gemfile
-- gemfiles/sidekiq4.gemfile
-- gemfiles/sidekiq5.gemfile
-deploy:
-  provider: rubygems
-  api_key:
-    secure: HQ8O6JFLXqs91LFfAkwQyk3NGJ6EAvTrlS1IHGZrU8qHz+4or7VQJEAtwhimy7Za2Kylhr5t1oIK/D+9Ko8YmSZzVKtFoMwQLEQizNjt1zmkcrVsGVBewm8Dp6e9eEceYap0zm/LSMRog7ePicDUbkfg3eoZxuWPSd3L5AuQ73VydDL9WFTiv1ilCdx+DQAZ5D7NjfP6//FlP3QHHAu+SLj1vz3ejB6FgJndrKB45FEYnKH0J0jcnuTHjcrHxURmzot1+MSi322bLdQLY/I1t7GAdyGEvv+5GdCZn8PyCbK9Z3YktBXMGG/oILxhoUvTrWbrJzce6TlijywekXUU3uljJOW7gvLAYDaHSKO249YyvvjZrFwbqaBS+SFFRfeNnYOkiZjQAN+3t4QHLd4OOTPMiUagIAJqjrMwS56HQxoPUz+4gJ0mTvMG9VO1WZgbDyFqYyoiQZbtOoc8p4uDdhq3pbDR2cA4PfVOLGDDrkaKb5rqzrjuDfWNleTgIst2ON+xfMJy/uvvBLvcWAkYLwNNvhJn2tn01Zuaj+DMzk5+KU6tSmtSgfvAh/DmTHZDrMKuyGDgSUomicAbUVR9U6/+r4EHMuwvXs2UpSH+0oIxxJIdjb2T55yAid2XrI3fbzvnoReT21UkPWAnrjlUXZ/XFfjCrhS+NxNjZOUMuns=
-  gem: sidekiq-logstash
-  on:
-    tags: true
-    repo: iMacTia/sidekiq-logstash
-    rvm: 2.6
-

data/gemfiles/sidekiq3.gemfile

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-gem 'sidekiq', '~> 3.0'
-
-gemspec path: '../'

data/gemfiles/sidekiq4.gemfile

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-gem 'sidekiq', '~> 4.0'
-
-gemspec path: '../'

data/gemfiles/sidekiq5.gemfile

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-gem 'sidekiq', '~> 5.0'
-
-gemspec path: '../'

data/lib/sidekiq/middleware/server/logstash_logging.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-require 'sidekiq/logging/shared'
-
-module Sidekiq
-  module Middleware
-    module Server
-      # Class used to replace Sidekiq 4 job logger.
-      class LogstashLogging
-        include Sidekiq::Logging::Shared
-
-        def call(_, job, _, &block)
-          log_job(job, &block)
-        end
-      end
-    end
-  end
-end