inst-wide-logger 1.1.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d8e347b46de99e1474ad68d526f5f8666742c9bcd24a018a06ccf610b597e96
-  data.tar.gz: e7c08206a9747b4a5c0e8ae1cdf768eb45331f5ca12fdfbd18e92c8a6365337f
+  metadata.gz: 3b9f2740d229c6b5e3a628f349d8674654046c56c646ee505474699f14b9f8fd
+  data.tar.gz: b1ddd213ae2cf6b2b05da1a7855435a96294ca6879c8e2d10fc175a3edfd1a4d
 SHA512:
-  metadata.gz: ba10555e751477d537c1b9f115f02fcfa9402aaf13e90dae7a48f86b4a8eaed08f1889757da3f4f324f0f97a6705b22e4fc1e9b87ea31db7efdb19cc72bfb7e4
-  data.tar.gz: eff67e4ac3307bc48bb9260ffb589b86c3689e2807eea92c1af04d61b9ab0acacd1fbb1f6bb9a88f8e8f16a896d3d669fb02ce736af632a2af791f47d04dcc53
+  metadata.gz: 0f39db58281e6f7b4ba6379fad20b0f75150a3d8f53f20adefff61256a91842a792ba6823290ec1dc833f7a4cf60e70d813a97ae9bfe1fcbfcf1c05b53d9dd1f
+  data.tar.gz: fbdd690779e28f2bb8bf89182739d4114130689e04905078d089394e8641ddf01d88a71407759da107374d31d5ab1919f833a7db17d371ebdd6fa4045da5907e

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## [1.3.0] - 2026-04-20
+
+### Added
+
+- `WideLogger::DevFormatter` with an `include_json:` constructor option (default `true`) to control whether the JSON context is appended to each log entry
+
+### Deprecated
+
+- `WideLogger::DevJsonFormatter` — use `WideLogger::DevFormatter` instead. The alias will be removed in 2.0.
+
+## [1.2.0] - 2026-04-16
+
+### Added
+
+- `WideLogger::DowngradingToDebugLogger` - a logger wrapper that downgrades log levels at or below a configurable threshold to `debug`
+- Nested metadata interpolation in message templates using dot notation (e.g. `%<job.tag>s`)
+
 ## [1.1.0] - 2026-04-01
 
 ### Added

data/README.md

