Add Structured Event Reporter

Ref: rails#50452

This adds a Structured Event Reporter to Rails, accessible via `Rails.event`.
It allows you to report events to a subscriber, and provides mechanisms for adding tags and context to events.

Events encompass "structured logs", but also "business events", as well as telemetry events such as metrics
and logs. The Event Reporter is designed to be a single interface for producing any kind of event in a Rails
application.

We separate the emission of events from how these events reach end consumers; applications are expected to
define their own subscribers, and the Event Reporter is responsible for emitting events to these subscribers.

Author: adrianna-chang-shopify

actionpack/lib/action_dispatch.rb

@@ -70,6 +70,7 @@ class MissingController < NameError
     autoload :HostAuthorization
     autoload :RequestId
     autoload :Callbacks
+    autoload :ClearEventReporterContext
     autoload :Cookies
     autoload :ActionableExceptions
     autoload :DebugExceptions

actionpack/lib/action_dispatch/middleware/clear_event_reporter_context.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module ActionDispatch
+  # Middleware that sets up a callback on rack.response_finished to clear
+  # the EventReporter context when the response is finished. This ensures that
+  # context is cleared as late as possible in the request lifecycle.
+  class ClearEventReporterContext # :nodoc:
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      response = @app.call(env)
+
+      env["rack.response_finished"] ||= []
+      env["rack.response_finished"] << -> do
+        ActiveSupport.event_reporter.clear_context
+      end
+
+      response
+    rescue Exception => e
+      ActiveSupport.event_reporter.clear_context
+      raise e
+    end
+  end
+end

actionpack/test/dispatch/clear_event_reporter_context_test.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "abstract_unit"
+
+class ClearEventReporterContextTest < ActiveSupport::TestCase
+  def setup
+    @app = ->(env) { [200, {}, ["Hello"]] }
+    @middleware = ActionDispatch::ClearEventReporterContext.new(@app)
+    @reporter = ActiveSupport.event_reporter
+  end
+
+  test "clears event reporter context in response finished callback" do
+    @reporter.set_context(shop_id: 123)
+
+    env = {}
+    @middleware.call(env)
+
+    assert env["rack.response_finished"]
+    assert_equal 1, env["rack.response_finished"].length
+
+    env["rack.response_finished"].each(&:call)
+
+    assert_equal({}, @reporter.context)
+  end
+
+  test "clears event reporter context when exception is raised" do
+    @reporter.set_context(shop_id: 123)
+
+    exception_app = ->(env) { raise StandardError, "Test exception" }
+    exception_middleware = ActionDispatch::ClearEventReporterContext.new(exception_app)
+
+    env = {}
+    assert_raises(StandardError) do
+      exception_middleware.call(env)
+    end
+
+    assert_equal({}, @reporter.context)
+  end
+end

activejob/lib/active_job/railtie.rb

@@ -98,6 +98,16 @@ class Railtie < Rails::Railtie # :nodoc:
       end
     end
 
+    initializer "active_job.clear_event_reporter_context" do
+      ActiveSupport.on_load(:active_job) do
+        ActiveJob::Callbacks.singleton_class.set_callback(:execute, :around) do |_, inner|
+          inner.call
+        ensure
+          ActiveSupport.event_reporter.clear_context
+        end
+      end
+    end
+
     initializer "active_job.query_log_tags" do |app|
       query_logs_tags_enabled = app.config.respond_to?(:active_record) &&
         app.config.active_record.query_log_tags_enabled &&

activesupport/CHANGELOG.md

@@ -1,3 +1,39 @@
+*   Add Structured Event Reporter, accessible via `Rails.event`.
+
+    The Event Reporter provides a unified interface for producing structured events in Rails
+    applications:
+
+    ```ruby
+    Rails.event.notify("user.signup", user_id: 123, email: "[email protected]")
+    ```
+
+    It supports adding tags and context to events:
+
+    ```ruby
+    Rails.event.set_context(request_id: "abc123", shop_id: 456)
+    # All events will contain context: {request_id: "abc123", shop_id: 456}
+
+    Rails.event.tagged("graphql") do
+      Rails.event.notify("user.signup", user_id: 123, email: "[email protected]")
+    end
+    # Event includes tags: { graphql: true }
+    ```
+
+    Events are emitted to subscribers. Applications may register their own subscribers
+    to control how events are serialized and emitted.
+
+    ```ruby
+    class MySubscriber
+      def emit(event)
+        # Serialize event and export to logging platform
+      end
+    end
+
+    Rails.event.subscribe(MySubscriber.new)
+    ```
+
+    *Adrianna Chang*
+
 *   Given an array of `Thread::Backtrace::Location` objects, the new method
     `ActiveSupport::BacktraceCleaner#clean_locations` returns an array with the
     clean ones:

activesupport/lib/active_support.rb

@@ -47,6 +47,7 @@ module ActiveSupport
   autoload :ExecutionWrapper
   autoload :Executor
   autoload :ErrorReporter
+  autoload :EventReporter
   autoload :FileUpdateChecker
   autoload :EventedFileUpdateChecker
   autoload :ForkTracker
@@ -109,6 +110,9 @@ def self.eager_load!
   @error_reporter = ActiveSupport::ErrorReporter.new
   singleton_class.attr_accessor :error_reporter # :nodoc:
 
+  @event_reporter = ActiveSupport::EventReporter.new
+  singleton_class.attr_accessor :event_reporter # :nodoc:
+
   def self.cache_format_version
     Cache.format_version
   end