lorekeeper 1.9.0 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 20607700d6213a2dbeaa828a691db22d62c8faf4
-  data.tar.gz: ea7a417e437eec8f98699cba4c9a8c56db56facd
+SHA256:
+  metadata.gz: db3ae6a493b8fc903122557d5144db57633e3c72a881cb4bc88ad458d438f7dc
+  data.tar.gz: 69ba8f5fd5ea48d6325f27ae777c91e857e28c5f7e6093cef71aa427cfcb8266
 SHA512:
-  metadata.gz: cda5c319cb5f3baa40c949e07fc4f25ac34acbb349af2c1b08a336e192f55da0faecd9b1a4c19cf24d1a5361141a5731c8670835dfe935432c27f41d052fe300
-  data.tar.gz: 2751f693aa13f17d287e189c1425c4ef2ed4879ba3b2074aea74e18e11c2391f4118ec59c7bc2e61a67fb0152fa312ff394081c1fc0cf49c55d6cddf28010fad
+  metadata.gz: 5b3b703f5182598b73f0c86411b9a627060eed1e0c59ddd1b9507dd3e9f28b5c3239e2e48a59bdf42edc017fa5df1acb4ba8aee5f502f73f21ff6fcc1876c8b4
+  data.tar.gz: 8925f11071fbccff8ddca89066a473b9286c8aedd87f9b76c3f872388e83ead883f2b78fe3645e71753009535f9e7b2e09e0e3921b4f64883a86f49c3737da72

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']
+
+    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,16 @@
+# 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
+
+# 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
 

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/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
 
@@ -97,11 +98,19 @@ module Lorekeeper
 
     # Some instrumentation libraries pollute the stacktrace and create a large output which may
     # cause problems with certain logging backends.
-    # Hardcoring newrelic now here. In the future if this list grows, we may make it configurable.
+    # 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.reject do |line|
-        line.include?(BLACKLISTED_FINGERPRINT)
-      end
+      @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
@@ -112,7 +121,7 @@ module Lorekeeper
     EXCEPTION = 'exception'
     STACK = 'stack'
     DATA = 'data'
-    BLACKLISTED_FINGERPRINT = '/newrelic_rpm-'
+    BLACKLISTED_FINGERPRINT = %r{newrelic_rpm|active_support/callbacks.rb|zipkin-tracer}.freeze
 
     def with_extra_fields(fields)
       state[:extra_fields] = fields

data/lib/lorekeeper/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Lorekeeper
-  VERSION = '1.9.0'
+  VERSION = '1.12.0'
 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.9.0
+  version: 1.12.0
 platform: ruby
 authors:
 - Jordi Polo
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-07-07 00:00:00.000000000 Z
+date: 2021-10-28 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
@@ -169,10 +183,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/build.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -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,16 +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: []
-rubyforge_project: 
-rubygems_version: 2.6.14
-signing_key: 
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 4
 summary: Very fast JSON logger
 test_files: []

data/.travis.yml

@@ -1,15 +0,0 @@
-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
-
-script: bundle exec rspec