ezlog 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94596a090c0744c6edb767e0bec261a515c5954a853f061984c5b094d9cf7cf2
-  data.tar.gz: 303cb838d233797f903d74f6d20a38bcae91b43c23b20c544b64930529df4253
+  metadata.gz: 07eba79fc447346727af12f30a5eb9867740056fed910ba8c6e6f005b8b78597
+  data.tar.gz: '08ddf4b8dcd4a22062bfdd0c5134be05698e1426bbc7fcb8704b49a1b846463c'
 SHA512:
-  metadata.gz: 7317b40e4ab676771a660e1bdd24003ba488e5cb7cfcca4b6ff2c9fd8c3360e98fc2cb3398af344cbabb8304bdf00f42c8fe3a852cb13155ec2f6eaf9f1277d6
-  data.tar.gz: 67218232ac200cc27322b83198f9d4bded0d660ada98fffc9f43205a26388a7cd9f47abc9d50d6757b6e9272675283f6213f6d19d1592b0059237cc21924bbfa
+  metadata.gz: 6441fe41467856a284f8ffd4cb534793020b83a749d575da453b37a45a15b4632f82014f853aca89e33af314c1ee02c31254d54242d7e66c52033cf485c1593e
+  data.tar.gz: 91c51f43684577fff83692f58230b9988e530878ddb255a8bbcea43133ceb9a9084fc75b159000d25061407ac5423736f5f3f7903b30f96eaeb7ddc50a442787

data/README.md

@@ -66,24 +66,29 @@ it will automatically be appended to all log messages emitted by the application
 
 #### Configures Sidekiq logging
 
