lorekeeper 2.3.2 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 53332589726c07831fc34d3d63b7517de62fd1a75c11d1cbf772b6088d125eed
-  data.tar.gz: 797d799f0268b110fe584ead9bdb9f9c3f779bca7d1e8d0fb75c796409a340c5
+  metadata.gz: b28b160e67e8d9321eebfb99ba3ade77f7409633ae3977b43abe5cdcdf62cb15
+  data.tar.gz: d2446915f9a3dd36ce5051316557816b884b33ea7ebbb3a3eeac8cb96ce528fc
 SHA512:
-  metadata.gz: c773417845d13a54058bd01b1541a64fa9564bce845fec21efcd69fa23916a323da0c679d86e8950c7c7dea1fa7c4a18e02429f21b4d896c670d4bb952ade48e
-  data.tar.gz: f95030ee5fe64f4cecd0cd9b15217897324bf2ac6aca1daed1a20a8daea233c029412a6a021dddd8bcd7d75d94aee673aa531f35bc8a214b6c07a0e666fca377
+  metadata.gz: 23d9b597ad2cc8cd4a5bc411f63a70f30930c066289aa17258319ddb8e9fdd68f092d8706ace0f5ce468e4ebfe4c8037b67007cb7e3accdf4489f11c6647dc11
+  data.tar.gz: 482721d054b7631906058eacf6c07db16235964ab7cf658e49ba92e8ed979beb05223240284d72267fe694aec6e66a576769bb862bfeba9d9f8ccf834e8d8187

data/.github/workflows/build.yml

@@ -14,7 +14,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['2.7', '3.0', '3.1']
+        ruby-version: ['2.7', '3.0', '3.1', '3.2']
 
     steps:
     - uses: actions/checkout@v2

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# 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
+
 # 2.3.2
 * Ensure additional fields are reset after logging
 * Let Oj fallback to :object mode for non-representable data

data/README.md

@@ -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

data/Rakefile

@@ -28,7 +28,7 @@ end
 
 def create_simple_logger
   logfile = Tempfile.new('my_test_log.log')
-  ::Logger.new(logfile.path)
+  Logger.new(logfile.path)
 end
 
 # This task is used to help development of Lorekeeper. Use together with rbtrace

data/lib/lorekeeper/fast_logger.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
 require 'logger'
+require 'fiber'
 
 module Lorekeeper
   # Very simple, very fast logger
   class FastLogger
     include ::Logger::Severity # contains the levels constants: DEBUG, ERROR, etc.
-    attr_accessor :level,      # Current level, default: DEBUG
-      :formatter   # Just for compatibility with Logger, not used
+    attr_accessor :formatter   # Just for compatibility with Logger, not used
 
     def debug?; level <= DEBUG; end
     def info?; level <= INFO; end
@@ -19,6 +19,29 @@ module Lorekeeper
       @level = DEBUG
       @iodevice = LogDevice.new(file)
       @file = file # We only keep this so we can inspect where we are sending the logs
+      @level_override = {}
+    end
+
+    def level
+      @level_override[Fiber.current] || @level
+    end
+
+    def level=(severity)
+      @level = coerce(severity)
+    end
+
+    def with_level(severity)
+      prev = level
+      @level_override[Fiber.current] = coerce(severity)
+      begin
+        yield
+      ensure
+        if prev
+          @level_override[Fiber.current] = prev
+        else
+          @level_override.delete(Fiber.current)
+        end
+      end
     end
 
     LOGGING_METHODS = %i[
@@ -55,7 +78,7 @@ module Lorekeeper
 
     # This is part of the standard Logger API, we need this to be compatible
     def add(severity, message_param = nil, progname = nil, &block)
-      return true if severity < @level
+      return true if severity < level
 
       message = block&.call || message_param || progname
       log_data(severity, message.freeze)
@@ -83,6 +106,12 @@ module Lorekeeper
       @iodevice.write(message)
     end
 
+    def coerce(severity)
+      return severity if severity.is_a?(Integer)
+
+      METHOD_SEVERITY_MAP[severity] || raise(ArgumentError, "invalid log level: #{severity}")
+    end
+
     require 'monitor'
     # Mutex to avoid broken lines when multiple threads access the log file
     class LogDeviceMutex

data/lib/lorekeeper/json_logger.rb

@@ -10,6 +10,11 @@ module Lorekeeper
       reset_state
       @base_fields = { TIMESTAMP => '', MESSAGE => '', LEVEL => '' }
       @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
+
       super(file)
     end
 
@@ -113,18 +118,38 @@ 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 = filter_rails_root_backtrace(backtrace)
       @backtrace_cleaner&.clean(backtrace) || backtrace
     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 { |line| line.match?(BLACKLISTED_FINGERPRINT) }
+      cleaner.add_silencer do |line|
+        line.match?(@denylisted_fingerprint) || line.start_with?(RbConfig::CONFIG['rubylibdir'])
+      end
       cleaner
     end
 
@@ -136,7 +161,14 @@ module Lorekeeper
     EXCEPTION = 'exception'
     STACK = 'stack'
     DATA = 'data'
-    BLACKLISTED_FINGERPRINT = %r{newrelic_rpm|active_support/callbacks.rb|zipkin-tracer}.freeze
+    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 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.3.2'
+  VERSION = '2.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lorekeeper
 version: !ruby/object:Gem::Version
-  version: 2.3.2
+  version: 2.5.0
 platform: ruby
 authors:
 - Jordi Polo
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-23 00:00:00.000000000 Z
+date: 2023-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj