ezlog 0.9.1 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 887b24709271ea85b1b00a7de9d88ed253e7494e6b96d555afbabf7c88b84f02
-  data.tar.gz: a9dd5994ed7e8a5562df8c17ecbe1ac1e790d5f90408cce82083f3ebf1e79be7
+  metadata.gz: c4270c3e08d7eed8814bb532011ba89f38e9d01f1c5989d4cf897f1bf346211a
+  data.tar.gz: b29b7da890c056a8fb7e366be8a501ed1aa65d739659de748def920d8befbf8e
 SHA512:
-  metadata.gz: a5d03acb158fb0be072d425b107a67d397af02f3b6ffe54aac3d688b65d5ae65f15498c3b49208ff8f5414021a084099442aa947c06e96ba663ec740e05b971e
-  data.tar.gz: 591cb4c0f959c5fefc2eb5a54d3550a5c99d74eb5317565d6c8dbf1707edfbaa8319cc8bc7e699613fd55a96b3ee5aff19d148469830b720469e7fdeb251ed35
+  metadata.gz: 67c97458aa1e2227496538bbede305710204b19d59ceb76cffe10d41a275ee2772ee7b73f8c2d0fafab4c3ef73d1ec827ad3ce4eef788576f435e4f3e8acf259
+  data.tar.gz: 2fcafa0d0ade63c68aff07fd10d3a92a72c7cde0e19509c62669f30bec46937b842d7ea9c05beaac263d6f2eebbb6db64e94c1cfff3821c9244eed70e52540f3

data/CHANGELOG.md

