activesupport-json_logging 1.2.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71ac52d26c4cca14a0eaed618927f9432880865ad9b24e43232b5801ce10a055
-  data.tar.gz: 81ef2c90e5d44fc7910f319acdbbd4bb9b56572075c6a28050fd05759349e91b
+  metadata.gz: 2b40f43e3cd600bfc139665fa3e6cc9df7a4a56eab58bec7f760b986faa9d2f7
+  data.tar.gz: d8d3352e482dc9698aa94a499f9905a1fdec0ca157cedf4e8a61194dfd7e7fba
 SHA512:
-  metadata.gz: 0f8ebdfeb94e456cdffd8e8d176c9dde7dff4187f2547b721dd4ec33e229c290663386a1f1c091ee54e95821be3bc11eb8f02fbf645f3a9bd8a54ab1e79596b9
-  data.tar.gz: cbfdad0f75642ec096bf18ca154a9aef9ce3364d92a43c263ceea81f877f018db3459b1a3fc239b2025aa6d96815db8f37063675f33a29d24fd24de4eaeb2299
+  metadata.gz: 4b0befde4733aeade6f332adaf529735ed718fc5b4ad03dbbcbcd6d66e0124ed107e508f47fc3efa70f4fc31479d61ac42508d364c185c846a9c93ce51924cac
+  data.tar.gz: 83b705a450abaf4b389495652843bc4ed537de7485bb1158423b5a9055e40616024ed928844a485d65aa26cadfbe64746570dd823943dc724b29e849dcbd7ecf

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # CHANGELOG
 
+## 1.3.0 (2026-07-25)
+
+- BREAKING: Require Ruby 3.2+ and Rails 7+ (drop Ruby 2.7–3.1 and Rails 6 support)
+- Add opt-in `JsonLogging::EventSubscriber` for Rails 8.1 `ActiveSupport::EventReporter` / `Rails.event` structured events
+
 ## 1.2.3 (2026-07-13)
 
 - Reduce per-line work for plain string, hash, tagged, and context-scoped log messages on common shapes

data/README.md

@@ -1,17 +1,10 @@
 # activesupport-json_logging
 
