lorekeeper 2.4.0 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8099634bb3a3f3d4d348737b0c9634a3a70743c1d868ebec42c194865df7a13c
-  data.tar.gz: c216efb9f7f6c2e06c357aee59d1f0ad8299445c5becc0d8fc4f2d444e5193ec
+  metadata.gz: 9b1a026f727609772af1e77fb5423768e621b9db70c7efef8baa1b49cdb9642e
+  data.tar.gz: 7b966039ef152e8ec18256f4c76cda69bc221ec52d9e67fd11013f733a8eb60a
 SHA512:
-  metadata.gz: 93af9f7d3142bdc8166a14e2324b71fe3e51c3f150ea2fccee8557fc2d17b92517b3d6214e8021ed86bdbf632bed836b12027bf438f4bba0099ef1bbaed32e63
-  data.tar.gz: d81128b6905c1f70e7946bf7be63bf35923d40056d9c9ab7274397b7ff8726da582109f83c0c2905768c0c694ac48c2fa8574dd894f10a0b60d6c3b0ac28dfbb
+  metadata.gz: aa4a33eccd5e1494b4c667f2566dfd34c4720a6fece96a8ecdb215d5c77da195c45640fb349979c7e21cc3e2cc2a31eb6c31f75533932a794fda4e915af9bee5
+  data.tar.gz: e204ea9b3158aa7ee5d8315a8b4068555a7913fe6ef36ec24b0fdabf5b4e64dabad9e5518c1193f1383345888332504495d3edd481fa3e097b76d455f599fe1d

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 2.6.0
+* Expose Lorekeeper::BacktraceCleaner
+
+# 2.5.0
+* Update the backtrace cleaner in JSONLogger to remove web server and stdlib lines, and to strip the Rails.root prefix
+
 # 2.4.0
 * Add `#with_level` method support added to the stdlib's Logger in [#85](https://github.com/ruby/logger/issues/85)
 * Support symbol log level setting

data/README.md

@@ -10,7 +10,7 @@ When used without extra fields it outputs 20% faster than the standard Logger fo
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'lorekeeper', '~> 1.7'
+gem 'lorekeeper', '~> 2.0'
 ```
 
 And then execute:
@@ -20,6 +20,15 @@ bundle
 ```
 
 
+## Configuration
+
+Configuration is set through environment variables.
+
+- `LOREKEEPER_DENYLIST`
+  - A comma separated list of keywords/phrases that will be excluded from the clean backtrace.
+  - default: `newrelic_rpm, active_support/callbacks.rb, zipkin-tracer, puma, phusion_passenger, opentelemetry`
+
+
 ## Usage
 
 ### Normal logging methods
@@ -201,6 +210,14 @@ end
 ```
 
 
+### Backtrace Cleaner
+
+The backtrace cleaner can be used independently:
+
+```ruby
+Lorekeeper::BacktraceCleaner.instance.clean(backtrace)
+```
+
 
 ## License
 

data/lib/lorekeeper/backtrace_cleaner.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'singleton'
+
+module Lorekeeper
+  class BacktraceCleaner
+    include Singleton
+
+    def initialize
+      @backtrace_cleaner = set_backtrace_cleaner
+      @rails_root = defined?(Rails.root) ? Rails.root.to_s : nil
+      @rails_root_size = @rails_root.to_s.size
+      @gem_path = defined?(Gem.path) ? Gem.path : []
+      @denylisted_fingerprint = denylisted_fingerprint
+    end
+
+    def clean(backtrace)
+      backtrace = filter_rails_root_backtrace(backtrace)
+      @backtrace_cleaner&.clean(backtrace) || backtrace
+    end
+
+    private
+
+    DENYLISTED_FINGERPRINT =
+      %r{newrelic_rpm|active_support/callbacks.rb|zipkin-tracer|puma|phusion_passenger|opentelemetry}.freeze
+
+    def denylisted_fingerprint
+      return DENYLISTED_FINGERPRINT unless ENV.key?('LOREKEEPER_DENYLIST')
+
+      /#{ENV.fetch('LOREKEEPER_DENYLIST').split(',').map(&:strip).join('|')}/
+    end
+
+    def filter_rails_root_backtrace(backtrace)
+      return backtrace unless @rails_root
+
+      last_index = nil
+      result = []
+      backtrace.each_with_index do |line, idx|
+        if line.start_with?(@rails_root) && @gem_path.none? { |path| line.start_with?(path) }
+          result << line[@rails_root_size..]
+          last_index = idx
+        else
+          result << line
+        end
+      end
+
+      last_index ? result[..last_index] : result
+    end
+
+    def set_backtrace_cleaner
+      return nil unless defined?(ActiveSupport::BacktraceCleaner)
+
+      cleaner = ActiveSupport::BacktraceCleaner.new
+      cleaner.remove_silencers!
+      cleaner.add_silencer do |line|
+        line.match?(@denylisted_fingerprint) || line.start_with?(RbConfig::CONFIG['rubylibdir'])
+      end
+      cleaner
+    end
+  end
+end

data/lib/lorekeeper/json_logger.rb

@@ -9,7 +9,7 @@ module Lorekeeper
     def initialize(file)
       reset_state
       @base_fields = { TIMESTAMP => '', MESSAGE => '', LEVEL => '' }
-      @backtrace_cleaner = set_backtrace_cleaner
+
       super(file)
     end
 
@@ -113,19 +113,10 @@ module Lorekeeper
 
     # Some instrumentation libraries pollute the stacktrace and create a large output which may
     # cause problems with certain logging backends.
-    # Hardcording newrelic, active_support/callbacks and zipkin-tracer now here.
-    # In the future if this list grows, we may make it configurable.
+    # Cleaner defaults to newrelic, active_support/callbacks, zipkin-tracer, opentelemetry, web servers,
+    # and stdlib now but can be configured by using LOREKEEPER_DENYLIST env var.
     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
+      Lorekeeper::BacktraceCleaner.instance.clean(backtrace)
     end
 
     THREAD_KEY = 'lorekeeper_jsonlogger_key' # Shared by all threads but unique by thread
@@ -136,7 +127,6 @@ module Lorekeeper
     EXCEPTION = 'exception'
     STACK = 'stack'
     DATA = 'data'
-    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 = '2.4.0'
+  VERSION = '2.6.0'
 end

data/lib/lorekeeper.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'lorekeeper/version'
+require 'lorekeeper/backtrace_cleaner'
 require 'lorekeeper/fast_logger'
 require 'lorekeeper/simple_logger'
 require 'lorekeeper/json_logger'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lorekeeper
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.6.0
 platform: ruby
 authors:
 - Jordi Polo
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-06 00:00:00.000000000 Z
+date: 2023-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
@@ -223,6 +223,7 @@ files:
 - bin/console
 - bin/setup
 - lib/lorekeeper.rb
+- lib/lorekeeper/backtrace_cleaner.rb
 - lib/lorekeeper/fast_logger.rb
 - lib/lorekeeper/json_logger.rb
 - lib/lorekeeper/multi_logger.rb
@@ -233,7 +234,7 @@ homepage: https://github.com/JordiPolo/lorekeeper
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -248,8 +249,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key: 
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 4
 summary: Very fast JSON logger
 test_files: []