@@ -1,3 +1,69 @@
+### 0.10.1 (2022-01-22)
+
+[Full Changelog](https://github.com/emartech/ezlog/compare/v0.10.0...v0.10.1)
+
+* Fix
+  * Fixed a bug where `ActionView::LogSubscriber` was potentially not (eager)loaded by the time we tried to detach it.
+    With this fix Rails 6.1 running on Ruby 3 should be fully supported.
+
+### 0.10.0 (2021-07-01)
+
+[Full Changelog](https://github.com/emartech/ezlog/compare/v0.9.6...v0.10.0)
+
+* Features & enhancements
+  * Do not log exceptions which are handled by Rails. Therefore you can't get false alarms from your exception notifier
+
+### 0.9.6 (2021-06-30)
+
+[Full Changelog](https://github.com/emartech/ezlog/compare/v0.9.5...v0.9.6)
+
+* Fix
+  * fixing a Rails 6.1 specific issue with ActiveRecord array parameter in a query (`User.where(id: [1,2,3,4])`)
+
+### 0.9.5 (2020-10-01)
+
+[Full Changelog](https://github.com/emartech/ezlog/compare/v0.9.4...v0.9.5)
+
+* Fix
+  * fixing an issue with the Sidekiq job's log context generation:
+    using a namespaced Sidekiq worker (`SomeModule::SomeWorker`) cause the log context generations to fail with: `NameError: wrong constant name SomeModule::SomeWorker`
+
+### 0.9.4 (2020-09-26)
+
+[Full Changelog](https://github.com/emartech/ezlog/compare/v0.9.3...v0.9.4)
+
+* Features & enhancements
+  * added Ruby 2.7 to the list of version CI will test the code with
+  * remove dot-files and Rakefile from the gem
+* Fix
+  * stop using `Hash#merge` with multiple arguments as it's only supported from Ruby 2.6
+
+### 0.9.3 (2020-09-20)
+
+[Full Changelog](https://github.com/emartech/ezlog/compare/v0.9.2...v0.9.3)
+
+* Features & enhancements 
+    * Switching to [Oj](https://github.com/ohler55/oj) for fast JSON serialization
+    * Allow level to be formatted (so it can be logged as a number too)
+    
+        if you want to use Ougai-like numbers you can do something like this: 
+        ```ruby
+        config.ezlog.layout_options = { level_formatter: ->(level_number) { (level_number + 2) * 10 } } 
+        
+        Rails.logger.error('Boom!')
+        #=> {"logger":"Application","timestamp":"2020-09-20T19:29:03+02:00","level":50,"hostname":"BUD010256.local","pid":19872,"message":"Boom!"}
+        ``` 
+    * initial context (a context which will be added to every single line of log) can be configured via `config.ezlog.layout_options` and it defaults to `{environment: ::Rails.env}`
+    
+### 0.9.2 (2020-09-19)
+
+[Full Changelog](https://github.com/emartech/ezlog/compare/v0.9.1...v0.9.2)
+
+* Features & enhancements 
+  * Improvements of the [Sidekiq](https://github.com/mperham/sidekiq) integration
+    * supports additional job information: batch id, tags and thread id (bid, tags, tid)
+    * support logging "death" events (setting up a death_handler) 
+
 ### 0.9.1 (2020-05-10)
 
 [Full Changelog](https://github.com/emartech/ezlog/compare/v0.9.0...v0.9.1)

data/README.md

@@ -93,6 +93,7 @@ In addition to this, Ezlog also does the following:
 * It disables Rails's default logging of uncaught errors and injects its own error logger into the application, which
   * logs 1 line per error, including the error's name and context (stack trace, etc.),
   * logs every error at ERROR level instead of the default FATAL.
+  * does not log exceptions which are handled by Rails (`ActionDispatch::ExceptionWrapper.rescue_responses`)
 * It disables Rails's default request logging, which logs several lines per event during the processing of an action,
   and replaces the default Rack access log with its own access log middleware. The end result is an access log that
   * contains all relevant information (request ID, method, path, params, client IP, duration and response status code), and

data/ezlog.gemspec

@@ -16,13 +16,14 @@ Gem::Specification.new do |spec|
   }
 
   spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^((test|spec|features)/|Rakefile|\.)}) }
   end
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
   spec.add_dependency "logging", "~> 2.0"
+  spec.add_dependency "oj", "~> 3.0"
 
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", ">= 12.3.3"

data/lib/ezlog/logging_layout.rb

@@ -1,10 +1,11 @@
 require 'time'
-require 'json'
+require 'oj'
 
 module Ezlog
   class LoggingLayout < ::Logging::Layout
-    def initialize(context = {})
+    def initialize(context = {}, options = {})
       @initial_context = context
+      @level_formatter = options.fetch(:level_formatter, ->(numeric_level) { ::Logging::LNAMES[numeric_level] })
     end
 
     def format(event)
@@ -12,7 +13,7 @@ module Ezlog
       add_initial_context_to log_entry
       add_logging_context_to log_entry
       add_event_information_to log_entry, event
-      ::JSON.dump(log_entry) + "\n"
+      ::Oj.dump(log_entry, mode: :json) + "\n"
     end
 
     private
@@ -20,8 +21,8 @@ module Ezlog
     def basic_information_for(event)
       {
         'logger' => event.logger,
-        'timestamp' => event.time.iso8601,
-        'level' => ::Logging::LNAMES[event.level],
+        'timestamp' => event.time.iso8601(3),
+        'level' => @level_formatter.call(event.level),
         'hostname' => Socket.gethostname,
         'pid' => Process.pid
       }
@@ -46,17 +47,17 @@ module Ezlog
       when Hash
         obj
       else
-        {message: obj}
+        { 'message' => obj }
       end
     end
 
     def exception_message_by(exception)
       {
-        message: exception.message,
-        error: {
-          class: exception.class.name,
-          message: exception.message,
-          backtrace: exception.backtrace&.first(20)
+        'message' => exception.message,
+        'error' => {
+          'class' => exception.class.name,
+          'message' => exception.message,
+          'backtrace' => exception.backtrace&.first(20)
         }
       }
     end

data/lib/ezlog/rails/active_record/log_subscriber.rb

@@ -33,6 +33,8 @@ module Ezlog
           end
 
           Hash[param_value_pairs]
+        rescue NoMethodError
+          params
         end
 
         def type_casted_values_from(event)

data/lib/ezlog/rails/log_exceptions.rb

@@ -9,9 +9,15 @@ module Ezlog
       def call(env)
         @app.call(env)
       rescue Exception => exception
-        @logger.error exception
+        @logger.error exception unless handled?(exception)
         raise
       end
+
+      private
+
+      def handled?(exception)
+        ActionDispatch::ExceptionWrapper.rescue_responses.key? exception.class.name
+      end
     end
   end
 end

data/lib/ezlog/railtie.rb

@@ -5,13 +5,17 @@ module Ezlog
     config.ezlog.log_only_whitelisted_params = false
     config.ezlog.whitelisted_params = [:controller, :action]
     config.ezlog.exclude_paths = []
+    config.ezlog.initial_context = { environment: ::Rails.env }
+    config.ezlog.layout_options = {}
 
     initializer "ezlog.initialize" do
       require "ezlog/rails/extensions"
     end
 
     initializer 'ezlog.configure_logging' do |app|
-      ::Logging.logger.root.appenders = ::Logging.appenders.stdout 'stdout', layout: Ezlog::LoggingLayout.new(environment: ::Rails.env)
+      ::Logging.logger.root.appenders =
+        ::Logging.appenders.stdout 'stdout', layout: Ezlog::LoggingLayout.new(app.config.ezlog.initial_context,
+                                                                              app.config.ezlog.layout_options)
       ::Logging.logger.root.level = app.config.log_level
     end
 
@@ -38,7 +42,10 @@ module Ezlog
       case ::Rails::VERSION::MAJOR
       when 6
         ::ActionController::LogSubscriber.detach_from :action_controller
-        ::ActionView::LogSubscriber.detach_from :action_view
+        if defined? ::ActionView
+          require 'action_view/log_subscriber' unless defined? ::ActionView::LogSubscriber
+          ::ActionView::LogSubscriber.detach_from :action_view
+        end
         if defined? ::ActiveRecord
           ::ActiveRecord::LogSubscriber.detach_from :active_record
           Ezlog::Rails::LogSubscriber.attach Ezlog::Rails::ActiveRecord::LogSubscriber, :active_record
@@ -67,6 +74,7 @@ module Ezlog
         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 }
+        config.death_handlers << Ezlog::Sidekiq::DeathLogger.new
       end
     end
 

data/lib/ezlog/rspec/matchers.rb

@@ -55,3 +55,5 @@ RSpec::Matchers.define :log do
     log_output_is_expected.to include_log_message(expected).at_level(log_level)
   end
 end
+
+RSpec::Matchers.define_negated_matcher :not_log, :log

data/lib/ezlog/sidekiq/death_logger.rb

@@ -0,0 +1,15 @@
+require 'sidekiq'
+
+module Ezlog
+  module Sidekiq
+    class DeathLogger
+      include LogContextHelper
+
+      def call(job, error)
+        within_log_context(JobContext.from_job_hash(job)) do
+          ::Sidekiq.logger.error error
+        end
+      end
+    end
+  end
+end

data/lib/ezlog/sidekiq/job_context.rb

@@ -4,13 +4,18 @@ module Ezlog
       class << self
         def from_job_hash(job_hash)
           return {} if job_hash.nil?
-          basic_info_from(job_hash).merge named_arguments_from(job_hash)
+          thread_info.merge(basic_info_from(job_hash)).merge(named_arguments_from(job_hash))
         end
 
         private
 
+        def thread_info
+          { tid: Thread.current['sidekiq_tid'] || (Thread.current.object_id ^ ::Process.pid).to_s(36) }
+        end
+
+
         def basic_info_from(job)
-          {
+          h = {
             jid: job['jid'],
             queue: job['queue'],
             worker: job_class(job),
@@ -18,6 +23,9 @@ module Ezlog
             enqueued_at: job['enqueued_at'],
             run_count: (job['retry_count'] || -1) + 2
           }
+          h[:bid] = job['bid'] if job['bid']
+          h[:tags] = job['tags'] if job['tags']
+          h
         end
 
         def named_arguments_from(job)
@@ -29,7 +37,7 @@ module Ezlog
         end
 
         def method_parameters_of(job)
-          Kernel.const_get(job_class(job).to_sym).instance_method(:perform).parameters
+          Kernel.const_get(job_class(job)).instance_method(:perform).parameters
         end
 
         def job_class(job)

data/lib/ezlog/sidekiq.rb

@@ -1,5 +1,6 @@
 module Ezlog
   module Sidekiq
+    autoload :DeathLogger, 'ezlog/sidekiq/death_logger'
     autoload :ErrorLogger, 'ezlog/sidekiq/error_logger'
     autoload :JobContext, 'ezlog/sidekiq/job_context'
     autoload :JobLogger, 'ezlog/sidekiq/job_logger'

data/lib/ezlog/version.rb

@@ -1,3 +1,3 @@
 module Ezlog
-  VERSION = '0.9.1'
+  VERSION = '0.10.1'
 end

data/repo-info.json

@@ -0,0 +1,7 @@
+{
+  "is_in_production": true,
+  "is_scannable": true,
+  "is_critical": false,
+  "contact": "g-gsuite-smartinsight@emarsys.com",
+  "hosted": null
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ezlog
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.10.1
 platform: ruby
 authors:
 - Zoltan Ormandi
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-05-10 00:00:00.000000000 Z
+date: 2022-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logging
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -122,21 +136,17 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
-description: 
+description:
 email:
 - zoltan.ormandi@emarsys.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
 - bin/console
 - bin/setup
 - ezlog.gemspec
@@ -156,17 +166,19 @@ files:
 - lib/ezlog/rspec/helpers.rb
 - lib/ezlog/rspec/matchers.rb
 - lib/ezlog/sidekiq.rb
+- lib/ezlog/sidekiq/death_logger.rb
 - lib/ezlog/sidekiq/error_logger.rb
 - lib/ezlog/sidekiq/job_context.rb
 - lib/ezlog/sidekiq/job_logger.rb
 - lib/ezlog/version.rb
 - lib/sequel/extensions/ezlog_logging.rb
+- repo-info.json
 homepage: https://github.com/emartech/ezlog
 licenses:
 - MIT
 metadata:
   changelog_uri: https://github.com/emartech/ezlog/blob/master/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -181,8 +193,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: A zero-configuration logging solution for projects using Sidekiq, Rails,
   Sequel, etc.

data/.gitignore

@@ -1,13 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-.rspec_status
-.ruby-version
-Gemfile.lock

data/.rspec

@@ -1,3 +0,0 @@
---format progress
---color
---require spec_helper

data/.travis.yml

@@ -1,9 +0,0 @@
----
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.4.6
-  - 2.5.5
-  - 2.6.3
-before_install: gem install bundler -v 2.0.1

data/Rakefile

@@ -1,6 +0,0 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec