sidekiq-logstash 0.2.7 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c54b77c31a5eb54f6c84576418b7234529cb9bfc
-  data.tar.gz: 357e85b61ea8b461faeb674b8a59fc6ac6994246
+  metadata.gz: 25dbb440e6e8695797cc7857512139580ea799dc
+  data.tar.gz: adc96a196faa34ee2b45822bca2cb6328fe1061c
 SHA512:
-  metadata.gz: 9dde07aa8728fa8821d509fc5688606cf782c66e0e03ddcc0445603800215680a61d91544031ac7eae0adfbc8430311192e632e33d276a12cbfbe7496387a469
-  data.tar.gz: f225621395cf05ffe095a36bd429bb041b9137dcef41925896e84d23d5c5cad4dba9c31f03f45c9b5f906800b639b34a9112f28f5352ef684c936b1fb93deffd
+  metadata.gz: f10f38029bd0168fe3306fba03d3d7b6cce126a78333e7ce8e791194332988979a37d07d4bf5ea00c65e606f233e153cfc91af2702b26d2810adbd679e57dd4e
+  data.tar.gz: 52fcd3c3e046e03b7e1c464d1eff487a916f06ebfd51fb435f9539650a2d690241ff8548136385bbac93f1e5f345ff0a260d4ba1072fc04d7515011538bb700c

data/.ruby-gemset

@@ -0,0 +1 @@
+sidekiq-logstash

data/.ruby-version

@@ -0,0 +1 @@
+2.3.0

data/.travis.yml

@@ -1,4 +1,10 @@
 language: ruby
 rvm:
   - 2.2.2
+  - 2.3.0
+  - 2.4.0
 before_install: gem install bundler -v 1.11.2
+
+gemfile:
+  - gemfiles/sidekiq4.gemfile
+  - gemfiles/sidekiq5.gemfile

data/Gemfile

@@ -1,4 +1,5 @@
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in sidekiq-logstash.gemspec
+
 gemspec

data/README.md

