lorekeeper 1.7.2 → 1.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8b0a7ef791f5abaf9fc2452ac135e9c5ec37510b879b19a02039cb3d1096342
-  data.tar.gz: 418c008350fd3f1a221291266b3ab39e59d8333f796148bffba16f717399c066
+  metadata.gz: bfcc3f33a2a846246a7e85d8c8c2730d1099bb0c41b80b86998ffd6beb5736a4
+  data.tar.gz: 2e7b7f4a5e80c372ca5b17b4f961efa80bbd17e67713a075064c63659767bc2f
 SHA512:
-  metadata.gz: fb7b5c1889b2e133bfe6f6a55be4424bcdfbe26718f2096889b1409d09609678ad57fc50fa2363fa17b7e59f79342422e1ac2ff3c22fd7572fec14fa09da5692
-  data.tar.gz: 6933ce6d182c41fd7fd23950df831bc3e9f93c3d72c31198dd93906882f50a24395919b5cb2ba1a65587c0a5adc240b397872a27e25e2a7e251324661669e795
+  metadata.gz: fc4fa20700854b22f850129142a801ac56131e0f46e6f7ad74e69356821505715514c3b32041c58eaf3affa4dfe0ec951244e5e63222c26a08b115d9ecf8ea3f
+  data.tar.gz: 8de40794309ff297adee1865243dbc856a6b6f687cef620af6807b5a582e2011b00ab822a948e870368b01bcce9ac0c3071eba9d7b95ce8a75c8451468cc4dfa

data/.travis.yml

@@ -2,14 +2,10 @@ language: ruby
 cache: bundler
 
 rvm:
-  - 2.3.8
-  - 2.4.6
-  - 2.5.5
-  - 2.6.3
-
-before_install:
-  - gem install rubygems-update -v 2.7.8
-  - gem install bundler -v 1.17.3
-  - bundle --version
+  - 2.4.9
+  - 2.5.8
+  - 2.6.6
+  - 2.7.2
+  - 3.0.0
 
 script: bundle exec rspec

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+# 1.11.1
+* Modify FastLogger#add to log progname as a message if no message and block are given
+
+# 1.11.0
+* Support for activerecord-session_store v2 which calls only silence and not silence_logger
+
+# 1.10.0
+* Use ActiveSupport::BacktraceCleaner to reduce noise in stacktrace output
+
+# 1.9.0
+* Remove Newrelic instrumentation information from stacktrace output
+
+# 1.8.0
+* Allow to use named parameters in the .exception method
+
 # 1.7.2
 * Add a second parameter to respond_to? to avoid Ruby 2.6 warnings
 * Drop support for unsupported Ruby 2.1 and Ruby 2.2

data/README.md

