lorekeeper 1.11.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bfcc3f33a2a846246a7e85d8c8c2730d1099bb0c41b80b86998ffd6beb5736a4
-  data.tar.gz: 2e7b7f4a5e80c372ca5b17b4f961efa80bbd17e67713a075064c63659767bc2f
+  metadata.gz: b8a5d046cc9e67c4efda44b74aa45acd384a49d58b1ea710799ff072de7b0316
+  data.tar.gz: c095a976184d6456d2605fdebc25ed20e31b992672e066b892b08be201fe70c8
 SHA512:
-  metadata.gz: fc4fa20700854b22f850129142a801ac56131e0f46e6f7ad74e69356821505715514c3b32041c58eaf3affa4dfe0ec951244e5e63222c26a08b115d9ecf8ea3f
-  data.tar.gz: 8de40794309ff297adee1865243dbc856a6b6f687cef620af6807b5a582e2011b00ab822a948e870368b01bcce9ac0c3071eba9d7b95ce8a75c8451468cc4dfa
+  metadata.gz: 76c142c27abbae12ec4e5bde2262ea79f962f0e5aa9ac6074c04fdf7b84cdc3d5c62cdfdaae45874589d53300de2ddc961657562d9abffbbec8501575ae9f2d6
+  data.tar.gz: 3e86217440ba8269f05c1a1ec44bc4262067a9608ee7caab4a35cfc222a8870a2e7bfbb51dd275ea42ee7169cc033d79ee692dd469f5e16b9a21ae04af348803

data/.github/workflows/build.yml

@@ -0,0 +1,29 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: build
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.5', '2.6', '2.7', '3.0', '3.1']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rspec
+    - name: Run benchmark
+      run: bundle exec rake benchmark

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+# 2.1.0
+* Modify SimpleLogger to properly log exceptions with named parameters
+
+# 2.0.0
+* Set `mode: :compat` in Oj.dump to stringify keys
+* Support Ruby 3.1
+* Drop support for Ruby < 2.5.0
+
+# 1.12.0
+* Remove ZipkinTracer information from stacktrace output
+* Move CI to GitHub Actions
+
 # 1.11.1
 * Modify FastLogger#add to log progname as a message if no message and block are given
 

data/README.md

@@ -1,6 +1,6 @@
 # Lorekeeper
 
-[![Build Status](https://travis-ci.org/JordiPolo/lorekeeper.svg?branch=master)](https://travis-ci.org/JordiPolo/lorekeeper)
+[![build](https://github.com/JordiPolo/lorekeeper/actions/workflows/build.yml/badge.svg)](https://github.com/JordiPolo/lorekeeper/actions/workflows/build.yml)
 
 LoreKeeper contains a highly optimized JSON logger. It outputs messages as JSON and let the users to add their own customized fields.
 When used without extra fields it outputs 20% faster than the standard Logger for messages not longer than one line of text.
@@ -141,7 +141,7 @@ Will output:
 }
 ```
 
-This method also accepts a custom message, data and log level.
+This method also accepts a custom message, data and log level:
 
 ```ruby
 rescue => e
@@ -169,16 +169,30 @@ Will output:
 }
 ```
 
-Alternatively you can use named parameters:
+Please note that due to the way Ruby 2.x automatically converts Hash objects to keyword arguments when they come last,
+you need to explicitly use the `data` keyword argument when you don't pass any other argument afterwards:
 
 
+```ruby
+logger.exception(e, "custom msg!", { some: { data: 123 } })
+# => ArgumentError: unknown keyword: some
+
+logger.exception(e, "custom msg!", data: { some: { data: 123 } })
+# => works
+```
+
+Ruby 3.x is unaffected by this issue since the conversion is [not done automatically anymore](https://www.ruby-lang.org/en/news/2019/12/12/separation-of-positional-and-keyword-arguments-in-ruby-3-0/).
+
+
+The available keyword arguments are `message`, `data` and `level`. They can be used instead of the fixed arguments:
+
 ```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:
+This is especially useful when there is no custom message or data:
 
 ```ruby
 rescue => e

data/lib/lorekeeper/json_logger.rb

@@ -98,7 +98,7 @@ module Lorekeeper
 
     # 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.
+    # Hardcording newrelic, active_support/callbacks and zipkin-tracer now here.
     # In the future if this list grows, we may make it configurable.
     def clean_backtrace(backtrace)
       @backtrace_cleaner&.clean(backtrace) || backtrace
@@ -121,7 +121,7 @@ module Lorekeeper
     EXCEPTION = 'exception'
     STACK = 'stack'
     DATA = 'data'
-    BLACKLISTED_FINGERPRINT = %r{newrelic_rpm|active_support/callbacks.rb}.freeze
+    BLACKLISTED_FINGERPRINT = %r{newrelic_rpm|active_support/callbacks.rb|zipkin-tracer}.freeze
 
     def with_extra_fields(fields)
       state[:extra_fields] = fields
@@ -148,7 +148,7 @@ module Lorekeeper
       fields_to_log[TIMESTAMP] = Time.now.utc.strftime(DATE_FORMAT)
       fields_to_log[LEVEL] = SEVERITY_NAMES_MAP[severity]
 
-      @iodevice.write(Oj.dump(fields_to_log) << "\n")
+      @iodevice.write(Oj.dump(fields_to_log, mode: :compat, cache_keys: true, cache_str: 5) << "\n")
     end
   end
 end

data/lib/lorekeeper/simple_logger.rb

@@ -28,7 +28,7 @@ module Lorekeeper
     # \e[colorm sets a color \e[0m resets all properties
     def log_data(severity, message)
       color = SEVERITY_TO_COLOR_MAP[severity]
-      @iodevice.write("\e[#{color}m#{message}\e[0m\n")
+      @iodevice.write("\e[#{color}m#{message.gsub('\n', "\n").gsub('\t', "\t")}\e[0m\n")
     end
 
     def inspect
@@ -43,16 +43,31 @@ module Lorekeeper
       end
     end
 
-    def exception(exception, custom_message = nil, custom_data = nil, level = :error)
-      log_level = METHOD_SEVERITY_MAP[level] || ERROR
+    # To not raise NoMethodError for the methods defined in JSONLogger
+    def current_fields(*); end
+    def state(*); end
+    def add_thread_unsafe_fields(*); end
+    def remove_thread_unsafe_fields(*); end
+    def add_fields(*); end
+    def remove_fields(*); end
+
+    def exception(exception, custom_message = nil, custom_data = nil, custom_level = :error,
+                             message: nil, data: nil, level: nil)
+
+      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 || []
-        message = custom_message || exception.message
-        log_data(log_level, "#{exception.class}: #{exception.message}; #{message}, data: #{backtrace.join("\n")}")
+        message = param_message || exception.message
+        backtrace = "\n\nstack:\n#{exception.backtrace.join("\n")}" if exception.backtrace
+        data = "\n\ndata:\n#{param_data}" if param_data
+        log_data(log_level, "#{exception.class}: #{exception.message}; #{message} #{backtrace} #{data}")
       else
         log_data(METHOD_SEVERITY_MAP[:warn], 'Logger exception called without exception class.')
-        error_with_data("#{exception.class}: #{exception.inspect} #{custom_message}", custom_data)
+        error_with_data("#{exception.class}: #{exception.inspect} #{param_message}", param_data)
       end
     end
   end

data/lib/lorekeeper/version.rb

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

data/lorekeeper.gemspec

@@ -20,9 +20,9 @@ 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.4.0'
+  spec.required_ruby_version = '>= 2.5.0'
 
-  spec.add_dependency 'oj', '>= 3.4', '< 4.0'
+  spec.add_dependency 'oj', '>= 3.12', '< 4.0'
 
   spec.add_development_dependency 'activesupport', '>= 4.0'
   spec.add_development_dependency 'bundler', '>= 1.16', '< 3.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lorekeeper
 version: !ruby/object:Gem::Version
-  version: 1.11.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Jordi Polo
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-06-29 00:00:00.000000000 Z
+date: 2022-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.12'
     - - "<"
       - !ruby/object:Gem::Version
         version: '4.0'
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.12'
     - - "<"
       - !ruby/object:Gem::Version
         version: '4.0'
@@ -183,10 +183,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/build.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -213,7 +213,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/.travis.yml

@@ -1,11 +0,0 @@
-language: ruby
-cache: bundler
-
-rvm:
-  - 2.4.9
-  - 2.5.8
-  - 2.6.6
-  - 2.7.2
-  - 3.0.0
-
-script: bundle exec rspec