rails_api_logger 0.11.1 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c60034742e7231e4a31d581dc71a67eb3826aa4702e0ff284c62ca74d477720
-  data.tar.gz: fb275befe7ec034fbe2cb00c55916c1836887d1a39b7195433fa7587e2692be9
+  metadata.gz: 876eed123167d23e2eb7b6985b88633ac310e51fbc6322e0c0697bc391979173
+  data.tar.gz: 0abcc58ce8bd138c7497b30671283dec800740377aa11c83a6de79865720c82c
 SHA512:
-  metadata.gz: 89ae643a486c5dda07badee17bfd01a226dda46ffdcc8d68638ea4ba36f3403439adb11cc1ee8b2cd5f91e59595ee34ebf199607d3d2a5a8569bafc39e3610f2
-  data.tar.gz: da1059a513f47d89fee5cc48ed1431c8b9f0c685fc55e09931378b0b4a880440ed936bebc6133399da1cfa652f98dda6acb1f37a53f644baa13cf2e9581fdf21
+  metadata.gz: dd4a44520b68a7b670c667d1d0783b2726f32603d4d738850e3da5da9abd7ed9799b7190cbe38e21efada2c642becccf215e7c90ede41d3613d74578a0ddf802
+  data.tar.gz: a130063a418cf202c6715bedac8d3c6298fa673272dd1153a6cbaf3e0d3e7a407cc667dab41109cada36ce6cb156e22d70729223ae5e5eb9c7fb8f18f61b85d2

data/.ruby-version

@@ -1 +1 @@
-3.2.9
+3.2.11

data/CHANGELOG.md

@@ -1,10 +1,25 @@
+# 0.12.0
+
+* Add `client_reference` column to both `inbound_request_logs` and `outbound_request_logs`. This is a free-form
+  indexed string you can set on a log entry to correlate it with any external identifier (similar in spirit to
+  `loggable`, but without a polymorphic association).
+    * For outbound requests, pass it to the logger: `RailsApiLogger::Logger.new(client_reference: "abc-123")`.
+    * For inbound requests, call `attach_inbound_request_client_reference("abc-123")` from your controller.
+
+To upgrade an existing app, run:
+
+```
+bin/rails g rails_api_logger:upgrade_client_reference
+bin/rails db:migrate
+```
+
 # 0.11.1
 
 * Remove deprecated "require_dependency"
 
 # 0.11.0
 
-* Fix stack trace to deep in webrick
+* Fix stack trace too deep in webrick
 * Fixes for Rails < 7.1
 * Support custom primary key types in migration template
 

data/README.md

@@ -174,6 +174,29 @@ to be able to access the inbound logs attached to the model.
 
 You also have `has_many_outbound_request_logs` and `has_many_request_logs` that includes both.
 
+### Client reference
+
+Both `inbound_request_logs` and `outbound_request_logs` have a `client_reference` column: a free-form indexed
+string you can set on a log entry to correlate it with any external identifier (e.g. a request id coming from an
+upstream system, an idempotency key, a tenant slug). It is independent from the `loggable` polymorphic association.
+
+For inbound requests, attach it from your controller:
+
+```ruby
+def create
+  attach_inbound_request_client_reference(request.headers["X-Request-Id"])
+  # ...
+end
+```
+
+For outbound requests, pass it when instantiating the logger:
+
+```ruby
+RailsApiLogger::Logger.new(client_reference: "ref-abc").call(uri, request) do
+  http.request(request)
+end
+```
+
 ## RailsAdmin integration
 
 We provide here some code samples to integrate the models in [RailsAdmin](https://github.com/sferik/rails_admin).

data/app/controllers/inbound_requests_logger.rb

@@ -7,4 +7,9 @@ module InboundRequestsLogger
     return unless request.env["INBOUND_REQUEST_LOG"].present?
     request.env["INBOUND_REQUEST_LOG"].update(loggable: loggable) if loggable&.persisted?
   end
+
+  def attach_inbound_request_client_reference(client_reference)
+    return unless request.env["INBOUND_REQUEST_LOG"].present?
+    request.env["INBOUND_REQUEST_LOG"].update(client_reference: client_reference)
+  end
 end

data/app/models/rails_api_logger/logger.rb

@@ -1,13 +1,15 @@
 module RailsApiLogger
   class Logger
-    def initialize(loggable = nil, skip_request_body: false, skip_response_body: false)
+    def initialize(loggable = nil, client_reference: nil, skip_request_body: false, skip_response_body: false)
       @loggable = loggable
+      @client_reference = client_reference
       @skip_request_body = skip_request_body
       @skip_response_body = skip_response_body
     end
 
     def call(url, request)
-      log = OutboundRequestLog.from_request(request, loggable: @loggable, skip_request_body: @skip_request_body)
+      log = OutboundRequestLog.from_request(request, loggable: @loggable, client_reference: @client_reference,
+        skip_request_body: @skip_request_body)
       yield.tap do |response|
         log.from_response(response, skip_response_body: @skip_response_body)
       end

data/app/models/rails_api_logger/request_log.rb

@@ -19,7 +19,7 @@ module RailsApiLogger
     validates :method, presence: true
     validates :path, presence: true
 
-    def self.from_request(request, loggable: nil, skip_request_body: false)
+    def self.from_request(request, loggable: nil, client_reference: nil, skip_request_body: false)
       if skip_request_body
         body = "[Skipped]"
       else
@@ -31,7 +31,8 @@ module RailsApiLogger
           body
         end
       end
-      create(path: request.path, request_body: body, method: request.method, started_at: Time.current, loggable: loggable)
+      create(path: request.path, request_body: body, method: request.method, started_at: Time.current,
+        loggable: loggable, client_reference: client_reference)
     end
 
     def from_response(response, skip_response_body: false)

data/lib/generators/rails_api_logger/upgrade_client_reference_generator.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "rails/generators/base"
+require "rails/generators/migration"
+
+module RailsApiLogger
+  module Generators
+    class UpgradeClientReferenceGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      source_root File.expand_path("../../templates", __FILE__)
+
+      def self.next_migration_number(dirname)
+        next_migration_number = current_migration_number(dirname) + 1
+        ActiveRecord::Migration.next_migration_number(next_migration_number)
+      end
+
+      desc "Add the client_reference column to the rails_api_logger tables."
+      def copy_migration
+        migration_template "add_client_reference_to_rails_api_logger_tables.rb",
+          "db/migrate/add_client_reference_to_rails_api_logger_tables.rb"
+      end
+    end
+  end
+end

data/lib/generators/templates/add_client_reference_to_rails_api_logger_tables.rb.tt

@@ -0,0 +1,9 @@
+class AddClientReferenceToRailsApiLoggerTables < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+  def change
+    add_column :inbound_request_logs, :client_reference, :string
+    add_index :inbound_request_logs, :client_reference
+
+    add_column :outbound_request_logs, :client_reference, :string
+    add_index :outbound_request_logs, :client_reference
+  end
+end

data/lib/generators/templates/create_rails_api_logger_table.rb.tt

@@ -10,6 +10,7 @@ class CreateRailsApiLoggerTable < ActiveRecord::Migration[<%= ActiveRecord::Migr
       t.timestamp :started_at
       t.timestamp :ended_at
       t.references :loggable, index: true, polymorphic: true<%= ", type: :#{pk_type}" if pk_type %>
+      t.string :client_reference, index: true
       t.timestamps null: false
     end
 
@@ -22,6 +23,7 @@ class CreateRailsApiLoggerTable < ActiveRecord::Migration[<%= ActiveRecord::Migr
       t.timestamp :started_at
       t.timestamp :ended_at
       t.references :loggable, index: true, polymorphic: true<%= ", type: :#{pk_type}" if pk_type %>
+      t.string :client_reference, index: true
       t.timestamps null: false
     end
   end

data/lib/rails_api_logger/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsApiLogger
-  VERSION = "0.11.1"
+  VERSION = "0.12.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_api_logger
 version: !ruby/object:Gem::Version
-  version: 0.11.1
+  version: 0.12.0
 platform: ruby
 authors:
 - Alessandro Rodi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-11-26 00:00:00.000000000 Z
+date: 2026-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -234,6 +234,8 @@ files:
 - gemfiles/rails_webrick_8.0.gemfile
 - gemfiles/rails_webrick_8.0.gemfile.lock
 - lib/generators/rails_api_logger/install_generator.rb
+- lib/generators/rails_api_logger/upgrade_client_reference_generator.rb
+- lib/generators/templates/add_client_reference_to_rails_api_logger_tables.rb.tt
 - lib/generators/templates/create_rails_api_logger_table.rb.tt
 - lib/rails_api_logger.rb
 - lib/rails_api_logger/engine.rb
@@ -261,7 +263,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: "Log API requests like a king \U0001F451"