rails_band 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0252268a8e05795a32afaf52c744143ad84aa806d8b06fe45ff480572b4e3d12'
-  data.tar.gz: ae7ef45e64e0b645afe122d54da499274d5281f4182e7beb831b33ccd118c25a
+  metadata.gz: 84c17289076af2e04e037b011c18c6ff3d0206401b67c1e68354979410e545a7
+  data.tar.gz: 3133417c2eecf067f8e5f402a49b6143ee7e2944f92d95567289262c85af02ea
 SHA512:
-  metadata.gz: 8d077ace78ac6724596f894854076b6fb9d6863423452e1af2e9fd23be765247827f4e446b310fc2dcb8cdddb6c565453f7b3b7cd90d8b7714d5b634b207510f
-  data.tar.gz: be8704ee197bc96fce8ec5f68921cab394d7b96a77500a2e6a267d41cfd2e8a5a9efd310a345a6b5b2967033c4824cd39cb478f8467de83eb02eacfe674f1212
+  metadata.gz: 90f9b92421330c436f3968219be3a7ebf936d4b3b3a47f1906fdf3d1a9c65b4615fb2a3e6c8b76bdaa5f7dc2596c1e67d28f347bc5262420e66a72c69bdb087b
+  data.tar.gz: 5d852e1baafe0632013fede3b0278deb886f9cf0347848e3cb960b9e153c79096384bc9d8449b974cfbb7c54d576f2d13e60583e5b0be5993ec2a815ae8449ff

data/README.md

@@ -20,14 +20,15 @@ bundle
 ```
 
 Or install it yourself as:
+
 ```console
 gem install rails_band
 ```
 
 ## Usage
 
-rails_band automatically replaces each `LogSubscriber` with its own ones after it's loaded as a gem.
-And then, you should configure how to consume Instrumentation hooks from core Rails implementations like this:
+rails_band automatically replaces each `LogSubscriber` with its own ones after it's loaded as a gem. And then, you
+should configure how to consume Instrumentation hooks from core Rails implementations like this:
 
 ```ruby
 Rails.application.config.rails_band.consumers = ->(event) { Rails.logger.info(event.to_h) }
@@ -43,11 +44,124 @@ Rails.application.config.rails_band.consumers = {
 }
 ```
 
-Note `:default` is the fallback of other non-specific event names. Other events will be ignored without `:default`.
-In other words, you can consume only events that you want to really consume without `:default`.
+Note `:default` is the fallback of other non-specific event names. Other events will be ignored without `:default`. In
+other words, you can consume only events that you want to really consume without `:default`.
 
 rails_band does not limit you only to use logging purposes. Enjoy with Rails Instrumentation hooks!
 
+## Supported Instrumentation API hooks
+
+These are Rails Instrumentation API hooks supported by this gem so far.
+
+### Action Controller
+
+| Event name                                                                                                                                                | Supported |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- |
+| [`write_fragment.action_controller`](https://guides.rubyonrails.org/active_support_instrumentation.html#write-fragment-action-controller)                 | ✅        |
+| [`read_fragment.action_controller`](https://guides.rubyonrails.org/active_support_instrumentation.html#read-fragment-action-controller)                   | ✅        |
+| [`expire_fragment.action_controller`](https://guides.rubyonrails.org/active_support_instrumentation.html#expire-fragment-action-controller)               | ✅        |
+| [`exist_fragment?.action_controller`](https://guides.rubyonrails.org/active_support_instrumentation.html#exist-fragment-questionmark-action-controller)   | ✅        |
+| [`start_processing.action_controller`](https://guides.rubyonrails.org/active_support_instrumentation.html#start-processing-action-controller)             | ✅        |
+| [`process_action.action_controller`](https://guides.rubyonrails.org/active_support_instrumentation.html#process-action-action-controller)                 | ✅        |
+| [`send_file.action_controller`](https://guides.rubyonrails.org/active_support_instrumentation.html#send-file-action-controller)                           | ✅        |
+| [`send_data.action_controller`](https://guides.rubyonrails.org/active_support_instrumentation.html#send-data-action-controller)                           | ✅        |
+| [`redirect_to.action_controller`](https://guides.rubyonrails.org/active_support_instrumentation.html#redirect-to-action-controller)                       | ✅        |
+| [`halted_callback.action_controller`](https://guides.rubyonrails.org/active_support_instrumentation.html#halted-callback-action-controller)               | ✅        |
+| [`unpermitted_parameters.action_controller`](https://guides.rubyonrails.org/active_support_instrumentation.html#unpermitted-parameters-action-controller) | ✅        |
+
+### Action Dispatch
+
+| Event name                                                                                                                                    | Supported |
+| --------------------------------------------------------------------------------------------------------------------------------------------- | --------- |
+| [`process_middleware.action_dispatch`](https://guides.rubyonrails.org/active_support_instrumentation.html#process-middleware-action-dispatch) |           |
+
+### Action View
+
+| Event name                                                                                                                          | Supported |
+| ----------------------------------------------------------------------------------------------------------------------------------- | --------- |
+| [`render_template.action_view`](https://guides.rubyonrails.org/active_support_instrumentation.html#render-template-action-view)     | ✅        |
+| [`render_partial.action_view`](https://guides.rubyonrails.org/active_support_instrumentation.html#render-partial-action-view)       | ✅        |
+| [`render_collection.action_view`](https://guides.rubyonrails.org/active_support_instrumentation.html#render-collection-action-view) | ✅        |
+
+### Active Record
+
+| Event name                                                                                                                      | Supported |
+| ------------------------------------------------------------------------------------------------------------------------------- | --------- |
+| `strict_loading_violation.active_record` (Not yet documented. See the configuration of `action_on_strict_loading_violation`)    | ✅        |
+| [`sql.active_record`](https://guides.rubyonrails.org/active_support_instrumentation.html#sql-active-record)                     | ✅        |
+| [`instantiation.active_record`](https://guides.rubyonrails.org/active_support_instrumentation.html#instantiation-active-record) | ✅        |
+
+### Action Mailer
+
+| Event name                                                                                                          | Supported |
+| ------------------------------------------------------------------------------------------------------------------- | --------- |
+| [`deliver.action_mailer`](https://guides.rubyonrails.org/active_support_instrumentation.html#deliver-action-mailer) | ✅        |
+| [`process.action_mailer`](https://guides.rubyonrails.org/active_support_instrumentation.html#process-action-mailer) | ✅        |
+
+### Active Support
+
+| Event name                                                                                                                                  | Supported |
+| ------------------------------------------------------------------------------------------------------------------------------------------- | --------- |
+| [`cache_read.active_support`](https://guides.rubyonrails.org/active_support_instrumentation.html#cache-read-active-support)                 | ✅        |
+| `cache_read_multi.active_support` (Not yet documented)                                                                                      | ✅        |
+| [`cache_generate.active_support`](https://guides.rubyonrails.org/active_support_instrumentation.html#cache-generate-active-support)         | ✅        |
+| [`cache_fetch_hit.active_support`](https://guides.rubyonrails.org/active_support_instrumentation.html#cache-fetch-hit-active-support)       | ✅        |
+| [`cache_write.active_support`](https://guides.rubyonrails.org/active_support_instrumentation.html#cache-write-active-support)               | ✅        |
+| `cache_write_multi.active_support` (Not yet documented)                                                                                     | ✅        |
+| [`cache_delete.active_support`](https://guides.rubyonrails.org/active_support_instrumentation.html#cache-delete-active-support)             | ✅        |
+| `cache_delete_multi.active_support` (Not yet documented, supported since Rails 6.1)                                                         | ✅        |
+| [`cache_exist?.active_support`](https://guides.rubyonrails.org/active_support_instrumentation.html#cache-exist-questionmark-active-support) | ✅        |
+
+### Active Job
+
+| Event name                                                                                                                | Supported |
+| ------------------------------------------------------------------------------------------------------------------------- | --------- |
+| [`enqueue_at.active_job`](https://guides.rubyonrails.org/active_support_instrumentation.html#enqueue-at-active-job)       |           |
+| [`enqueue.active_job`](https://guides.rubyonrails.org/active_support_instrumentation.html#enqueue-active-job)             |           |
+| [`enqueue_retry.active_job`](https://guides.rubyonrails.org/active_support_instrumentation.html#enqueue-retry-active-job) |           |
+| [`perform_start.active_job`](https://guides.rubyonrails.org/active_support_instrumentation.html#perform-start-active-job) |           |
+| [`perform.active_job`](https://guides.rubyonrails.org/active_support_instrumentation.html#perform-active-job)             |           |
+| [`retry_stopped.active_job`](https://guides.rubyonrails.org/active_support_instrumentation.html#retry-stopped-active-job) |           |
+| [`discard.active_job`](https://guides.rubyonrails.org/active_support_instrumentation.html#discard-active-job)             |           |
+
+### Action Cable
+
+| Event name                                                                                                                                                              | Supported |
+| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- |
+| [`perform_action.action_cable`](https://guides.rubyonrails.org/active_support_instrumentation.html#perform-action-action-cable)                                         |           |
+| [`transmit.action_cable`](https://guides.rubyonrails.org/active_support_instrumentation.html#transmit-action-cable)                                                     |           |
+| [`transmit_subscription_confirmation.action_cable`](https://guides.rubyonrails.org/active_support_instrumentation.html#transmit-subscription-confirmation-action-cable) |           |
+| [`transmit_subscription_rejection.action_cable`](https://guides.rubyonrails.org/active_support_instrumentation.html#transmit-subscription-rejection-action-cable)       |           |
+| [`broadcast.action_cable`](https://guides.rubyonrails.org/active_support_instrumentation.html#broadcast-action-cable)                                                   |           |
+
+### Active Storage
+
+| Event name                                                                                                                                                  | Supported |
+| ----------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- |
+| [`service_upload.active_storage`](https://guides.rubyonrails.org/active_support_instrumentation.html#service-upload-active-storage)                         |           |
+| [`service_streaming_download.active_storage`](https://guides.rubyonrails.org/active_support_instrumentation.html#service-streaming-download-active-storage) |           |
+| [`service_download_chunk.active_storage`](https://guides.rubyonrails.org/active_support_instrumentation.html#service-download-chunk-active-storage)         |           |
+| [`service_download.active_storage`](https://guides.rubyonrails.org/active_support_instrumentation.html#service-download-active-storage)                     |           |
+| [`service_delete.active_storage`](https://guides.rubyonrails.org/active_support_instrumentation.html#service-delete-active-storage)                         |           |
+| [`service_delete_prefixed.active_storage`](https://guides.rubyonrails.org/active_support_instrumentation.html#service-delete-prefixed-active-storage)       |           |
+| [`service_exist.active_storage`](https://guides.rubyonrails.org/active_support_instrumentation.html#service-exist-active-storage)                           |           |
+| [`service_url.active_storage`](https://guides.rubyonrails.org/active_support_instrumentation.html#service-url-active-storage)                               |           |
+| [`service_update_metadata.active_storage`](https://guides.rubyonrails.org/active_support_instrumentation.html#service-update-metadata-active-storage)       |           |
+| [`preview.active_storage`](https://guides.rubyonrails.org/active_support_instrumentation.html#preview-active-storage)                                       |           |
+| [`analyze.active_storage`](https://edgeguides.rubyonrails.org/active_support_instrumentation.html#analyze-active-storage)                                   |           |
+
+### Railties
+
+| Event name                                                                                                                                | Supported |
+| ----------------------------------------------------------------------------------------------------------------------------------------- | --------- |
+| [`load_config_initializer.railties`](https://guides.rubyonrails.org/active_support_instrumentation.html#load-config-initializer-railties) |           |
+
+### Rails
+
+| Event name                                                                                                  | Supported |
+| ----------------------------------------------------------------------------------------------------------- | --------- |
+| [`deprecation.rails`](https://guides.rubyonrails.org/active_support_instrumentation.html#deprecation-rails) |           |
+
 ## Contributing
 
 Contributing is welcome 😄 Please open a pull request!

data/lib/rails_band/active_support/event/cache_delete.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module RailsBand
+  module ActiveSupport
+    module Event
+      # A wrapper for the event that is passed to `cache_delete.active_support`.
+      class CacheDelete < BaseEvent
+        def key
+          @key ||= @event.payload.fetch(:key)
+        end
+
+        if Gem::Version.new(Rails.version) >= Gem::Version.new('6.1')
+          define_method(:store) do
+            @store ||= @event.payload.fetch(:store)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rails_band/active_support/event/cache_delete_multi.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module RailsBand
+  module ActiveSupport
+    module Event
+      # A wrapper for the event that is passed to `cache_delete_multi.active_support`.
+      class CacheDeleteMulti < BaseEvent
+        def key
+          @key ||= @event.payload.fetch(:key)
+        end
+
+        if Gem::Version.new(Rails.version) >= Gem::Version.new('6.1')
+          define_method(:store) do
+            @store ||= @event.payload.fetch(:store)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rails_band/active_support/event/cache_exist.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module RailsBand
+  module ActiveSupport
+    module Event
+      # A wrapper for the event that is passed to `cache_exist?.active_support`.
+      class CacheExist < BaseEvent
+        def key
+          @key ||= @event.payload.fetch(:key)
+        end
+
+        if Gem::Version.new(Rails.version) >= Gem::Version.new('6.1')
+          define_method(:store) do
+            @store ||= @event.payload.fetch(:store)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rails_band/active_support/event/cache_fetch_hit.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module RailsBand
+  module ActiveSupport
+    module Event
+      # A wrapper for the event that is passed to `cache_fetch_hit.active_support`.
+      class CacheFetchHit < BaseEvent
+        def key
+          @key ||= @event.payload.fetch(:key)
+        end
+
+        if Gem::Version.new(Rails.version) >= Gem::Version.new('6.1')
+          define_method(:store) do
+            @store ||= @event.payload.fetch(:store)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rails_band/active_support/event/cache_generate.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module RailsBand
+  module ActiveSupport
+    module Event
+      # A wrapper for the event that is passed to `cache_generate.active_support`.
+      class CacheGenerate < BaseEvent
+        def key
+          @key ||= @event.payload.fetch(:key)
+        end
+
+        if Gem::Version.new(Rails.version) >= Gem::Version.new('6.1')
+          define_method(:store) do
+            @store ||= @event.payload.fetch(:store)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rails_band/active_support/event/cache_read.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module RailsBand
+  module ActiveSupport
+    module Event
+      # A wrapper for the event that is passed to `cache_read.active_support`.
+      class CacheRead < BaseEvent
+        def key
+          @key ||= @event.payload.fetch(:key)
+        end
+
+        if Gem::Version.new(Rails.version) >= Gem::Version.new('6.1')
+          define_method(:store) do
+            @store ||= @event.payload.fetch(:store)
+          end
+        end
+
+        def hit
+          return @hit if defined? @hit
+
+          @hit = @event.payload[:hit]
+        end
+
+        def super_operation
+          return @super_operation if defined? @super_operation
+
+          @super_operation = @event.payload[:super_operation]
+        end
+      end
+    end
+  end
+end

data/lib/rails_band/active_support/event/cache_read_multi.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module RailsBand
+  module ActiveSupport
+    module Event
+      # A wrapper for the event that is passed to `cache_read_multi.active_support`.
+      class CacheReadMulti < BaseEvent
+        def key
+          @key ||= @event.payload.fetch(:key)
+        end
+
+        if Gem::Version.new(Rails.version) >= Gem::Version.new('6.1')
+          define_method(:store) do
+            @store ||= @event.payload.fetch(:store)
+          end
+        end
+
+        def hits
+          @hits ||= @event.payload[:hits] || []
+        end
+
+        def super_operation
+          return @super_operation if defined? @super_operation
+
+          @super_operation = @event.payload[:super_operation]
+        end
+      end
+    end
+  end
+end

data/lib/rails_band/active_support/event/cache_write.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module RailsBand
+  module ActiveSupport
+    module Event
+      # A wrapper for the event that is passed to `cache_write.active_support`.
+      class CacheWrite < BaseEvent
+        def key
+          @key ||= @event.payload.fetch(:key)
+        end
+
+        if Gem::Version.new(Rails.version) >= Gem::Version.new('6.1')
+          define_method(:store) do
+            @store ||= @event.payload.fetch(:store)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rails_band/active_support/event/cache_write_multi.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module RailsBand
+  module ActiveSupport
+    module Event
+      # A wrapper for the event that is passed to `cache_write_multi.active_support`.
+      class CacheWriteMulti < BaseEvent
+        def key
+          @key ||= @event.payload.fetch(:key)
+        end
+
+        if Gem::Version.new(Rails.version) >= Gem::Version.new('6.1')
+          define_method(:store) do
+            @store ||= @event.payload.fetch(:store)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rails_band/active_support/log_subscriber.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'rails_band/active_support/event/cache_read'
+require 'rails_band/active_support/event/cache_read_multi'
+require 'rails_band/active_support/event/cache_generate'
+require 'rails_band/active_support/event/cache_fetch_hit'
+require 'rails_band/active_support/event/cache_write'
+require 'rails_band/active_support/event/cache_write_multi'
+require 'rails_band/active_support/event/cache_delete'
+require 'rails_band/active_support/event/cache_delete_multi'
+require 'rails_band/active_support/event/cache_exist'
+
+module RailsBand
+  module ActiveSupport
+    # The custom LogSubscriber for ActiveSupport.
+    class LogSubscriber < ::ActiveSupport::LogSubscriber
+      mattr_accessor :consumers
+
+      def cache_read(event)
+        consumer_of(__method__)&.call(Event::CacheRead.new(event))
+      end
+
+      def cache_read_multi(event)
+        consumer_of(__method__)&.call(Event::CacheReadMulti.new(event))
+      end
+
+      def cache_generate(event)
+        consumer_of(__method__)&.call(Event::CacheGenerate.new(event))
+      end
+
+      def cache_fetch_hit(event)
+        consumer_of(__method__)&.call(Event::CacheFetchHit.new(event))
+      end
+
+      def cache_write(event)
+        consumer_of(__method__)&.call(Event::CacheWrite.new(event))
+      end
+
+      def cache_write_multi(event)
+        consumer_of(__method__)&.call(Event::CacheWriteMulti.new(event))
+      end
+
+      def cache_delete(event)
+        consumer_of(__method__)&.call(Event::CacheDelete.new(event))
+      end
+
+      def cache_delete_multi(event)
+        consumer_of(__method__)&.call(Event::CacheDeleteMulti.new(event))
+      end
+
+      def cache_exist?(event)
+        consumer_of(__method__)&.call(Event::CacheExist.new(event))
+      end
+
+      private
+
+      def consumer_of(sub_event)
+        consumers[:"#{sub_event}.active_support"] || consumers[:active_support] || consumers[:default]
+      end
+    end
+  end
+end

data/lib/rails_band/railtie.rb

@@ -29,6 +29,8 @@ module RailsBand
         require 'action_mailer/log_subscriber'
         swap.call(::ActionMailer::LogSubscriber, RailsBand::ActionMailer::LogSubscriber, :action_mailer)
       end
+
+      RailsBand::ActiveSupport::LogSubscriber.attach_to :active_support
     end
   end
 end

data/lib/rails_band/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsBand
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/lib/rails_band.rb

@@ -23,4 +23,8 @@ module RailsBand
   module ActionMailer
     autoload :LogSubscriber, 'rails_band/action_mailer/log_subscriber'
   end
+
+  module ActiveSupport
+    autoload :LogSubscriber, 'rails_band/active_support/log_subscriber'
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_band
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Yutaka Kamei
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-01 00:00:00.000000000 Z
+date: 2021-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -59,6 +59,16 @@ files:
 - lib/rails_band/active_record/event/sql.rb
 - lib/rails_band/active_record/event/strict_loading_violation.rb
 - lib/rails_band/active_record/log_subscriber.rb
+- lib/rails_band/active_support/event/cache_delete.rb
+- lib/rails_band/active_support/event/cache_delete_multi.rb
+- lib/rails_band/active_support/event/cache_exist.rb
+- lib/rails_band/active_support/event/cache_fetch_hit.rb
+- lib/rails_band/active_support/event/cache_generate.rb
+- lib/rails_band/active_support/event/cache_read.rb
+- lib/rails_band/active_support/event/cache_read_multi.rb
+- lib/rails_band/active_support/event/cache_write.rb
+- lib/rails_band/active_support/event/cache_write_multi.rb
+- lib/rails_band/active_support/log_subscriber.rb
 - lib/rails_band/base_event.rb
 - lib/rails_band/configuration.rb
 - lib/rails_band/railtie.rb