rails_semantic_logging 0.2.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45760af9983f2c22b841521dede71966f21d51b02ac68909adc334a9c59d1347
-  data.tar.gz: d143a49b3a2044e30ac92e20d0ea85d81c4634322526e1e03480e4b9f731e0e0
+  metadata.gz: 40482577c0ac8936d96cf3d500c24b645c0226a31ea751622b420d7888590eec
+  data.tar.gz: b974b492c915aa1e3b800c48a038534cb7ae46c17b8ca100fd8eaceda3f473b6
 SHA512:
-  metadata.gz: cd642159648180526467d511be9f232571e9f7fffcac3840c02706eb1e4f0a18143921d612d8a3cb356d04ed8b51127fa2a05d746791f3a2655eb1caa87a58a2
-  data.tar.gz: cf2ce998170d859f106e83b9b11648d1135a5015abd4a8790c67e4ce076bfaf685f1e3622eaaddf9a7127720afbc2378d01fcb8b320672ac4a4a39e9b3536c9e
+  metadata.gz: b2c05a19c26a66b1f7410daf9f6b01eb6ae6927c6d1df8957b93a931b430f3ffff225380cef4af9f281c2f452d3c4808ff5ee95e7279e007a649d59e3a279f8a
+  data.tar.gz: 1d8d2ff66e03af18e73b6e52e1e3dcd8aac16f24e62484d3a390522e521f850dab6d51a9e8dcc68a96db4dbe971b03bad2c0398a259575c6412b04e6c7d07ddd

data/README.md

@@ -279,7 +279,10 @@ The matcher passes a **duplicated** copy of the log event to the formatter, so a
 
 ## Puma Integration
 
