inst-wide-logger 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1330118e6a708256a1bf74fe82a977fb04b654066699afe8b07038849721de61
-  data.tar.gz: 82793852255e6746b79f576ade3f9caecfaeac9548309d8b01d5ee1da32d0480
+  metadata.gz: 5d8e347b46de99e1474ad68d526f5f8666742c9bcd24a018a06ccf610b597e96
+  data.tar.gz: e7c08206a9747b4a5c0e8ae1cdf768eb45331f5ca12fdfbd18e92c8a6365337f
 SHA512:
-  metadata.gz: a58d0ea1188b30dca8bbe3a146ad79888b7444bdf28da8631ee5e56e5d154afc45ed1d7530870bac1899b32ad1b1d85e8f1c3cf5de9fd665166121e91f6dfe4e
-  data.tar.gz: 4b0e1389461f57b492f5041d20345841b18259788c0f760439dd2608f4c16e6f005922cbee2581873b872a36402a3a2e4d17593056c737d9908039086008b447
+  metadata.gz: ba10555e751477d537c1b9f115f02fcfa9402aaf13e90dae7a48f86b4a8eaed08f1889757da3f4f324f0f97a6705b22e4fc1e9b87ea31db7efdb19cc72bfb7e4
+  data.tar.gz: eff67e4ac3307bc48bb9260ffb589b86c3689e2807eea92c1af04d61b9ab0acacd1fbb1f6bb9a88f8e8f16a896d3d669fb02ce736af632a2af791f47d04dcc53

data/.rubocop.yml

@@ -0,0 +1,15 @@
+Style/FormatStringToken:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+
+Metrics/MethodLength:
+  Max: 15
+
+Metrics/AbcSize:
+  Max: 18
+
+Style/Documentation:
+  Enabled: false

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## [1.1.0] - 2026-04-01
+
+### Added
+
+- `WideLogger::WrapOptions` struct for structured options (`metadata`, `error_metadata`, `message`)
+- Message template support in `wrap` with `%{variable}` interpolation from logging context
+- Error metadata support: additional metadata added to context only on exception
+- Configurable default message templates per event type via `config.wide_logger.default_messages` or `WideLogger.default_messages`
+- `railties` as a runtime dependency
+
+### Changed
+
+- `WideLogger.wrap` now accepts `opts:` keyword argument (`WrapOptions`) instead of `metadata:`
+- Event types are now configurable via Railtie (`config.wide_logger.event_types`) or `WideLogger.custom_event_types`
+
 ## [1.0.1] - 2026-04-01
 
 ### Added

data/lib/wide_logger/railtie.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module WideLogger
+  class Railtie < Rails::Railtie
+    config.wide_logger = ActiveSupport::OrderedOptions.new
+    config.wide_logger.event_types = {}
+    config.wide_logger.default_messages = {}
+
+    initializer 'wide_logger.configure' do |app|
+      WideLogger.custom_event_types = app.config.wide_logger.event_types
+      WideLogger.default_messages = app.config.wide_logger.default_messages
+    end
+  end
+end

data/lib/wide_logger/version.rb

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

data/lib/wide_logger/wide_logger.rb

@@ -1,27 +1,53 @@
 # frozen_string_literal: true
 
 module WideLogger
-  EVENT_TYPES = {
-    web_request: 'canonical_request_summary',
+  DEFAULT_EVENT_TYPES = {
+    web_request: 'canonical_web_request_summary',
     job: 'canonical_job_summary',
     sqs: 'canonical_sqs_summary'
   }.freeze
 
+  WrapOptions = Struct.new(:metadata, :error_metadata, :message, keyword_init: true) do
+    def initialize(metadata: {}, error_metadata: {}, message: nil)
+      super
+    end
+  end
+
   class << self
-    def wrap(type:, metadata: {})
-      event_type = EVENT_TYPES.fetch(type)
+    def custom_event_types=(value)
+      @custom_event_types = value
+      @event_types = nil
+    end
+
+    def custom_event_types
+      @custom_event_types ||= {}
+    end
+
+    def event_types
+      @event_types ||= DEFAULT_EVENT_TYPES.merge(custom_event_types).freeze
+    end
+
+    attr_writer :default_messages
+
+    def default_messages
+      @default_messages ||= {}
+    end
+
+    def wrap(type:, opts: WrapOptions.new)
+      event_type = event_types.fetch(type)
 
       Rails.logger.add_metadata(
         log_event_type: event_type,
-        **metadata
+        **opts.metadata
       )
 
       result = yield
 
-      emit_event(event_type)
+      emit_event(event_type, opts.message || default_messages[type])
       result
     rescue StandardError => e
-      emit_event(event_type, e)
+      Rails.logger.add_metadata(**opts.error_metadata) unless opts.error_metadata.empty?
+      emit_event(event_type, nil, e)
       raise
     ensure
       Rails.logger.clear_metadata!
@@ -33,11 +59,15 @@ module WideLogger
 
     private
 
-    def emit_event(event_type, e = nil)
-      if e
-        Rails.logger.error("#{event_type} failed with error: #{e.message}")
+    def emit_event(event_type, message, error = nil)
+      if error
+        Rails.logger.error("#{event_type} failed with error: #{error.message}")
       else
-        Rails.logger.info(event_type)
+        if message
+          Rails.logger.info(message % Rails.logger.current_metadata)
+        else
+          Rails.logger.info(event_type)
+        end
       end
     end
   end

data/lib/wide_logger.rb

@@ -3,4 +3,5 @@
 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/dev_json_formatter'
+require_relative 'wide_logger/railtie' if defined?(Rails::Railtie)

data/wide_logger.gemspec

@@ -27,4 +27,5 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'paul_bunyan', '~> 2.1'
+  spec.add_dependency 'railties', '>= 6.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inst-wide-logger
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Zoltan Hegedus
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-04-01 00:00:00.000000000 Z
+date: 2026-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: paul_bunyan
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: railties
+  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'
 description:
 email:
 - zoltan.hegedus@instructure.com
@@ -32,6 +46,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".rspec"
+- ".rubocop.yml"
 - CHANGELOG.md
 - Gemfile
 - README.md
@@ -39,6 +54,7 @@ files:
 - lib/inst-wide-logger.rb
 - lib/wide_logger.rb
 - lib/wide_logger/dev_json_formatter.rb
+- lib/wide_logger/railtie.rb
 - lib/wide_logger/version.rb
 - lib/wide_logger/wide_logger.rb
 - wide_logger.gemspec