ezlog 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07eba79fc447346727af12f30a5eb9867740056fed910ba8c6e6f005b8b78597
-  data.tar.gz: '08ddf4b8dcd4a22062bfdd0c5134be05698e1426bbc7fcb8704b49a1b846463c'
+  metadata.gz: af49b0170f9c53fe3f0b41ced3fd1afe3a420402bbb64b62318bda81144d8c23
+  data.tar.gz: 6c85e8f81ee2848bba6ad407aafbf0ce8b567523801cf133ac3fa795fbb6b14c
 SHA512:
-  metadata.gz: 6441fe41467856a284f8ffd4cb534793020b83a749d575da453b37a45a15b4632f82014f853aca89e33af314c1ee02c31254d54242d7e66c52033cf485c1593e
-  data.tar.gz: 91c51f43684577fff83692f58230b9988e530878ddb255a8bbcea43133ceb9a9084fc75b159000d25061407ac5423736f5f3f7903b30f96eaeb7ddc50a442787
+  metadata.gz: a7917365ade7f63164081e865efbcbac0b3f71e26f77abd0a2f32e0c15f2ca4465aabb55db07c64ab20c05ed089525e31319e89ef946e91394a51d73f8dc98da
+  data.tar.gz: 631f9ff0ef37d8fb1250e3713f8322e262d2e5366e1e46fa48da522b296cd3cf8445723fdc42f33ef039ad5ccdc2d32bebfaa1dd53749957b663d7f1206e06fd

data/.travis.yml

@@ -3,5 +3,5 @@ sudo: false
 language: ruby
 cache: bundler
 rvm:
-  - 2.6.1
+  - 2.5.0
 before_install: gem install bundler -v 2.0.1

data/CHANGELOG.md