-When using Puma in clustered mode, reopen log appenders after forking:
+With `semantic_logger` >= 5 appenders are reopened automatically after forking, so no Puma
+configuration is needed (opt out with `SemanticLogger.reopen_on_fork = false`).
+
+When still on `semantic_logger` 4.x, reopen log appenders after forking in clustered mode:
 
 ```ruby
 # config/puma.rb

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.1

data/lib/rails_semantic_logging/railtie.rb

@@ -11,25 +11,32 @@ module RailsSemanticLogging
     # This ensures our configuration is applied before the logger is set up.
     initializer 'rails_semantic_logging.configure', before: :initialize_logger do |app|
       cfg = RailsSemanticLogging.config
+      formatter = cfg.formatter_for(Rails.env)
 
-      # Configure rails_semantic_logger options
       app.config.rails_semantic_logger.quiet_assets = cfg.quiet_assets
-      app.config.rails_semantic_logger.console_logger = false
-      app.config.rails_semantic_logger.add_file_appender = false
 
-      # Set formatter based on environment
-      app.config.rails_semantic_logger.format = cfg.formatter_for(Rails.env)
+      # Declare a single stdout appender with the configured formatter.
+      # IMPORTANT: Do NOT pass level: parameter. Subscriber#level defaults to :trace
+      # when unset, which is required by the host app's spec/support/output.rb check.
+      if app.config.rails_semantic_logger.respond_to?(:appenders?)
+        # rails_semantic_logger >= 5: declaring an appender replaces the default
+        # file appender and the automatic console stderr appender.
+        app.config.rails_semantic_logger.appenders do |appenders|
+          appenders.add(io: $stdout, formatter: formatter)
+        end
+      else
+        # rails_semantic_logger 4.x: disable the built-in appenders and add ours.
+        app.config.rails_semantic_logger.console_logger = false
+        app.config.rails_semantic_logger.add_file_appender = false
+        app.config.rails_semantic_logger.format = formatter
+        app.config.semantic_logger.add_appender(io: $stdout, formatter: formatter)
+      end
 
       # Merge default tags (request_id, client_ip) with app-specific custom tags
       app.config.log_tags = cfg.effective_log_tags
 
       # Set log level based on environment, respecting LOG_LEVEL env var
       app.config.log_level = cfg.log_level_for(Rails.env)
-
-      # Add stdout appender with the configured formatter.
-      # IMPORTANT: Do NOT pass level: parameter. Subscriber#level defaults to :trace
-      # when unset, which is required by the host app's spec/support/output.rb check.
-      app.config.semantic_logger.add_appender(io: $stdout, formatter: app.config.rails_semantic_logger.format)
     end
 
     config.to_prepare do

data/lib/rails_semantic_logging/rspec/matchers.rb

@@ -22,6 +22,47 @@ module RailsSemanticLogging
       end
     end
 
+    # Shared capture plumbing for the block matchers. Opens the logger gate to
+    # :trace so every event reaches the in-memory capture appender, while
+    # pinning the pre-existing appenders to the previously *visible* threshold
+    # (default_level, or an active SemanticLogger.silence override such as the
+    # LOG env var hook) so widening the gate does not spill every captured
+    # event to stdout.
+    module CaptureAppender
+      module_function
+
+      def with_capture_appender(capture)
+        previous_level = ::SemanticLogger.default_level
+        pinned = pin_live_appenders(visible_level(previous_level))
+        ::SemanticLogger.add_appender(appender: capture)
+        ::SemanticLogger.default_level = :trace
+        yield
+        ::SemanticLogger.flush
+      ensure
+        ::SemanticLogger.default_level = previous_level
+        pinned&.each { |appender, level| appender.level = level }
+        ::SemanticLogger.remove_appender(capture)
+      end
+
+      # Pins every live appender to +level+, returning the [appender, original_level]
+      # pairs needed to restore them afterwards.
+      def pin_live_appenders(level)
+        ::SemanticLogger.appenders.to_a.map do |appender|
+          original = appender.level
+          appender.level = level
+          [appender, original]
+        end
+      end
+
+      # The threshold actually in effect before the matcher widened the gate:
+      # a SemanticLogger.silence override (stored as a level index in a
+      # thread-local by both semantic_logger 4.x and 5.x) wins over default_level.
+      def visible_level(default_level)
+        silence_index = Thread.current[:semantic_logger_silence]
+        silence_index ? ::SemanticLogger::Levels::LEVELS[silence_index] : default_level
+      end
+    end
+
     # RSpec matcher for asserting log output from a block.
     #
     # Usage:
@@ -38,14 +79,7 @@ module RailsSemanticLogging
 
       def matches?(block)
         appender = InMemoryAppender.new
-        SemanticLogger.add_appender(appender: appender)
-        # Temporarily lower log level to capture all messages
-        previous_level = SemanticLogger.default_level
-        SemanticLogger.default_level = :trace
-        block.call
-        SemanticLogger.flush
-        SemanticLogger.default_level = previous_level
-        SemanticLogger.remove_appender(appender)
+        CaptureAppender.with_capture_appender(appender) { block.call }
 
         @captured_logs = appender.logs
         @captured_logs.any? { |log| matches_log?(log) }
@@ -203,21 +237,10 @@ module RailsSemanticLogging
 
       def capture_first_matching_event(block)
         capture = InMemoryAppender.new
-        with_capture_appender(capture) { block.call }
+        CaptureAppender.with_capture_appender(capture) { block.call }
         capture.logs.find { |evt| message_matches?(evt.message) }
       end
 
-      def with_capture_appender(capture)
-        ::SemanticLogger.add_appender(appender: capture)
-        previous_level = ::SemanticLogger.default_level
-        ::SemanticLogger.default_level = :trace
-        yield
-        ::SemanticLogger.flush
-      ensure
-        ::SemanticLogger.default_level = previous_level
-        ::SemanticLogger.remove_appender(capture)
-      end
-
       # Matches String, Regex and any object that implements `===` (incl. RSpec
       # built-in matchers like `a_string_starting_with("...")`).
       def message_matches?(actual)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_semantic_logging
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Fabio Napoleoni
@@ -47,16 +47,22 @@ dependencies:
   name: rails_semantic_logger
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.18'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.18'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '6'
 description: Provides a consistent, opinionated setup for structured JSON logging
   in Rails, with specific hooks for Sidekiq, ActiveJob, and Puma, as well as Datadog-friendly
   formatters.