@@ -169,6 +169,24 @@ Will output:
 }
 ```
 
+Alternatively you can use named parameters:
+
+
+```ruby
+rescue => e
+  logger.exception(e, message: "custom msg!", data: { some: { data: 123 } }, level: :warn)
+end
+```
+
+This is specially useful when there is no custom message or data:
+
+```ruby
+rescue => e
+  logger.exception(e, level: :warn)
+end
+```
+
+
 
 ## License
 

data/Rakefile

@@ -50,10 +50,10 @@ task :benchmark do
   simple_log = create_simple_logger
 
   Benchmark.ips do |bm|
-    bm.report('short content') { log.error(contents) }
-    bm.report('Logger short content') { simple_log.info(contents) }
-    bm.report('long content') { log.info(long_contents) }
-    bm.report('Logger long content') { simple_log.info(long_contents) }
+    bm.report('JSON short content') { log.debug(contents) }
+    bm.report('Logger short content') { simple_log.debug(contents) }
+    bm.report('JSON long content') { log.debug(long_contents) }
+    bm.report('Logger long content') { simple_log.debug(long_contents) }
     bm.compare!
   end
 

data/lib/lorekeeper/fast_logger.rb

@@ -54,9 +54,9 @@ module Lorekeeper
     end
 
     # This is part of the standard Logger API, we need this to be compatible
-    def add(severity, message_param = nil, _ = nil, &block)
+    def add(severity, message_param = nil, progname = nil, &block)
       return true if severity < @level
-      message = message_param || (block && block.call)
+      message = message_param || (block && block.call) || progname
       log_data(severity, message.freeze)
     end
 
@@ -68,6 +68,11 @@ module Lorekeeper
       yield if block_given?
     end
 
+    # activerecord-session_store v2 is now simply calling silence instead of silence_logger
+    def silence(&block)
+      yield if block_given?
+    end
+
     # inherited classes probably want to reimplement this
     def log_data(_severity, message)
       @iodevice.write(message)

data/lib/lorekeeper/json_logger.rb

@@ -9,6 +9,7 @@ module Lorekeeper
     def initialize(file)
       reset_state
       @base_fields = { MESSAGE => '', TIMESTAMP => '', LEVEL => '' }
+      @backtrace_cleaner = set_backtrace_cleaner
       super(file)
     end
 
@@ -29,7 +30,7 @@ module Lorekeeper
     LOGGING_METHODS.each do |method_name|
       define_method "#{method_name}_with_data", ->(message_param = nil, data = {}, &block) do
         return true if METHOD_SEVERITY_MAP[method_name] < @level
-        extra_fields = { 'data' => (data || {}) }
+        extra_fields = { DATA => (data || {}) }
         with_extra_fields(extra_fields) { # Using do/end here only valid on Ruby>= 2.3
           add(METHOD_SEVERITY_MAP[method_name], message_param, nil, &block)
         }
@@ -61,25 +62,31 @@ module Lorekeeper
     end
 
     # @param exception: instance of a class inheriting from Exception
-    # We will output backtrace twice. Once inside the stack so it can be parsed by software
-    # And the other inside the message so it is readable to humans
-    def exception(exception, custom_message = nil, custom_data = nil, level = :error)
-      log_level = METHOD_SEVERITY_MAP[level] || ERROR
+    # By default message comes from exception.message
+    # Optional and named parameters to overwrite message, level and add data
+    def exception(exception, custom_message = nil, custom_data = nil, custom_level = :error,
+                             message: nil, data: nil, level: nil) # Backwards compatible named params
+
+      param_level = level || custom_level
+      param_data = data || custom_data
+      param_message = message || custom_message
+
+      log_level = METHOD_SEVERITY_MAP[param_level] || ERROR
 
       if exception.is_a?(Exception)
-        backtrace = exception.backtrace || []
+        backtrace = clean_backtrace(exception.backtrace || [])
         exception_fields = {
-          'exception' => "#{exception.class}: #{exception.message}",
-          'stack' => backtrace
+          EXCEPTION => "#{exception.class}: #{exception.message}",
+          STACK => backtrace
         }
-        exception_fields['data'] = custom_data if custom_data
+        exception_fields[DATA] = param_data if param_data
 
-        message = custom_message || exception.message
+        message = param_message || exception.message
         with_extra_fields(exception_fields) { log_data(log_level, message) }
       else
         log_data(METHOD_SEVERITY_MAP[:warn], 'Logger exception called without exception class.')
-        message = "#{exception.class}: #{exception.inspect} #{custom_message}"
-        with_extra_fields('data' => (custom_data || {})) { log_data(log_level, message) }
+        message = "#{exception.class}: #{exception.inspect} #{param_message}"
+        with_extra_fields(DATA => (param_data || {})) { log_data(log_level, message) }
       end
     end
 
@@ -89,11 +96,32 @@ module Lorekeeper
 
     private
 
+    # Some instrumentation libraries pollute the stacktrace and create a large output which may
+    # cause problems with certain logging backends.
+    # Hardcording newrelic and active_support/callbacks now here.
+    # In the future if this list grows, we may make it configurable.
+    def clean_backtrace(backtrace)
+      @backtrace_cleaner&.clean(backtrace) || backtrace
+    end
+
+    def set_backtrace_cleaner
+      return nil unless defined?(ActiveSupport::BacktraceCleaner)
+
+      cleaner = ActiveSupport::BacktraceCleaner.new
+      cleaner.remove_silencers!
+      cleaner.add_silencer { |line| line.match?(BLACKLISTED_FINGERPRINT) }
+      cleaner
+    end
+
     THREAD_KEY = 'lorekeeper_jsonlogger_key' # Shared by all threads but unique by thread
     LEVEL = 'level'
     MESSAGE = 'message'
     TIMESTAMP = 'timestamp'
     DATE_FORMAT = '%FT%T.%6NZ'
+    EXCEPTION = 'exception'
+    STACK = 'stack'
+    DATA = 'data'
+    BLACKLISTED_FINGERPRINT = %r{newrelic_rpm|active_support/callbacks.rb}.freeze
 
     def with_extra_fields(fields)
       state[:extra_fields] = fields
@@ -108,11 +136,12 @@ module Lorekeeper
     end
 
     def log_data(severity, message)
+      current_state = state # Accessing state is slow. Do it only once per call.
       # merging is slow, we do not want to merge with empty hash if possible
-      fields_to_log = if state[:extra_fields].empty?
-        state[:base_fields]
+      fields_to_log = if current_state[:extra_fields].empty?
+        current_state[:base_fields]
       else
-        state[:base_fields].merge(state[:extra_fields])
+        current_state[:base_fields].merge(current_state[:extra_fields])
       end
 
       fields_to_log[MESSAGE] = message

data/lib/lorekeeper/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Lorekeeper
-  VERSION = '1.7.2'
+  VERSION = '1.11.1'
 end

data/lorekeeper.gemspec

@@ -20,10 +20,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.3.0'
+  spec.required_ruby_version = '>= 2.4.0'
 
   spec.add_dependency 'oj', '>= 3.4', '< 4.0'
 
+  spec.add_development_dependency 'activesupport', '>= 4.0'
   spec.add_development_dependency 'bundler', '>= 1.16', '< 3.0'
   spec.add_development_dependency 'rake', '~> 12.0'
   spec.add_development_dependency 'rspec', '~> 3.8'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lorekeeper
 version: !ruby/object:Gem::Version
-  version: 1.7.2
+  version: 1.11.1
 platform: ruby
 authors:
 - Jordi Polo
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-04-24 00:00:00.000000000 Z
+date: 2021-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
@@ -30,6 +30,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -191,7 +205,7 @@ homepage: https://github.com/JordiPolo/lorekeeper
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -199,15 +213,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
-signing_key: 
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 4
 summary: Very fast JSON logger
 test_files: []