lorekeeper 1.7.1 → 1.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: eacd166a17c5e6f4ad24a5f03fe872a25290dd5e
-  data.tar.gz: 9c85bd94a282067e28010081ff0e79e0963fc830
+SHA256:
+  metadata.gz: de74418ad428e6556541729fb0e7a4a87d8f9da9eb2274d6a7837cdc89066f6b
+  data.tar.gz: f0a7097544c0e29cf894b1c608a9c2048f09f8c6aac16a976f24968c693af1ae
 SHA512:
-  metadata.gz: 2e1c6718980ffaf6736fcee85a5d01dabed7df31b3af84c39efede9b69cc994ab602c010ca1f34e9301daa66f9eddce2ee773849c6d82234a5a15c8cd07be58b
-  data.tar.gz: 2dae7e8356d9d03280c08a16ac90827dda1ae25945c94854fa8f6da9c57a2602297a08815672801b9936738fdd0b2dd9a83bf420e715dd1e4a8412e7a1da4dc3
+  metadata.gz: 81ff827913aff25a84222514e0b7feaca8cca96edd92d86c2b29e477d9f243c60cf377fb4d6a90647ddfec60783d3b26c9bb3a751c400d9ae5a445d72f314305
+  data.tar.gz: 178f3cb38c3d70fb063e7a0ef0149ce8dca7fc22b610d5f0dc0fd9e065aa87db0301a5d2e0018da04f20829ff00c0a380a2f80dd743171eeff35bd06df6161db

data/.travis.yml

@@ -2,11 +2,8 @@ language: ruby
 cache: bundler
 
 rvm:
-  - 2.1.10
-  - 2.2.10
-  - 2.3.8
-  - 2.4.5
-  - 2.5.3
-  - 2.6.0-rc1
+  - 2.4.9
+  - 2.5.7
+  - 2.6.5
 
 script: bundle exec rspec

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+# 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
+
 # 1.7.1
 * Ensure `data` is not nil when logging wrong #exception usage
 

data/Gemfile

@@ -1,8 +1,4 @@
 source 'https://rubygems.org'
 
-group :development do
-  gem 'mutant-rspec', '~> 0.8'
-end
-
 # Specify your gem's dependencies in lorekeeper.gemspec
 gemspec

data/README.md

@@ -141,6 +141,52 @@ Will output:
 }
 ```
 
+This method also accepts a custom message, data and log level.
+
+```ruby
+rescue => e
+  logger.exception(e, "custom msg!", { some: { data: 123 } }, :warn)
+end
+```
+
+Will output:
+
+```javascript
+{
+  "message": "custom msg!",
+  "timestamp": "1970-01-01T00:00:00.000+0100",
+  "level": "warning",
+  "data": {
+    ":some": {
+      ":data": 123
+    }
+  },
+  "exception": "<exception name>",
+  "stack": [
+    "<stacktraceline1>",
+    "<stacktraceline2>"
+  ]
+}
+```
+
+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

@@ -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/multi_logger.rb

@@ -16,9 +16,15 @@ module Lorekeeper
       "Lorekeeper multilogger, loggers: #{@loggers.map(&:inspect)}"
     end
 
+if RUBY_VERSION > "2.6"
+    def respond_to?(method, all_included = false)
+      @loggers.all? { |logger| logger.respond_to?(method, all_included) }
+    end
+else
     def respond_to?(method)
       @loggers.all? { |logger| logger.respond_to?(method) }
     end
+end
 
     def method_missing(method, *args, &block)
       result = @loggers.map do |logger|

data/lib/lorekeeper/version.rb

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

data/lorekeeper.gemspec

@@ -20,16 +20,18 @@ 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.1.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.4'
+  spec.add_development_dependency 'rspec', '~> 3.8'
   spec.add_development_dependency 'benchmark-ips', '~> 2.3'
   spec.add_development_dependency 'timecop', '~> 0.8'
-  spec.add_development_dependency 'byebug', '~> 8.0'
+  spec.add_development_dependency 'byebug', '~> 11.0'
   spec.add_development_dependency 'rbtrace', '~> 0.4'
   spec.add_development_dependency 'simplecov', '~> 0.16'
+  spec.add_development_dependency 'mutant-rspec', '~> 0.8'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lorekeeper
 version: !ruby/object:Gem::Version
-  version: 1.7.1
+  version: 1.11.0
 platform: ruby
 authors:
 - Jordi Polo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-12 00:00:00.000000000 Z
+date: 2021-03-16 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
@@ -70,14 +84,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.8'
 - !ruby/object:Gem::Dependency
   name: benchmark-ips
   requirement: !ruby/object:Gem::Requirement
@@ -112,14 +126,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '11.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '11.0'
 - !ruby/object:Gem::Dependency
   name: rbtrace
   requirement: !ruby/object:Gem::Requirement
@@ -148,6 +162,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: mutant-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
 description: Opinionated logger which outputs messages in JSON format
 email:
 - mumismo@gmail.com
@@ -185,15 +213,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Very fast JSON logger