-Ezlog comes with its own job logger for [Sidekiq](https://github.com/mperham/sidekiq) which does several things that 
-come in very handy when working with background jobs.
+Ezlog configures the `Sidekiq.logger` to be an instance of a [Logging](https://github.com/TwP/logging) logger by the name
+of `Sidekiq`, behaving as described above. It also comes with its own job logger for [Sidekiq](https://github.com/mperham/sidekiq) 
+which does several things that come in very handy when working with background jobs.
  
 * It emits two log messages per job run; one when the job is started and another one when the job is finished (successfully or unsuccessfuly).
 * It measures the time it took to execute the job and appends the benchmark information to the final log message.
 * It adds all basic information about the job (worker, queue, JID, created_at, enqueued_at) to the log context so
 all log messages emitted during the execution of the job will contain this information.
-* It also adds all of the job's parameters to the log context, which means that all log messages emitted during the execution
-of the job will contain this information as well.
+* It also adds all of the job's parameters (by name) to the log context, which means that all log messages emitted 
+during the execution of the job will contain this information as well.
 
 ```ruby
 class TestWorker
-  def perform(customer_id, name)
+  def perform(customer_id)
+    logger.warn 'Customer not found'
   end
 end
 
-#=> {"logger":"Sidekiq","timestamp":"2019-05-12T10:38:10+02:00","level":"INFO","hostname":"MacbookPro.local","pid":75538,"jid":"job id","queue":"job queue","worker":"TestWorker","created_at":"2019-05-12 10:38:10 +0200","enqueued_at":"2019-05-12 10:38:10 +0200","customer_id":1,"name":"name param","message":"TestWorker started"}
-#=> {"logger":"Sidekiq","timestamp":"2019-05-12T10:38:12+02:00","level":"INFO","hostname":"MacbookPro.local","pid":75538,"jid":"job id","queue":"job queue","worker":"TestWorker","created_at":"2019-05-12 10:38:10 +0200","enqueued_at":"2019-05-12 10:38:10 +0200","customer_id":1,"name":"name param","duration_sec":2.667,"message":"TestWorker finished"}
+TestWorker.perform_async 42
+
+#=> {"logger":"Sidekiq","timestamp":"2019-05-12T10:38:10+02:00","level":"INFO","hostname":"MacbookPro.local","pid":75538,"jid":"abcdef1234567890","queue":"default","worker":"TestWorker","created_at":"2019-05-12 10:38:10 +0200","enqueued_at":"2019-05-12 10:38:10 +0200","customer_id":42,"message":"TestWorker started"}
+#=> {"logger":"Sidekiq","timestamp":"2019-05-12T10:38:10+02:00","level":"WARN","hostname":"MacbookPro.local","pid":75538,"jid":"abcdef1234567890","queue":"default","worker":"TestWorker","created_at":"2019-05-12 10:38:10 +0200","enqueued_at":"2019-05-12 10:38:10 +0200","customer_id":42,"message":"Customer not found"}
+#=> {"logger":"Sidekiq","timestamp":"2019-05-12T10:38:12+02:00","level":"INFO","hostname":"MacbookPro.local","pid":75538,"jid":"abcdef1234567890","queue":"default","worker":"TestWorker","created_at":"2019-05-12 10:38:10 +0200","enqueued_at":"2019-05-12 10:38:10 +0200","customer_id":42,"duration_sec":2.667,"message":"TestWorker finished"}
 ```
 
 #### Configures Rack::Timeout logging
@@ -98,4 +103,4 @@ Ezlog is highly opinionated software and does in no way aim or claim to be usefu
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the MIT License - see the [LICENSE](/LICENSE.txt) file for the full text.

data/lib/ezlog.rb

@@ -1,4 +1,12 @@
-require 'ezlog/version'
-require 'ezlog/logging_layout'
+require 'logging'
 
+require 'ezlog/version'
 require 'ezlog/railtie' if defined? Rails
+
+module Ezlog
+  autoload :LoggingLayout, 'ezlog/logging_layout'
+
+  def self.logger(name)
+    Logging::Logger[name]
+  end
+end

data/lib/ezlog/logging_layout.rb

@@ -1,6 +1,5 @@
 require 'time'
 require 'multi_json'
-require 'logging'
 
 module Ezlog
   class LoggingLayout < ::Logging::Layout
@@ -57,7 +56,7 @@ module Ezlog
         error: {
           class: exception.class.name,
           message: exception.message,
-          backtrace: exception.backtrace.first(20)
+          backtrace: exception.backtrace&.first(20)
         }
       }
     end

data/lib/ezlog/railtie.rb

@@ -21,11 +21,15 @@ module Ezlog
     private
 
     def initialize_sidekiq_logging
-      ::Sidekiq.logger = Logging.logger['Sidekiq']
+      require 'ezlog/sidekiq/job_logger'
+      require 'ezlog/sidekiq/error_logger'
+
+      ::Sidekiq.logger = ::Logging.logger['Sidekiq']
       ::Sidekiq.logger.level = :info
       ::Sidekiq.configure_server do |config|
-        require 'ezlog/sidekiq/job_logger'
         config.options[:job_logger] = Ezlog::Sidekiq::JobLogger
+        config.error_handlers << Ezlog::Sidekiq::ErrorLogger.new
+        config.error_handlers.delete_if { |handler| handler.is_a? ::Sidekiq::ExceptionHandler::Logger }
       end
     end
 

data/lib/ezlog/sidekiq/error_logger.rb

@@ -0,0 +1,11 @@
+require 'sidekiq'
+
+module Ezlog
+  module Sidekiq
+    class ErrorLogger
+      def call(error, job_hash)
+        ::Sidekiq.logger.warn error
+      end
+    end
+  end
+end

data/lib/ezlog/sidekiq/job_logger.rb

@@ -33,7 +33,8 @@ module Ezlog
           'queue' => job['queue'],
           'worker' => job['class'],
           'created_at' => job['created_at'],
-          'enqueued_at' => job['enqueued_at']
+          'enqueued_at' => job['enqueued_at'],
+          'run_count' => (job['retry_count'] || -1) + 2
         }
       end
 

data/lib/ezlog/version.rb

@@ -1,3 +1,3 @@
 module Ezlog
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ezlog
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Zoltan Ormandi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-12 00:00:00.000000000 Z
+date: 2019-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logging
@@ -117,6 +117,7 @@ files:
 - lib/ezlog/rspec.rb
 - lib/ezlog/rspec/helpers.rb
 - lib/ezlog/rspec/matchers.rb
+- lib/ezlog/sidekiq/error_logger.rb
 - lib/ezlog/sidekiq/job_logger.rb
 - lib/ezlog/version.rb
 homepage: https://github.com/emartech/ezlog