@@ -0,0 +1,30 @@
+### 0.2.2 (2019-05-19)
+
+[Full Changelog](https://github.com/emartech/ezlog/compare/v0.2.1...v0.2.2)
+
+* Features & enhancements
+  * [Sidekiq](https://github.com/mperham/sidekiq) error handler now logs the same job context as the JobLogger
+
+### 0.2.1 (2019-05-17)
+
+[Full Changelog](https://github.com/emartech/ezlog/compare/v0.2.0...v0.2.1)
+
+* Features & enhancements
+  * Provide logger creation mechanism so that projects don't explicitly depend on [Logging](https://github.com/TwP/logging)
+  * Error handler for [Sidekiq](https://github.com/mperham/sidekiq) which logs the error in a single message (instead of 3 messages)
+  * Add `run_count` to [Sidekiq](https://github.com/mperham/sidekiq) job log messages indicating how many times a job has run
+
+* Bug fixes
+  * Fix bug where exceptions without a backtrace would not get logged
+
+### 0.2.0 (2019-05-12)
+
+First version of the gem including the following:
+
+* Features & enhancements
+  * Use [Logging](https://github.com/TwP/logging) library for all logging
+    * Includes logging layout for JSON logging to STDOUT
+  * JobLogger for [Sidekiq](https://github.com/mperham/sidekiq)
+  * Filter [Rack::Timeout](https://github.com/heroku/rack-timeout) logs to WARN level and above
+  * [RSpec](https://rspec.info/) support
+  * Rails integration via Railtie

data/README.md

@@ -1,5 +1,8 @@
 # Ezlog
 
+[![Gem Version](https://badge.fury.io/rb/ezlog.svg)](https://badge.fury.io/rb/ezlog)
+[![Build Status](https://travis-ci.com/emartech/ezlog.svg?branch=master)](https://travis-ci.com/emartech/ezlog)
+
 Ezlog is intended to be a zero-configuration logging setup for pure Ruby or Rails projects using 
 [Sidekiq](https://github.com/mperham/sidekiq), [Rack::Timeout](https://github.com/heroku/rack-timeout),
 [Sequel](https://sequel.jeremyevans.net/), etc. It uses Tim Pease's wonderful [Logging](https://github.com/TwP/logging)

data/ezlog.gemspec

@@ -7,11 +7,14 @@ Gem::Specification.new do |spec|
   spec.version       = Ezlog::VERSION
   spec.authors       = ["Zoltan Ormandi"]
   spec.email         = ["zoltan.ormandi@emarsys.com"]
-
   spec.summary       = "A zero-configuration logging solution for projects using Sidekiq, Rails, Sequel, etc."
   spec.homepage      = "https://github.com/emartech/ezlog"
   spec.license       = "MIT"
 
+  spec.metadata      = {
+    "changelog_uri" => "https://github.com/emartech/ezlog/blob/master/CHANGELOG.md",
+  }
+
   spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end

data/lib/ezlog.rb

@@ -4,7 +4,9 @@ require 'ezlog/version'
 require 'ezlog/railtie' if defined? Rails
 
 module Ezlog
+  autoload :LogContextHelper, 'ezlog/log_context_helper'
   autoload :LoggingLayout, 'ezlog/logging_layout'
+  autoload :Sidekiq, 'ezlog/sidekiq'
 
   def self.logger(name)
     Logging::Logger[name]

data/lib/ezlog/log_context_helper.rb

@@ -0,0 +1,14 @@
+module Ezlog
+  module LogContextHelper
+    def within_log_context(context)
+      Logging.mdc.push context
+      yield
+    ensure
+      Logging.mdc.pop
+    end
+
+    def add_to_log_context(context)
+      Logging.mdc.update context
+    end
+  end
+end

data/lib/ezlog/railtie.rb

@@ -21,9 +21,6 @@ module Ezlog
     private
 
     def initialize_sidekiq_logging
-      require 'ezlog/sidekiq/job_logger'
-      require 'ezlog/sidekiq/error_logger'
-
       ::Sidekiq.logger = ::Logging.logger['Sidekiq']
       ::Sidekiq.logger.level = :info
       ::Sidekiq.configure_server do |config|

data/lib/ezlog/sidekiq.rb

@@ -0,0 +1,7 @@
+module Ezlog
+  module Sidekiq
+    autoload :ErrorLogger, 'ezlog/sidekiq/error_logger'
+    autoload :JobContext, 'ezlog/sidekiq/job_context'
+    autoload :JobLogger, 'ezlog/sidekiq/job_logger'
+  end
+end

data/lib/ezlog/sidekiq/error_logger.rb

@@ -3,8 +3,12 @@ require 'sidekiq'
 module Ezlog
   module Sidekiq
     class ErrorLogger
-      def call(error, job_hash)
-        ::Sidekiq.logger.warn error
+      include LogContextHelper
+
+      def call(error, context)
+        within_log_context(JobContext.from_job_hash(context[:job])) do
+          ::Sidekiq.logger.warn error
+        end
       end
     end
   end

data/lib/ezlog/sidekiq/job_context.rb

@@ -0,0 +1,36 @@
+module Ezlog
+  module Sidekiq
+    class JobContext
+      class << self
+        def from_job_hash(job_hash)
+          basic_info_from(job_hash).merge named_arguments_from(job_hash)
+        end
+
+        private
+
+        def basic_info_from(job)
+          {
+            jid: job['jid'],
+            queue: job['queue'],
+            worker: job['class'],
+            created_at: job['created_at'],
+            enqueued_at: job['enqueued_at'],
+            run_count: (job['retry_count'] || -1) + 2
+          }
+        end
+
+        def named_arguments_from(job)
+          {}.tap do |arguments|
+            method_parameters_of(job).each_with_index do |(_, param_name), index|
+              arguments[param_name] = job['args'][index]
+            end
+          end
+        end
+
+        def method_parameters_of(job)
+          Kernel.const_get(job['class'].to_sym).instance_method(:perform).parameters
+        end
+      end
+    end
+  end
+end

data/lib/ezlog/sidekiq/job_logger.rb

@@ -3,64 +3,32 @@ require 'sidekiq'
 module Ezlog
   module Sidekiq
     class JobLogger
-      def call(item, queue)
-        within_log_context_of(item) do
-          logger.info "#{item['class']} started"
+      include LogContextHelper
+
+      def call(job_hash, queue)
+        within_log_context(JobContext.from_job_hash(job_hash)) do
+          logger.info "#{job_hash['class']} started"
           benchmark { yield }
-          logger.info message: "#{item['class']} finished"
+          logger.info message: "#{job_hash['class']} finished"
         rescue Exception
-          logger.info message: "#{item['class']} failed"
+          logger.info message: "#{job_hash['class']} failed"
           raise
         end
       end
 
       private
 
-      def within_log_context_of(item)
-        Logging.mdc.push log_context(item)
+      def benchmark
+        start_time = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
         yield
       ensure
-        Logging.mdc.pop
-      end
-
-      def log_context(job)
-        basic_info_for(job).merge arguments_of(job)
-      end
-
-      def basic_info_for(job)
-        {
-          'jid' => job['jid'],
-          'queue' => job['queue'],
-          'worker' => job['class'],
-          'created_at' => job['created_at'],
-          'enqueued_at' => job['enqueued_at'],
-          'run_count' => (job['retry_count'] || -1) + 2
-        }
-      end
-
-      def arguments_of(job)
-        {}.tap do |arguments|
-          method_parameters_of(job).each_with_index do |(_, param_name), index|
-            arguments[param_name] = job['args'][index]
-          end
-        end
-      end
-
-      def method_parameters_of(job)
-        Kernel.const_get(job['class'].to_sym).instance_method(:perform).parameters
+        end_time = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
+        add_to_log_context duration_sec: (end_time - start_time).round(3)
       end
 
       def logger
         ::Sidekiq.logger
       end
-
-      def benchmark
-        start_time = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
-        yield
-      ensure
-        end_time = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
-        Logging.mdc[:duration_sec] = (end_time - start_time).round(3)
-      end
     end
   end
 end

data/lib/ezlog/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ezlog
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Zoltan Ormandi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-17 00:00:00.000000000 Z
+date: 2019-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logging
@@ -104,6 +104,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -112,18 +113,22 @@ files:
 - bin/setup
 - ezlog.gemspec
 - lib/ezlog.rb
+- lib/ezlog/log_context_helper.rb
 - lib/ezlog/logging_layout.rb
 - lib/ezlog/railtie.rb
 - lib/ezlog/rspec.rb
 - lib/ezlog/rspec/helpers.rb
 - lib/ezlog/rspec/matchers.rb
+- lib/ezlog/sidekiq.rb
 - lib/ezlog/sidekiq/error_logger.rb
+- lib/ezlog/sidekiq/job_context.rb
 - lib/ezlog/sidekiq/job_logger.rb
 - lib/ezlog/version.rb
 homepage: https://github.com/emartech/ezlog
 licenses:
 - MIT
-metadata: {}
+metadata:
+  changelog_uri: https://github.com/emartech/ezlog/blob/master/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths: