rails_audit_log 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb6120f7ce9f0f2a2fb19553a77ff4c6bf5c24a1945270e2e6393403b9ffc3a0
-  data.tar.gz: a978f7082c30a68c37344e0b819af1e70d077b3092337c5ea31c4e35473ffef6
+  metadata.gz: 9e3de1e31a64d33c94042ea45ff4eeb391d48cc65db934bf7b7256656326c480
+  data.tar.gz: e34d558b4687f61336af9a7f7e6ae3faebe6ea77533e7da8e360d27dbfc70060
 SHA512:
-  metadata.gz: 8670a4ceb147508b45d03679eb3765c6984393c144434f4ad90b40bf69c64478ff8b92b0ab3bdb0b054cb0f64d2794f05044d546f81fa2fde17496ff65fde4de
-  data.tar.gz: 5ba060114539abc8555a5873aa7671c226cdc2c19a3bd66a4549595f68ea170372a968de324485dc0bf2eabb0bd253fa14e5c14c98b7b4ad9fe691bc15973fbb
+  metadata.gz: cd8d51146c5b915b5c00cc863f23cffc70066cf4cfaafc5e667e9b064b225168b71f45d5699199ba37de78f0089cebabb8a1707f6f837642c32b0fb73c290a6c
+  data.tar.gz: 3abf1d5c1894de5496a76b8827eb23f6f8b430e9a4a192505e1012a3be022cf01290b5ef38cc3d9b43e2e4dc5f46c2e2667fdd77015ce0dfb111fab6141530b5

data/README.md

@@ -27,6 +27,7 @@ Audit logging for Rails. Tracks `create`, `update`, and `destroy` events as stru
   - [Scheduled and manual pruning](#scheduled-and-manual-pruning)
   - [Encrypting audit data](#encrypting-audit-data)
   - [Multi-tenancy](#multi-tenancy)
+  - [Event streaming](#event-streaming)
   - [Selective tracking](#selective-tracking)
   - [Disabling auditing](#disabling-auditing)
   - [Object reconstruction](#object-reconstruction)
@@ -477,6 +478,82 @@ RailsAuditLog.acts_as_tenant!
 
 This is equivalent to `RailsAuditLog.current_tenant { ActsAsTenant.current_tenant&.id }`.
 
+### Event streaming
+
+Publish every audit entry to an external consumer as it is written. Set any object implementing `#publish(entry)` as the adapter:
+
+```ruby
+# config/initializers/rails_audit_log.rb
+RailsAuditLog.streaming_adapter = RailsAuditLog::Streaming::NotificationsAdapter.new
+```
+
+#### NotificationsAdapter (built-in, zero dependencies)
+
+Publishes `rails_audit_log.entry_created` synchronously via `ActiveSupport::Notifications`:
+
+```ruby
+ActiveSupport::Notifications.subscribe("rails_audit_log.entry_created") do |*, payload|
+  entry = payload[:entry]
+  Rails.logger.info "Audit: #{entry.event} #{entry.item_type}##{entry.item_id}"
+end
+```
+
+#### ActiveJobAdapter (async)
+
+Enqueues `PublishEntryJob` so publishing does not block the request. The job fires the same `rails_audit_log.entry_created` notification when performed:
+
+```ruby
+RailsAuditLog.streaming_adapter = RailsAuditLog::Streaming::ActiveJobAdapter.new
+# or with a custom queue:
+RailsAuditLog.streaming_adapter = RailsAuditLog::Streaming::ActiveJobAdapter.new(queue: :streaming)
+```
+
+#### Custom adapters
+
+Any object implementing `#publish(entry)` works — no companion gem needed for Kafka, SQS, or any other transport:
+
+```ruby
+# Kafka via WaterDrop
+class KafkaAuditAdapter
+  def initialize(producer: WaterDrop::SyncProducer)
+    @producer = producer
+  end
+
+  def publish(entry)
+    @producer.call(entry.attributes.to_json, topic: "audit_log")
+  end
+end
+
+RailsAuditLog.streaming_adapter = KafkaAuditAdapter.new
+```
+
+```ruby
+# SQS via aws-sdk-sqs
+class SqsAuditAdapter
+  def initialize(queue_url:, client: Aws::SQS::Client.new)
+    @queue_url = queue_url
+    @client    = client
+  end
+
+  def publish(entry)
+    @client.send_message(
+      queue_url:    @queue_url,
+      message_body: entry.attributes.to_json
+    )
+  end
+end
+
+RailsAuditLog.streaming_adapter = SqsAuditAdapter.new(
+  queue_url: ENV.fetch("AUDIT_SQS_URL")
+)
+```
+
+Wrap the adapter in `ActiveJobAdapter` if you want publishing to be asynchronous and not block the request thread.
+
+#### Batch mode
+
+`batch_audit` flushes the bulk `INSERT` first, then calls `#publish` for each entry individually — streaming consumers receive every entry even in batch mode.
+
 ### Selective tracking
 
 Track only specific attributes, or exclude noisy ones:

data/app/concerns/rails_audit_log/auditable.rb

@@ -234,8 +234,9 @@ module RailsAuditLog
         period = self.class._audit_log_retain_for || RailsAuditLog.retention_period
         WriteAuditLogJob.perform_later(entry_attrs.stringify_keys, version_limit: limit, retention_period: period)
       else
-        RailsAuditLog::AuditLogEntry.create!(entry_attrs)
+        entry = RailsAuditLog::AuditLogEntry.create!(entry_attrs)
         prune_audit_entries
+        RailsAuditLog.publish_entry(entry)
       end
     end
 

data/app/jobs/rails_audit_log/streaming/publish_entry_job.rb

@@ -0,0 +1,13 @@
+module RailsAuditLog
+  module Streaming
+    class PublishEntryJob < ApplicationJob
+      def perform(entry_attrs)
+        entry = AuditLogEntry.new(entry_attrs)
+        ActiveSupport::Notifications.instrument(
+          NotificationsAdapter::EVENT,
+          entry: entry
+        )
+      end
+    end
+  end
+end

data/app/jobs/rails_audit_log/write_audit_log_job.rb

@@ -1,7 +1,8 @@
 module RailsAuditLog
   class WriteAuditLogJob < ApplicationJob
     def perform(entry_attrs, version_limit: nil, retention_period: nil)
-      AuditLogEntry.create!(entry_attrs)
+      entry = AuditLogEntry.create!(entry_attrs)
+      RailsAuditLog.publish_entry(entry)
 
       item_type = entry_attrs["item_type"]
       item_id   = entry_attrs["item_id"]

data/lib/rails_audit_log/streaming/active_job_adapter.rb

@@ -0,0 +1,25 @@
+module RailsAuditLog
+  module Streaming
+    # Publishes each audit entry asynchronously by enqueuing
+    # {RailsAuditLog::Streaming::PublishEntryJob}. The job fires a
+    # +rails_audit_log.entry_created+ notification when performed, so subscribers
+    # receive the entry out-of-band without blocking the request.
+    #
+    # @example
+    #   RailsAuditLog.streaming_adapter = RailsAuditLog::Streaming::ActiveJobAdapter.new
+    #
+    #   # Custom queue:
+    #   RailsAuditLog.streaming_adapter = RailsAuditLog::Streaming::ActiveJobAdapter.new(queue: :streaming)
+    class ActiveJobAdapter
+      def initialize(queue: nil)
+        @queue = queue
+      end
+
+      def publish(entry)
+        job = RailsAuditLog::Streaming::PublishEntryJob
+        job = job.set(queue: @queue) if @queue
+        job.perform_later(entry.attributes.compact)
+      end
+    end
+  end
+end

data/lib/rails_audit_log/streaming/notifications_adapter.rb

@@ -0,0 +1,21 @@
+module RailsAuditLog
+  module Streaming
+    # Publishes each audit entry synchronously via +ActiveSupport::Notifications+.
+    # Zero external dependencies — subscribe with +ActiveSupport::Notifications.subscribe+.
+    #
+    # @example
+    #   RailsAuditLog.streaming_adapter = RailsAuditLog::Streaming::NotificationsAdapter.new
+    #
+    #   ActiveSupport::Notifications.subscribe("rails_audit_log.entry_created") do |*, payload|
+    #     entry = payload[:entry]
+    #     Rails.logger.info "Audit: #{entry.event} on #{entry.item_type}##{entry.item_id}"
+    #   end
+    class NotificationsAdapter
+      EVENT = "rails_audit_log.entry_created"
+
+      def publish(entry)
+        ActiveSupport::Notifications.instrument(EVENT, entry: entry)
+      end
+    end
+  end
+end

data/lib/rails_audit_log/version.rb

@@ -1,3 +1,3 @@
 module RailsAuditLog
-  VERSION = "1.3.0"
+  VERSION = "1.4.0"
 end

data/lib/rails_audit_log.rb

@@ -1,5 +1,7 @@
 require "rails_audit_log/version"
 require "rails_audit_log/engine"
+require "rails_audit_log/streaming/notifications_adapter"
+require "rails_audit_log/streaming/active_job_adapter"
 
 # RailsAuditLog is a Rails engine that tracks ActiveRecord +create+, +update+,
 # and +destroy+ events as {AuditLogEntry} records with JSON-first storage and
@@ -90,6 +92,15 @@ module RailsAuditLog
   # @return [Integer]
   mattr_accessor :page_size, default: 25
 
+  # The active streaming adapter. Any object implementing +#publish(entry)+.
+  # Called after every audit entry is persisted, including batch writes.
+  # Set to +nil+ (default) to disable streaming.
+  #
+  # @return [#publish, nil]
+  # @example
+  #   RailsAuditLog.streaming_adapter = RailsAuditLog::Streaming::NotificationsAdapter.new
+  mattr_accessor :streaming_adapter, default: nil
+
   # Controls how an actor object is serialised into the +whodunnit_snapshot+
   # string column. Defaults to +actor.name+ when available, otherwise +to_s+.
   #
@@ -143,6 +154,16 @@ module RailsAuditLog
     current_tenant { ActsAsTenant.current_tenant&.id }
   end
 
+  # Passes +entry+ to the configured {.streaming_adapter} if one is set.
+  # No-ops when no adapter is configured.
+  #
+  # @api private
+  # @param entry [AuditLogEntry]
+  # @return [void]
+  def self.publish_entry(entry)
+    streaming_adapter&.publish(entry)
+  end
+
   # Sets or returns the authentication block used to gate the web dashboard.
   # The block is evaluated in controller context, so controller helpers
   # (e.g. +current_user+) are available directly.
@@ -273,7 +294,10 @@ module RailsAuditLog
     begin
       result = yield
       batch = Thread.current[:rails_audit_log_batch]
-      AuditLogEntry.insert_all!(batch) if batch.any?
+      if batch.any?
+        AuditLogEntry.insert_all!(batch)
+        batch.each { |attrs| publish_entry(AuditLogEntry.new(attrs)) } if streaming_adapter
+      end
       result
     ensure
       Thread.current[:rails_audit_log_batch] = nil

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_audit_log
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Chuck Smith
@@ -99,6 +99,7 @@ files:
 - app/javascript/rails_audit_log/search_controller.js
 - app/jobs/rails_audit_log/application_job.rb
 - app/jobs/rails_audit_log/prune_audit_log_job.rb
+- app/jobs/rails_audit_log/streaming/publish_entry_job.rb
 - app/jobs/rails_audit_log/write_audit_log_job.rb
 - app/models/rails_audit_log/application_record.rb
 - app/models/rails_audit_log/audit_log_entry.rb
@@ -125,6 +126,8 @@ files:
 - lib/rails_audit_log/matchers.rb
 - lib/rails_audit_log/minitest_assertions.rb
 - lib/rails_audit_log/paper_trail_compat.rb
+- lib/rails_audit_log/streaming/active_job_adapter.rb
+- lib/rails_audit_log/streaming/notifications_adapter.rb
 - lib/rails_audit_log/test_helpers.rb
 - lib/rails_audit_log/version.rb
 - lib/tasks/rails_audit_log_tasks.rake