@@ -2,6 +2,7 @@
 
 [![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)
 
+
 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.
 
 ```json

data/gemfiles/sidekiq4.gemfile

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

data/gemfiles/sidekiq5.gemfile

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

data/lib/sidekiq/logging/argument_filter.rb

@@ -26,12 +26,12 @@ module Sidekiq
           strings, regexps, blocks = [], [], []
           filters.each do |item|
             case item
-              when Proc
-                blocks << item
-              when Regexp
-                regexps << item
-              else
-                strings << Regexp.escape(item.to_s)
+            when Proc
+              blocks << item
+            when Regexp
+              regexps << item
+            else
+              strings << Regexp.escape(item.to_s)
             end
           end
           deep_regexps, regexps = regexps.partition { |r| r.to_s.include?("\\.".freeze) }
@@ -44,9 +44,9 @@ module Sidekiq
         attr_reader :regexps, :deep_regexps, :blocks
 
         def initialize(regexps, deep_regexps, blocks)
-          @regexps = regexps
+          @regexps      = regexps
           @deep_regexps = deep_regexps.any? ? deep_regexps : nil
-          @blocks  = blocks
+          @blocks       = blocks
         end
 
         def call(original_args, parents = [])

data/lib/sidekiq/logging/logstash_formatter.rb

@@ -9,7 +9,7 @@ module Sidekiq
         else
           json_data = {
               severity: severity,
-              message: data
+              message:  data
           }
         end
 

data/lib/sidekiq/logging/shared.rb

@@ -0,0 +1,62 @@
+module Sidekiq
+  module Logging
+    module Shared
+      def log_job(payload, started_at, exc = nil)
+        # Create a copy of the payload using JSON
+        # This should always be possible since Sidekiq store it in Redis
+        payload = JSON.parse(JSON.unparse(payload))
+
+        # Convert timestamps into Time instances
+        %w( created_at enqueued_at retried_at failed_at completed_at ).each do |key|
+          payload[key] = parse_time(payload[key]) if payload[key]
+        end
+
+        # Add process id params
+        payload['pid']      = ::Process.pid
+        payload['duration'] = elapsed(started_at)
+
+        message = "#{payload['class']} JID-#{payload['jid']}"
+
+        if exc
+          payload['message']         = "#{message}: fail: #{payload['duration']} sec"
+          payload['job_status']      = 'fail'
+          payload['error_message']   = exc.message
+          payload['error']           = exc.class
+          payload['error_backtrace'] = %('#{exc.backtrace.join("\n")}')
+        else
+          payload['message']      = "#{message}: done: #{payload['duration']} sec"
+          payload['job_status']   = 'done'
+          payload['completed_at'] = Time.now.utc
+        end
+
+        # Filter sensitive parameters
+        unless filter_args.empty?
+          args_filter     = Sidekiq::Logging::ArgumentFilter.new(filter_args)
+          payload['args'] = args_filter.filter({ args: payload['args'] })[:args]
+        end
+
+        # Needs to map all args to strings for ElasticSearch compatibility
+        payload['args'].map!(&:to_s)
+
+        payload
+      end
+
+      def elapsed(start)
+        (Time.now.utc - start).round(3)
+      end
+
+      def parse_time(timestamp)
+        return timestamp if timestamp.is_a? Time
+        timestamp.is_a?(Float) ?
+            Time.at(timestamp).utc :
+            Time.parse(timestamp)
+      rescue
+        timestamp
+      end
+
+      def filter_args
+        Sidekiq::Logstash.configuration.filter_args
+      end
+    end
+  end
+end

data/lib/sidekiq/logstash.rb

@@ -3,6 +3,7 @@ require 'sidekiq/logstash/version'
 require 'sidekiq/middleware/server/logstah_logging'
 require 'sidekiq/logging/logstash_formatter'
 require 'sidekiq/logging/argument_filter'
+require 'sidekiq/logstash_job_logger'
 
 module Sidekiq
   module Logstash
@@ -18,12 +19,17 @@ module Sidekiq
       # Calls Sidekiq.configure_server to inject logics
       Sidekiq.configure_server do |config|
         # Remove default Sidekiq error_handler that logs errors
-        config.error_handlers.delete_if {|h| h.is_a?(Sidekiq::ExceptionHandler::Logger) }
+        config.error_handlers.delete_if { |h| h.is_a?(Sidekiq::ExceptionHandler::Logger) }
 
         # Add logstash support
-        config.server_middleware do |chain|
-          chain.add Sidekiq::Middleware::Server::LogstashLogging
-          chain.remove Sidekiq::Middleware::Server::Logging
+        # 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
 
         # Set custom formatter for Sidekiq logger

data/lib/sidekiq/logstash/version.rb

@@ -1,5 +1,5 @@
 module Sidekiq
   module Logstash
-    VERSION = '0.2.7'
+    VERSION = '0.3.0'
   end
 end

data/lib/sidekiq/logstash_job_logger.rb

@@ -0,0 +1,23 @@
+require 'sidekiq/logging/shared'
+
+module Sidekiq
+  class LogstashJobLogger
+    include Sidekiq::Logging::Shared
+
+    def call(job, _queue)
+      started_at = Time.now.utc
+      yield
+      Sidekiq.logger.info log_job(job, started_at)
+    rescue => exc
+      begin
+        Sidekiq.logger.warn log_job(job, started_at, exc)
+      rescue => ex
+        Sidekiq.logger.error 'Error logging the job execution!'
+        Sidekiq.logger.error "Job: #{job}"
+        Sidekiq.logger.error "Job Exception: #{exc}"
+        Sidekiq.logger.error "Log Exception: #{ex}"
+      end
+      raise
+    end
+  end
+end

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

@@ -1,7 +1,11 @@
+require 'sidekiq/logging/shared'
+
 module Sidekiq
   module Middleware
     module Server
       class LogstashLogging
+        include Sidekiq::Logging::Shared
+
         def call(_, job, _)
           started_at = Time.now.utc
           yield
@@ -17,63 +21,6 @@ module Sidekiq
           end
           raise
         end
-
-        def log_job(payload, started_at, exc = nil)
-          # Create a copy of the payload using JSON
-          # This should always be possible since Sidekiq store it in Redis
-          payload = JSON.parse(JSON.unparse(payload))
-
-          # Convert timestamps into Time instances
-          %w( created_at enqueued_at retried_at failed_at completed_at ).each do |key|
-            payload[key] = parse_time(payload[key]) if payload[key]
-          end
-
-          # Add process id params
-          payload['pid'] = ::Process.pid
-          payload['duration'] = elapsed(started_at)
-
-          message = "#{payload['class']} JID-#{payload['jid']}"
-
-          if exc
-            payload['message'] = "#{message}: fail: #{payload['duration']} sec"
-            payload['job_status'] = 'fail'
-            payload['error_message'] = exc.message
-            payload['error'] = exc.class
-            payload['error_backtrace'] = %('#{exc.backtrace.join("\n")}')
-          else
-            payload['message'] = "#{message}: done: #{payload['duration']} sec"
-            payload['job_status'] = 'done'
-            payload['completed_at'] = Time.now.utc
-          end
-
-          # Filter sensitive parameters
-          unless filter_args.empty?
-            args_filter = Sidekiq::Logging::ArgumentFilter.new(filter_args)
-            payload['args'] = args_filter.filter({ args: payload['args'] })[:args]
-          end
-
-          # Needs to map all args to strings for ElasticSearch compatibility
-          payload['args'].map!(&:to_s)
-
-          payload
-        end
-
-        def elapsed(start)
-          (Time.now.utc - start).round(3)
-        end
-
-        def parse_time(timestamp)
-          return timestamp if timestamp.is_a? Time
-          timestamp.is_a?(Float) ?
-              Time.at(timestamp).utc :
-              Time.parse(timestamp)
-        rescue
-          timestamp
-        end
-
-        def filter_args
-          Sidekiq::Logstash.configuration.filter_args
-        end
       end
     end
   end

data/sidekiq-logstash.gemspec

@@ -22,7 +22,7 @@ DESC
   spec.require_paths = ['lib']
 
   spec.add_dependency 'logstash-event', '~> 1.2'
-  spec.add_runtime_dependency 'sidekiq', '~> 4.0'
+  spec.add_runtime_dependency 'sidekiq', '>= 4.0' , '<6'
 
   spec.add_development_dependency 'bundler', '~> 1.11'
   spec.add_development_dependency 'rake', '~> 10.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-logstash
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.3.0
 platform: ruby
 authors:
 - Mattia Giuffrida
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-04 00:00:00.000000000 Z
+date: 2017-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstash-event
@@ -28,16 +28,22 @@ dependencies:
   name: sidekiq
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -106,6 +112,8 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
 - ".travis.yml"
 - Gemfile
 - README.md
@@ -113,11 +121,15 @@ files:
 - bin/console
 - bin/setup
 - bin/test_console
+- gemfiles/sidekiq4.gemfile
+- gemfiles/sidekiq5.gemfile
 - 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/version.rb
+- lib/sidekiq/logstash_job_logger.rb
 - lib/sidekiq/middleware/server/logstah_logging.rb
 - sidekiq-logstash.gemspec
 homepage: https://github.com/iMacTia/sidekiq-logstash
@@ -140,7 +152,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Logstash plugin for Sidekiq