-[![Gem Version](https://badge.fury.io/rb/activesupport-json_logging.svg)](https://badge.fury.io/rb/activesupport-json_logging) [![Test Status](https://github.com/amkisko/activesupport-json_logging.rb/actions/workflows/test.yml/badge.svg)](https://github.com/amkisko/activesupport-json_logging.rb/actions/workflows/test.yml) [![codecov](https://codecov.io/gh/amkisko/activesupport-json_logging.rb/graph/badge.svg?token=UX80FTO0Y0)](https://codecov.io/gh/amkisko/activesupport-json_logging.rb) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=amkisko_activesupport-json_logging.rb&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=amkisko_activesupport-json_logging.rb)
+[![Gem Version](https://badge.fury.io/rb/activesupport-json_logging.svg)](https://badge.fury.io/rb/activesupport-json_logging) [![Test Status](https://github.com/amkisko/activesupport-json_logging.rb/actions/workflows/test.yml/badge.svg)](https://github.com/amkisko/activesupport-json_logging.rb/actions/workflows/test.yml) [![codecov](https://codecov.io/gh/amkisko/activesupport-json_logging.rb/graph/badge.svg?token=UX80FTO0Y0)](https://app.codecov.io/github/amkisko/activesupport-json_logging.rb) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=amkisko_activesupport-json_logging.rb&metric=alert_status)](https://sonarcloud.io/project/overview?id=amkisko_activesupport-json_logging.rb)
 
 Structured JSON logging for Rails and ActiveSupport with a safe, single-line formatter.
 No dependencies beyond Rails and Activesupport.
-Supports Rails versions from 6 to 8.
-
-Sponsored by [Kisko Labs](https://www.kiskolabs.com).
-
-<a href="https://www.kiskolabs.com">
-  <img src="kisko.svg" width="200" alt="Sponsored by Kisko Labs" />
-</a>
-
+Supports Ruby 3.2+ and Rails 7–8.
 
 ## Installation
 
@@ -46,6 +39,7 @@ end
 - Native `tagged` method support - use it just like Rails' tagged logger
 - Service-specific tagged loggers - create loggers with permanent tags using `logger.tagged("service")` without a block
 - Full compatibility with `ActiveSupport::BroadcastLogger` (Rails 7.1+)
+- Opt-in `JsonLogging::EventSubscriber` for Rails 8.1 `ActiveSupport::EventReporter` / `Rails.event`
 - Automatic Rails integration via Railtie (auto-requires the gem in Rails apps)
 
 ## Basic usage
@@ -132,6 +126,37 @@ sidekiq_logger.info("Job enqueued")      # Tagged with "sidekiq"
 api_logger.info("Request received")      # Tagged with "api"
 ```
 
+### Rails 8.1 Event Reporter
+
+Rails 8.1 adds `Rails.event` (`ActiveSupport::EventReporter`) for structured events that complement `Rails.logger`. Setting `config.logger` to a `JsonLogging` logger does not subscribe you to events. Register a subscriber:
+
+```ruby
+# config/initializers/json_logging.rb
+subscriber = JsonLogging::EventSubscriber.new(logger: -> { Rails.logger })
+Rails.event.subscribe(subscriber)
+
+# Optional: only a subset of events
+Rails.event.subscribe(subscriber) { |event| event[:name].start_with?("app.") }
+```
+
+Pass either `logger:` or `io:`, not both. A callable `logger:` is resolved on each emit (the Railtie opt-in uses this so a later `Rails.logger=` swap is picked up).
+
+Or enable the Railtie opt-in (off by default):
+
+```ruby
+# config/application.rb or an environment file
+config.json_logging.subscribe_event_reporter = true
+```
+
+The subscriber writes one JSON line per event and keeps the Rails event shape (`name`, `payload`, `tags`, `context`, `timestamp`, `source_location`). It writes through `Logger#<<` so the logger formatter does not wrap the event again. Payload and tag objects that implement `#serialize` are encoded via that method. Encode and write failures never raise from `#emit`.
+
+```ruby
+Rails.event.set_context(request_id: "abc123")
+Rails.event.tagged("billing") do
+  Rails.event.notify("invoice.created", invoice_id: 3)
+end
+```
+
 ### BroadcastLogger integration
 
 `ActiveSupport::BroadcastLogger` (Rails 7.1+) allows writing logs to multiple destinations simultaneously. `JsonLogging` works seamlessly with `BroadcastLogger`:
@@ -460,6 +485,16 @@ formatter.call("INFO", Time.now, nil, "message")  # Output includes both tags
 
 **Note:** When used with a logger (via `JsonLogging.new`), the logger uses `FormatterWithTags` which automatically includes tags from the logger's tagged context. Use `Formatter` directly only when you need a standalone formatter without a logger instance.
 
+### JsonLogging::EventSubscriber
+
+Rails 8.1+ subscriber for `ActiveSupport::EventReporter`. See [Rails 8.1 Event Reporter](#rails-81-event-reporter).
+
+```ruby
+subscriber = JsonLogging::EventSubscriber.new(logger: -> { Rails.logger })
+# or: JsonLogging::EventSubscriber.new(io: $stdout)
+Rails.event.subscribe(subscriber)
+```
+
 ### JsonLogging.with_context
 
 Add thread-local context that appears in all log entries within the block:
@@ -554,7 +589,7 @@ This is useful for:
 - Temporary verbose logging in background jobs
 - Per-request log level changes
 
-**Note:** `local_level` is available in Rails 7.1+. In Rails 6-7.0, only the global `level` is available.
+**Note:** `local_level` is available in Rails 7.1+. In Rails 7.0, only the global `level` is available.
 
 #### Standard Logger Methods
 
@@ -652,7 +687,28 @@ gem build activesupport-json_logging.gemspec
 gem push activesupport-json_logging-*.gem
 ```
 
+## Links
+
+- [GitHub](https://github.com/amkisko/activesupport-json_logging.rb)
+- [GitLab](https://gitlab.com/amkisko/activesupport-json_logging.rb)
+- [RubyGems](https://rubygems.org/gems/activesupport-json_logging)
+- [Versions Atom](https://rubygems.org/gems/activesupport-json_logging/versions.atom) (feed id `9801944970071`)
+- [libraries.io](https://libraries.io/rubygems/activesupport-json_logging)
+- [Deps.dev](https://deps.dev/rubygems/activesupport-json_logging)
+- [SonarCloud](https://sonarcloud.io/project/overview?id=amkisko_activesupport-json_logging.rb)
+- [Snyk](https://snyk.io/test/github/amkisko/activesupport-json_logging.rb)
+- [Codecov](https://app.codecov.io/github/amkisko/activesupport-json_logging.rb)
+- [OpenSSF Scorecard](https://scorecard.dev/viewer/?uri=github.com/amkisko/activesupport-json_logging.rb)
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
+## Sponsors
+
+Sponsored by [Kisko Labs](https://www.kiskolabs.com).
+
+<a href="https://www.kiskolabs.com">
+  <img src="kisko.svg" width="200" alt="Sponsored by Kisko Labs" />
+</a>
+

data/lib/activesupport/json_logging/railtie.rb

@@ -2,7 +2,18 @@ require "json_logging"
 
 module JsonLogging
   class Railtie < ::Rails::Railtie
+    config.json_logging = ActiveSupport::OrderedOptions.new
+    config.json_logging.subscribe_event_reporter = false
+
     # This Railtie ensures json_logging is automatically required when Rails loads
     # Without this, users would need to manually require "json_logging" in initializers
+
+    initializer "json_logging.subscribe_event_reporter", after: :load_config_initializers do |app|
+      next unless app.config.json_logging.subscribe_event_reporter
+      next unless defined?(ActiveSupport::EventReporter)
+      next unless Rails.respond_to?(:event)
+
+      Rails.event.subscribe(JsonLogging::EventSubscriber.new(logger: -> { Rails.logger }))
+    end
   end
 end

data/lib/json_logging/event_subscriber.rb

@@ -0,0 +1,146 @@
+module JsonLogging
+  # Opt-in subscriber for ActiveSupport::EventReporter (Rails 8.1+).
+  # Preserves the Rails event hash shape as a single JSON line.
+  class EventSubscriber
+    def initialize(logger: nil, io: nil)
+      if !logger.nil? && !io.nil?
+        raise ArgumentError, "JsonLogging::EventSubscriber accepts only one of logger: or io:"
+      end
+      if logger.nil? && io.nil?
+        raise ArgumentError, "JsonLogging::EventSubscriber requires logger: or io:"
+      end
+
+      @logger = logger
+      @io = io
+    end
+
+    def emit(event)
+      line = begin
+        encode_event(event)
+      rescue => error
+        encode_fallback(event, error)
+      end
+
+      write_line(line)
+    rescue => error
+      report_write_error(error)
+      nil
+    end
+
+    private
+
+    def encode_event(event)
+      payload = {
+        "name" => Helpers.safe_string(event_field(event, :name)),
+        "payload" => serialize_payload(event_field(event, :payload)),
+        "tags" => serialize_tags(event_field(event, :tags)),
+        "context" => hash_or_empty(event_field(event, :context)),
+        "timestamp" => event_field(event, :timestamp)
+      }
+      source_location = event_field(event, :source_location)
+      payload["source_location"] = hash_or_empty(source_location) if source_location
+
+      LineEncoder.to_json_line(Sanitizer.sanitize_hash(payload))
+    end
+
+    def encode_fallback(event, error)
+      event_name = begin
+        Helpers.safe_string(event && event_field(event, :name))
+      rescue
+        nil
+      end
+
+      LineEncoder.to_json_line(
+        Sanitizer.sanitize_hash(
+          {
+            "name" => "json_logging.event_encode_error",
+            "event_name" => event_name,
+            "error" => {
+              "class" => error.class.name,
+              "message" => Helpers.safe_string(error.message)
+            }
+          }
+        )
+      )
+    end
+
+    def event_field(event, key)
+      return nil unless event.is_a?(Hash)
+
+      if event.key?(key)
+        event[key]
+      elsif event.key?(key.to_s)
+        event[key.to_s]
+      end
+    end
+
+    def serialize_payload(payload)
+      case payload
+      when Hash
+        payload
+      when nil
+        {}
+      else
+        serialize_object(payload)
+      end
+    end
+
+    def serialize_tags(tags)
+      return {} unless tags.is_a?(Hash)
+
+      tags.transform_values { |value| serialize_tag_value(value) }
+    end
+
+    def serialize_tag_value(value)
+      case value
+      when Hash, TrueClass, FalseClass, Numeric, NilClass, String
+        value
+      else
+        serialize_object(value)
+      end
+    end
+
+    def serialize_object(object)
+      if object.respond_to?(:serialize)
+        serialized = object.serialize
+        serialized.is_a?(Hash) ? serialized : {"value" => serialized}
+      elsif object.respond_to?(:to_h)
+        object.to_h
+      else
+        {
+          "class" => object.class.name,
+          "value" => Helpers.safe_string(object)
+        }
+      end
+    end
+
+    def hash_or_empty(value)
+      value.is_a?(Hash) ? value : {}
+    end
+
+    def write_line(line)
+      if @io
+        @io.write(line)
+      else
+        resolve_logger << line
+      end
+    end
+
+    def resolve_logger
+      logger = @logger
+      # Proc responds to << (composition); Logger responds to add.
+      return logger.call if logger.respond_to?(:call) && !logger.respond_to?(:add)
+
+      logger
+    end
+
+    def report_write_error(error)
+      return unless defined?(ActiveSupport) && ActiveSupport.respond_to?(:error_reporter)
+      return if ActiveSupport.error_reporter.nil?
+
+      ActiveSupport.error_reporter.report(error, handled: true, severity: :error)
+    rescue
+      nil
+    end
+  end
+end

data/lib/json_logging/json_logger.rb

@@ -8,18 +8,16 @@ module JsonLogging
 
     def initialize(*args, **kwargs)
       # Initialize with minimal args to avoid ActiveSupport::Logger threading issues
-      # Rails 7+ supports kwargs, Rails 6 uses positional args only
       logdev = args.first || $stdout
       shift_age = args[1] || 0
       shift_size = args[2]
 
-      # Handle both positional and keyword arguments for Rails 6-8 compatibility
+      # Handle both positional and keyword arguments for Rails 7–8 compatibility
       if kwargs.empty? && shift_size
         super(logdev, shift_age, shift_size)
       elsif kwargs.empty?
         super(logdev, shift_age)
       else
-        # Rails 7+ may pass kwargs - delegate to parent
         super
       end
 

data/lib/json_logging/json_logger_extension.rb

@@ -95,7 +95,7 @@ module JsonLogging
 
     def current_tags
       # Use IsolatedExecutionState (Rails 7.1+) for better thread/Fiber safety
-      # Falls back to Thread.current for Rails 6-7.0
+      # Falls back to Thread.current for Rails 7.0
       if defined?(ActiveSupport::IsolatedExecutionState)
         ActiveSupport::IsolatedExecutionState[tags_key] ||= []
       else
@@ -105,7 +105,7 @@ module JsonLogging
 
     def set_tags(new_tags)
       # Use IsolatedExecutionState (Rails 7.1+) for better thread/Fiber safety
-      # Falls back to Thread.current for Rails 6-7.0
+      # Falls back to Thread.current for Rails 7.0
       if defined?(ActiveSupport::IsolatedExecutionState)
         ActiveSupport::IsolatedExecutionState[tags_key] = new_tags
       else

data/lib/json_logging/sanitizer.rb

@@ -131,7 +131,7 @@ module JsonLogging
       if filter
         # ParameterFilter will filter based on Rails.config.filter_parameters
         # This includes encrypted attributes automatically
-        # Create a deep copy since filter modifies in place (Rails 6+)
+        # Create a deep copy since filter modifies in place
         filtered = limited_hash.respond_to?(:deep_dup) ? limited_hash.deep_dup : limited_hash.dup
         filtered = filter.filter(filtered)
 

data/lib/json_logging/structured_hash_sanitizer.rb

@@ -1,7 +1,7 @@
 module JsonLogging
   module Sanitizer
     module StructuredHash
-      JsonableResult = Struct.new(:tree, :owned, :leaf_count, keyword_init: true)
+      JsonableResult = Struct.new(:tree, :owned, :leaf_count)
 
       module_function
 
@@ -99,14 +99,14 @@ module JsonLogging
         when String
           leaf_counter[0] += 1 if leaf_counter
           sanitized = Sanitizer.sanitize_string(value)
-          JsonableResult.new(tree: sanitized, owned: sanitized != value)
+          JsonableResult.new(tree: sanitized, owned: sanitized != value, leaf_count: nil)
         when Hash
           jsonable_tree(value, depth: depth + 1, seen: seen, parent_key: parent_key, leaf_counter: leaf_counter)
         when Array
           jsonable_array(value, depth: depth, seen: seen, parent_key: parent_key, leaf_counter: leaf_counter)
         else
           leaf_counter[0] += 1 if leaf_counter
-          JsonableResult.new(tree: value, owned: false)
+          JsonableResult.new(tree: value, owned: false, leaf_count: nil)
         end
       end
 
@@ -123,7 +123,7 @@ module JsonLogging
           result[index] = child.tree
         end
 
-        JsonableResult.new(tree: owned ? result : array, owned: owned)
+        JsonableResult.new(tree: owned ? result : array, owned: owned, leaf_count: nil)
       end
 
       def process_jsonable_entry(key, value, depth:, seen:, parent_key:, omit_keys:, leaf_counter:)

data/lib/json_logging/version.rb

@@ -1,3 +1,3 @@
 module JsonLogging
-  VERSION = "1.2.2"
+  VERSION = "1.3.0"
 end

data/lib/json_logging.rb

@@ -12,6 +12,7 @@ require_relative "json_logging/formatter"
 require_relative "json_logging/formatter_with_tags"
 require_relative "json_logging/json_logger_extension"
 require_relative "json_logging/json_logger"
+require_relative "json_logging/event_subscriber"
 
 module JsonLogging
   THREAD_CONTEXT_KEY = :__json_logging_context

data/sig/json_logging.rbs

@@ -1,3 +1,8 @@
 module JsonLogging
   VERSION: String
+
+  class EventSubscriber
+    def initialize: (?logger: untyped, ?io: untyped) -> void
+    def emit: (untyped event) -> void
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activesupport-json_logging
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.3.0
 platform: ruby
 authors:
 - Andrei Makarov
@@ -15,7 +15,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
     - - "<"
       - !ruby/object:Gem::Version
         version: '9.0'
@@ -25,7 +25,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
     - - "<"
       - !ruby/object:Gem::Version
         version: '9.0'
@@ -35,7 +35,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
     - - "<"
       - !ruby/object:Gem::Version
         version: '9.0'
@@ -45,7 +45,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
     - - "<"
       - !ruby/object:Gem::Version
         version: '9.0'
@@ -316,7 +316,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.2'
 description: Lightweight JSON logger and formatter integrating with Rails/ActiveSupport.
-  No extra deps beyond Rails/Activesupport. Compatible with Rails 6–8.
+  No extra deps beyond Rails/Activesupport. Compatible with Rails 7–8.
 email:
 - contact@kiskolabs.com
 executables: []
@@ -329,6 +329,7 @@ files:
 - lib/activesupport/json_logging.rb
 - lib/activesupport/json_logging/railtie.rb
 - lib/json_logging.rb
+- lib/json_logging/event_subscriber.rb
 - lib/json_logging/formatter.rb
 - lib/json_logging/formatter_with_tags.rb
 - lib/json_logging/helpers.rb
@@ -357,14 +358,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.6
 specification_version: 4
 summary: Structured JSON logging for Rails/ActiveSupport with safe, single-line entries.
 test_files: []