@@ -33,12 +33,20 @@ WideLogger.wrap(type: :web_request, metadata: { additional_context: @context })
 end
 ```
 
-Optionally, you can use WideLogger:DevJsonFormatter to have log entries in the following format:
+Optionally, you can use `WideLogger::DevFormatter` to have log entries in the following format:
 
 ```text
 <timestamp> <message> <context in JSON format>
 ```
 
+The formatter accepts an `include_json:` keyword (default `true`). Set it to `false` to suppress the JSON context and emit only `<timestamp> <message>`:
+
+```ruby
+config.logging.formatter = WideLogger::DevFormatter.new(include_json: false)
+```
+
+> `WideLogger::DevJsonFormatter` is kept as a deprecated alias of `DevFormatter` for backwards compatibility and will be removed in 2.0.
+
 ## Development
 
 After checking out the repo, run `bundle install` to install dependencies. Then, run `rake spec` to run the tests.

data/lib/wide_logger/dev_formatter.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'active_support/deprecation'
+
+module WideLogger
+  class DevFormatter < PaulBunyan::JSONFormatter
+    def initialize(include_json: true)
+      super()
+      @include_json = include_json
+    end
+
+    def call(severity, time, progname, msg)
+      prefix = time.utc.strftime(DATETIME_FORMAT) + ' ' + msg.to_s
+      return prefix + "\n" unless @include_json
+
+      prefix + ' ' + super
+    end
+
+    private
+
+    def merge_metadata_and_message(metadata, message)
+      super.except('message', 'ts').sort_by { |key, _| key.to_s }.to_h
+    end
+  end
+
+  DEPRECATOR = ActiveSupport::Deprecation.new('2.0', 'WideLogger')
+
+  class DevJsonFormatter < DevFormatter
+    def initialize(*args, **kwargs)
+      DEPRECATOR.warn(
+        'WideLogger::DevJsonFormatter is deprecated and will be removed in 2.0. ' \
+        'Use WideLogger::DevFormatter instead.'
+      )
+      super
+    end
+  end
+end

data/lib/wide_logger/downgrading_to_debug_logger.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'delegate'
+
+module WideLogger
+  class DowngradingToDebugLogger < SimpleDelegator
+    LEVELS = %i[info warn error fatal unknown].freeze
+
+    def initialize(logger, threshold:)
+      super(logger)
+      threshold_index = LEVELS.index(threshold)
+      LEVELS[0..threshold_index].each do |level|
+        define_singleton_method(level) do |msg = nil, &block|
+          __getobj__.debug(msg, &block)
+        end
+      end
+    end
+  end
+end

data/lib/wide_logger/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module WideLogger
-  VERSION = "1.1.0"
+  VERSION = "1.3.0"
 end

data/lib/wide_logger/wide_logger.rb

@@ -7,6 +7,8 @@ module WideLogger
     sqs: 'canonical_sqs_summary'
   }.freeze
 
+  INTERPOLATION_PATTERN = /%(?:\{([^}]+)\}|<([^>]+)>([a-zA-Z]))/
+
   WrapOptions = Struct.new(:metadata, :error_metadata, :message, keyword_init: true) do
     def initialize(metadata: {}, error_metadata: {}, message: nil)
       super
@@ -62,12 +64,29 @@ module WideLogger
     def emit_event(event_type, message, error = nil)
       if error
         Rails.logger.error("#{event_type} failed with error: #{error.message}")
+      elsif message
+        Rails.logger.info(interpolate_message(message))
+      else
+        Rails.logger.info(event_type)
+      end
+    end
+
+    def interpolate_message(message)
+      metadata = Rails.logger.current_metadata
+      message.gsub(INTERPOLATION_PATTERN) do |match|
+        value = resolve_key(metadata, $1 || $2)
+        next match if value.nil?
+
+        $1 ? value.to_s : format("%#{$3}", value)
+      end
+    end
+
+    def resolve_key(metadata, key)
+      if key.include?('.')
+        keys = key.split('.').map(&:to_sym)
+        metadata.dig(*keys)
       else
-        if message
-          Rails.logger.info(message % Rails.logger.current_metadata)
-        else
-          Rails.logger.info(event_type)
-        end
+        metadata[key.to_sym]
       end
     end
   end

data/lib/wide_logger.rb

@@ -3,5 +3,6 @@
 require 'paul_bunyan'
 require_relative 'wide_logger/version'
 require_relative 'wide_logger/wide_logger'
-require_relative 'wide_logger/dev_json_formatter'
+require_relative 'wide_logger/downgrading_to_debug_logger'
+require_relative 'wide_logger/dev_formatter'
 require_relative 'wide_logger/railtie' if defined?(Rails::Railtie)

data/wide_logger.gemspec

@@ -26,6 +26,7 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'activesupport', '>= 6.0'
   spec.add_dependency 'paul_bunyan', '~> 2.1'
   spec.add_dependency 'railties', '>= 6.0'
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: inst-wide-logger
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Zoltan Hegedus
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-04-09 00:00:00.000000000 Z
+date: 2026-04-20 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: paul_bunyan
   requirement: !ruby/object:Gem::Requirement
@@ -53,7 +67,8 @@ files:
 - Rakefile
 - lib/inst-wide-logger.rb
 - lib/wide_logger.rb
-- lib/wide_logger/dev_json_formatter.rb
+- lib/wide_logger/dev_formatter.rb
+- lib/wide_logger/downgrading_to_debug_logger.rb
 - lib/wide_logger/railtie.rb
 - lib/wide_logger/version.rb
 - lib/wide_logger/wide_logger.rb

data/lib/wide_logger/dev_json_formatter.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module WideLogger
-  class DevJsonFormatter < PaulBunyan::JSONFormatter
-    def call(severity, time, progname, msg)
-      time.utc.strftime(DATETIME_FORMAT) + ' ' + msg.to_s + ' ' + super
-    end
-
-    private
-
-    def merge_metadata_and_message(metadata, message)
-      super.except('message', 'ts').sort_by { |key, _| key.to_s }.to_h
-    end
-  end
-end