rails_band 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 97783d31ff40a28fa21181d954f365769bfcaf03a08557572363d90399e32347
+  data.tar.gz: 9e32469800f4a9b9e818e928283278975fd50408f24bee7d0241a7018e86e1f6
+SHA512:
+  metadata.gz: e63696203569e2126281fa79e7ec42ad4c8a09fdd04597eb41ae73cc1fd98b977776513e4f701304a8eb58a1597cb5940f2f920b3fe683c8df7262bc40adfffe
+  data.tar.gz: f267534e31f135a5a216eab5e41a0298f4b59c9ba17f4a683fb212bb1d10bf8eb2e024646fae669e16b315399a0e412f814dbd7d432222b60a2e6345b44fa0c5

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Yutaka Kamei
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,54 @@
+# rails_band
+
+Easy-to-use Rails Instrumentation API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails_band'
+```
+
+And then execute:
+
+```console
+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:
+
+```ruby
+Rails.application.config.rails_band.consumers = ->(event) { Rails.logger.info(event.to_h) }
+```
+
+You can also configure it by specifying event names:
+
+```ruby
+Rails.application.config.rails_band.consumers = {
+  default: ->(event) { Rails.logger.info(event.to_h) },
+  action_controller: ->(event) { Rails.logger.info(event.slice(:name, :method, :path, :status, :controller, :action)) },
+  'sql.active_record': ->(event) { Rails.logger.debug("#{event.sql_name}: #{event.sql}") },
+}
+```
+
+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!
+
+## Contributing
+
+Contributing is welcome 😄 Please open a pull request!
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/rails_band/action_controller/event/exist_fragment.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module RailsBand
+  module ActionController
+    module Event
+      # A wrapper for the event that is passed to `exist_fragment?.action_controller`.
+      class ExistFragment < BaseEvent
+        def key
+          @key ||= @event.payload.fetch(:key)
+        end
+      end
+    end
+  end
+end

data/lib/rails_band/action_controller/event/expire_fragment.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module RailsBand
+  module ActionController
+    module Event
+      # A wrapper for the event that is passed to `expire_fragment.action_controller`.
+      class ExpireFragment < BaseEvent
+        def key
+          @key ||= @event.payload.fetch(:key)
+        end
+      end
+    end
+  end
+end

data/lib/rails_band/action_controller/event/halted_callback.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module RailsBand
+  module ActionController
+    module Event
+      # A wrapper for the event that is passed to `halted_callback.action_controller`.
+      class HaltedCallback < BaseEvent
+        def filter
+          @filter ||= @event.payload.fetch(:filter)
+        end
+      end
+    end
+  end
+end

data/lib/rails_band/action_controller/event/process_action.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module RailsBand
+  module ActionController
+    module Event
+      # A wrapper for the event that is passed to `process_action.action_controller`.
+      class ProcessAction < BaseEvent
+        def controller
+          @controller ||= @event.payload.fetch(:controller)
+        end
+
+        def action
+          @action ||= @event.payload.fetch(:action)
+        end
+
+        def params
+          @params ||= @event.payload.fetch(:params).except(*INTERNAL_PARAMS)
+        end
+
+        def headers
+          @headers ||= @event.payload.fetch(:headers)
+        end
+
+        def format
+          @format ||= @event.payload.fetch(:format)
+        end
+
+        def method
+          @method ||= @event.payload.fetch(:method)
+        end
+
+        def path
+          @path ||= @event.payload.fetch(:path).split('?', 2).first
+        end
+
+        def status
+          @status ||=
+            begin
+              status = @event.payload[:status]
+
+              if status.nil? && (exception_class_name = @event.payload[:exception]&.first)
+                status = ::ActionDispatch::ExceptionWrapper.status_code_for_exception(exception_class_name)
+              end
+              status
+            end
+        end
+
+        def view_runtime
+          @view_runtime ||= @event.payload.fetch(:view_runtime)
+        end
+
+        if Gem::Version.new(Rails.version) >= Gem::Version.new('6.1')
+          define_method(:request) do
+            @request ||= @event.payload[:request]
+          end
+        end
+
+        if Gem::Version.new(Rails.version) >= Gem::Version.new('6.1')
+          define_method(:response) do
+            @response ||= @event.payload[:response]
+          end
+        end
+
+        def db_runtime
+          return @db_runtime if defined? @db_runtime
+
+          @db_runtime = @event.payload[:db_runtime]
+        end
+      end
+    end
+  end
+end

data/lib/rails_band/action_controller/event/read_fragment.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module RailsBand
+  module ActionController
+    module Event
+      # A wrapper for the event that is passed to `read_fragment.action_controller`.
+      class ReadFragment < BaseEvent
+        def key
+          @key ||= @event.payload.fetch(:key)
+        end
+      end
+    end
+  end
+end

data/lib/rails_band/action_controller/event/redirect_to.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module RailsBand
+  module ActionController
+    module Event
+      # A wrapper for the event that is passed to `redirect_to.action_controller`.
+      class RedirectTo < BaseEvent
+        def status
+          @status ||= @event.payload.fetch(:status)
+        end
+
+        def location
+          @location ||= @event.payload.fetch(:location)
+        end
+
+        if Gem::Version.new(Rails.version) >= Gem::Version.new('6.1')
+          define_method(:request) do
+            @request ||= @event.payload[:request]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rails_band/action_controller/event/send_data.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module RailsBand
+  module ActionController
+    module Event
+      # A wrapper for the event that is passed to `send_data.action_controller`.
+      class SendData < BaseEvent
+        def filename
+          return @filename if defined? @filename
+
+          @filename = @event.payload[:filename]
+        end
+
+        def type
+          return @type if defined? @type
+
+          @type = @event.payload[:type]
+        end
+
+        def disposition
+          return @disposition if defined? @disposition
+
+          @disposition = @event.payload[:disposition]
+        end
+
+        def status
+          return @status if defined? @status
+
+          @status = @event.payload[:status]
+        end
+      end
+    end
+  end
+end

data/lib/rails_band/action_controller/event/send_file.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module RailsBand
+  module ActionController
+    module Event
+      # A wrapper for the event that is passed to `send_file.action_controller`.
+      class SendFile < BaseEvent
+        def path
+          @path ||= @event.payload.fetch(:path)
+        end
+
+        def filename
+          return @filename if defined? @filename
+
+          @filename = @event.payload[:filename]
+        end
+
+        def type
+          return @type if defined? @type
+
+          @type = @event.payload[:type]
+        end
+
+        def disposition
+          return @disposition if defined? @disposition
+
+          @disposition = @event.payload[:disposition]
+        end
+
+        def status
+          return @status if defined? @status
+
+          @status = @event.payload[:status]
+        end
+
+        def url_based_filename
+          return @url_based_filename if defined? @url_based_filename
+
+          @url_based_filename = @event.payload[:url_based_filename]
+        end
+      end
+    end
+  end
+end

data/lib/rails_band/action_controller/event/start_processing.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module RailsBand
+  module ActionController
+    module Event
+      # A wrapper for the event that is passed to `start_processing.action_controller`.
+      class StartProcessing < BaseEvent
+        def controller
+          @controller ||= @event.payload.fetch(:controller)
+        end
+
+        def action
+          @action ||= @event.payload.fetch(:action)
+        end
+
+        def params
+          @params ||= @event.payload.fetch(:params).except(*INTERNAL_PARAMS)
+        end
+
+        def headers
+          @headers ||= @event.payload.fetch(:headers)
+        end
+
+        def format
+          @format ||= @event.payload.fetch(:format)
+        end
+
+        def method
+          @method ||= @event.payload.fetch(:method)
+        end
+
+        def path
+          @path ||= @event.payload.fetch(:path).split('?', 2).first
+        end
+
+        if Gem::Version.new(Rails.version) >= Gem::Version.new('6.1')
+          define_method(:request) do
+            @request ||= @event.payload[:request]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rails_band/action_controller/event/unpermitted_parameters.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module RailsBand
+  module ActionController
+    module Event
+      # A wrapper for the event that is passed to `unpermitted_parameters.action_controller`.
+      class UnpermittedParameters < BaseEvent
+        def keys
+          @keys ||= @event.payload.fetch(:keys)
+        end
+
+        if Gem::Version.new(Rails.version) >= Gem::Version.new('7.0')
+          # @see https://github.com/rails/rails/pull/41809
+          define_method(:controller) do
+            @controller ||= @event.payload.dig(:context, :controller)
+          end
+        end
+
+        if Gem::Version.new(Rails.version) >= Gem::Version.new('7.0')
+          # @see https://github.com/rails/rails/pull/41809
+          define_method(:action) do
+            @action ||= @event.payload.dig(:context, :action)
+          end
+        end
+
+        if Gem::Version.new(Rails.version) >= Gem::Version.new('7.0')
+          # @see https://github.com/rails/rails/pull/41809
+          define_method(:request) do
+            @request ||= @event.payload.dig(:context, :request)
+          end
+        end
+
+        if Gem::Version.new(Rails.version) >= Gem::Version.new('7.0')
+          # @see https://github.com/rails/rails/pull/41809
+          define_method(:params) do
+            @params ||= @event.payload.dig(:context, :params)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rails_band/action_controller/event/write_fragment.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module RailsBand
+  module ActionController
+    module Event
+      # A wrapper for the event that is passed to `write_fragment.action_controller`.
+      class WriteFragment < BaseEvent
+        def key
+          @key ||= @event.payload.fetch(:key)
+        end
+      end
+    end
+  end
+end

data/lib/rails_band/action_controller/log_subscriber.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require 'rails_band/action_controller/event/write_fragment'
+require 'rails_band/action_controller/event/read_fragment'
+require 'rails_band/action_controller/event/expire_fragment'
+require 'rails_band/action_controller/event/exist_fragment'
+require 'rails_band/action_controller/event/start_processing'
+require 'rails_band/action_controller/event/process_action'
+require 'rails_band/action_controller/event/send_file'
+require 'rails_band/action_controller/event/send_data'
+require 'rails_band/action_controller/event/redirect_to'
+require 'rails_band/action_controller/event/halted_callback'
+require 'rails_band/action_controller/event/unpermitted_parameters'
+
+module RailsBand
+  module ActionController
+    # This comes from ::ActionController::LogSubscriber
+    # @see https://github.com/rails/rails/blob/53000f3a2df5c59252d019bbb8d46728b291ec74/actionpack/lib/action_controller/log_subscriber.rb#L5
+    INTERNAL_PARAMS = %w[controller action format _method only_path].freeze
+
+    # The custom LogSubscriber for ActionController.
+    class LogSubscriber < ::ActiveSupport::LogSubscriber
+      mattr_accessor :consumers
+
+      def write_fragment(event)
+        consumer_of(__method__)&.call(Event::WriteFragment.new(event))
+      end
+
+      def read_fragment(event)
+        consumer_of(__method__)&.call(Event::ReadFragment.new(event))
+      end
+
+      def expire_fragment(event)
+        consumer_of(__method__)&.call(Event::ExpireFragment.new(event))
+      end
+
+      def exist_fragment?(event)
+        consumer_of(__method__)&.call(Event::ExistFragment.new(event))
+      end
+
+      def start_processing(event)
+        consumer_of(__method__)&.call(Event::StartProcessing.new(event))
+      end
+
+      def process_action(event)
+        consumer_of(__method__)&.call(Event::ProcessAction.new(event))
+      end
+
+      def send_file(event)
+        consumer_of(__method__)&.call(Event::SendFile.new(event))
+      end
+
+      def send_data(event)
+        consumer_of(__method__)&.call(Event::SendData.new(event))
+      end
+
+      def redirect_to(event)
+        consumer_of(__method__)&.call(Event::RedirectTo.new(event))
+      end
+
+      def halted_callback(event)
+        consumer_of(__method__)&.call(Event::HaltedCallback.new(event))
+      end
+
+      def unpermitted_parameters(event)
+        consumer_of(__method__)&.call(Event::UnpermittedParameters.new(event))
+      end
+
+      private
+
+      def consumer_of(sub_event)
+        consumers[:"#{sub_event}.action_controller"] || consumers[:action_controller] || consumers[:default]
+      end
+    end
+  end
+end

data/lib/rails_band/action_view/event/render_collection.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'rails_band/action_view/from_views'
+
+module RailsBand
+  module ActionView
+    module Event
+      # A wrapper for the event that is passed to `render_collection.action_view`.
+      class RenderCollection < BaseEvent
+        include FromViews
+
+        def identifier
+          @identifier ||= from_views(@event.payload.fetch(:identifier))
+        end
+
+        def layout
+          return @layout if defined? @layout
+
+          @layout = @event.payload[:layout]&.yield_self { |layout| from_views(layout) }
+        end
+
+        def count
+          @count ||= @event.payload.fetch(:count)
+        end
+
+        def cache_hits
+          return @cache_hits if defined? @cache_hits
+
+          @cache_hits = @event.payload[:cache_hits]
+        end
+      end
+    end
+  end
+end

data/lib/rails_band/action_view/event/render_partial.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'rails_band/action_view/from_views'
+
+module RailsBand
+  module ActionView
+    module Event
+      # A wrapper for the event that is passed to `render_partial.action_view`.
+      class RenderPartial < BaseEvent
+        include FromViews
+
+        def identifier
+          @identifier ||= from_views(@event.payload.fetch(:identifier))
+        end
+
+        def layout
+          return @layout if defined? @layout
+
+          @layout = @event.payload[:layout]&.yield_self { |layout| from_views(layout) }
+        end
+
+        def cache_hit
+          @cache_hit ||= @event.payload.fetch(:cache_hit)
+        end
+      end
+    end
+  end
+end

data/lib/rails_band/action_view/event/render_template.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'rails_band/action_view/from_views'
+
+module RailsBand
+  module ActionView
+    module Event
+      # A wrapper for the event that is passed to `render_template.action_view`.
+      class RenderTemplate < BaseEvent
+        include FromViews
+
+        def identifier
+          @identifier ||= from_views(@event.payload.fetch(:identifier))
+        end
+
+        def layout
+          return @layout if defined? @layout
+
+          @layout = @event.payload[:layout]&.yield_self { |layout| from_views(layout) }
+        end
+      end
+    end
+  end
+end

data/lib/rails_band/action_view/from_views.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module RailsBand
+  module ActionView
+    # FromViews provides a sole method  #from_views to delete the prefix of 'app/views/' from the passed string.
+    module FromViews
+      private
+
+      def from_views(string)
+        string.delete_prefix(views_prefix)
+      end
+
+      def views_prefix
+        @views_prefix ||= Rails.root.join('app/views/').to_path
+      end
+    end
+  end
+end

data/lib/rails_band/action_view/log_subscriber.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'rails_band/action_view/event/render_template'
+require 'rails_band/action_view/event/render_partial'
+require 'rails_band/action_view/event/render_collection'
+
+module RailsBand
+  module ActionView
+    # The custom LogSubscriber for ActionView.
+    class LogSubscriber < ::ActiveSupport::LogSubscriber
+      mattr_accessor :consumers
+
+      def render_template(event)
+        consumer_of(__method__)&.call(Event::RenderTemplate.new(event))
+      end
+
+      def render_partial(event)
+        consumer_of(__method__)&.call(Event::RenderPartial.new(event))
+      end
+
+      def render_collection(event)
+        consumer_of(__method__)&.call(Event::RenderCollection.new(event))
+      end
+
+      private
+
+      def consumer_of(sub_event)
+        consumers[:"#{sub_event}.action_view"] || consumers[:action_view] || consumers[:default]
+      end
+    end
+  end
+end

data/lib/rails_band/active_record/event/instantiation.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module RailsBand
+  module ActiveRecord
+    module Event
+      # A wrapper for the event that is passed to `instantiation.active_record`.
+      class Instantiation < BaseEvent
+        def record_count
+          @record_count ||= @event.payload.fetch(:record_count)
+        end
+
+        def class_name
+          @class_name ||= @event.payload.fetch(:class_name)
+        end
+      end
+    end
+  end
+end

data/lib/rails_band/active_record/event/sql.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module RailsBand
+  module ActiveRecord
+    module Event
+      # A wrapper for the event that is passed to `sql.active_record`.
+      class Sql < BaseEvent
+        def sql
+          @sql ||= @event.payload.fetch(:sql)
+        end
+
+        # @note This method is renamed in order to avoid conflicts with BaseEvent#name.
+        def sql_name
+          @sql_name ||= @event.payload.fetch(:name)
+        end
+
+        def binds
+          @binds ||= @event.payload.fetch(:binds)
+        end
+
+        def type_casted_binds
+          @type_casted_binds ||= @event.payload.fetch(:type_casted_binds)
+        end
+
+        def connection
+          @connection ||= @event.payload.fetch(:connection)
+        end
+
+        def statement_name
+          return @statement_name if defined? @statement_name
+
+          @statement_name = @event.payload[:statement_name]
+        end
+
+        def async
+          return @async if defined? @async
+
+          @async = @event.payload[:async]
+        end
+
+        def cached
+          return @cached if defined? @cached
+
+          @cached = @event.payload[:cached]
+        end
+      end
+    end
+  end
+end

data/lib/rails_band/active_record/event/strict_loading_violation.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module RailsBand
+  module ActiveRecord
+    module Event
+      # A wrapper for the event that is passed to `strict_loading_violation.active_record`.
+      class StrictLoadingViolation < BaseEvent
+        def owner
+          @owner ||= @event.payload.fetch(:owner)
+        end
+
+        def reflection
+          @reflection ||= @event.payload.fetch(:reflection)
+        end
+      end
+    end
+  end
+end

data/lib/rails_band/active_record/log_subscriber.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'rails_band/active_record/event/sql'
+require 'rails_band/active_record/event/instantiation'
+require 'rails_band/active_record/event/strict_loading_violation'
+
+module RailsBand
+  module ActiveRecord
+    # The custom LogSubscriber for ActiveRecord.
+    class LogSubscriber < ::ActiveSupport::LogSubscriber
+      mattr_accessor :consumers
+
+      def strict_loading_violation(event)
+        consumer_of(__method__)&.call(Event::StrictLoadingViolation.new(event))
+      end
+
+      def sql(event)
+        consumer_of(__method__)&.call(Event::Sql.new(event))
+      end
+
+      def instantiation(event)
+        consumer_of(__method__)&.call(Event::Instantiation.new(event))
+      end
+
+      private
+
+      def consumer_of(sub_event)
+        consumers[:"#{sub_event}.active_record"] || consumers[:active_record] || consumers[:default]
+      end
+    end
+  end
+end

data/lib/rails_band/base_event.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module RailsBand
+  # The base class of each Event class.
+  class BaseEvent
+    attr_reader :name, :time, :end, :transaction_id, :children,
+                :cpu_time, :idle_time, :allocations, :duration
+
+    # @param event [ActiveSupport::Notifications::Event]
+    def initialize(event)
+      @event = event
+      @name = event.name
+      @time = event.time
+      @end = event.end
+      @transaction_id = event.transaction_id
+      @children = event.children
+      @cpu_time = event.cpu_time
+      @idle_time = event.idle_time
+      @allocations = event.allocations
+      @duration = event.duration
+    end
+
+    def to_h
+      @to_h ||= {
+        name: @name, time: @time, end: @end, transaction_id: @transaction_id, children: @children,
+        cpu_time: @cpu_time, idle_time: @idle_time, allocations: @allocations, duration: @duration
+      }.merge!(
+        public_methods(false).reject { |meth| non_hash_keys.include?(meth) }.each_with_object({}) do |meth, h|
+          h[meth] = public_send(meth)
+        end
+      )
+    end
+
+    def slice(*args)
+      to_h.slice(*args)
+    end
+
+    private
+
+    def non_hash_keys
+      @non_hash_keys ||= []
+    end
+  end
+end

data/lib/rails_band/configuration.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module RailsBand
+  # RailsBand::Configuration is responsible for storing user-specified configuration.
+  class Configuration
+    # Consumers is a wrapper of ActiveSupport::HashWithIndifferentAccess, which validates the value on #[]=.
+    class Consumers < ActiveSupport::HashWithIndifferentAccess
+      def []=(key, value)
+        unless value.respond_to?(:call)
+          raise ArgumentError, "The value for `#{key.inspect}` must have #call: the passed one is `#{value.inspect}`"
+        end
+
+        super(key, value)
+      end
+    end
+
+    # @return [Consumers]
+    attr_reader :consumers
+
+    def initialize
+      @consumers = Consumers.new
+    end
+
+    # @param value [Hash, #call]
+    #   Consumer(s) to be called when instrumentation APIs are dispatched. If you pass a single value that has `#call`
+    #   method, the value is going to be always called for any instrumentation API events. You can also specify
+    #   consumers, assigning a Hash, the keys of which are instrumentation API event names. When the value is a Hash,
+    #   you are able to set a key, named `:default`, which is called for the rest of instrumentation API events
+    #   you don't assign.
+    #
+    #   Instrumentation API event names can be full event names or just namespaces, such as `:action_controller`.
+    #
+    # @example
+    #   config = RailsBand::Configuration.new
+    #   config.consumers = ->(e) { Rails.logger.info(e) }
+    #   config.consumers = {
+    #     default: ->(e) { Rails.logger.info(e) }
+    #     action_controller: ->(e) { Rails.logger.info("ActionController! #{e}") }
+    #     'render_template.action_view': ->(e) { Rails.logger.debug("RenderTemplate! #{e}") }
+    #   }
+    #
+    # @see https://guides.rubyonrails.org/active_support_instrumentation.html
+    def consumers=(value)
+      @consumers =
+        case value
+        when Hash
+          value.each_with_object(Consumers.new) do |(k, v), c|
+            c[k] = v
+          end
+        else
+          Consumers.new.tap { |c| c[:default] = value }
+        end
+    end
+  end
+end

data/lib/rails_band/railtie.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'action_controller/log_subscriber'
+require 'action_view/log_subscriber'
+
+module RailsBand
+  # RailsBand::Railtie is responsible for preparing its configuration and accepting user-specified configs.
+  class Railtie < ::Rails::Railtie
+    config.rails_band = Configuration.new
+
+    config.after_initialize do |app|
+      consumers = app.config.rails_band.consumers
+
+      swap = lambda { |old_class, new_class, namespace|
+        old_class.detach_from namespace
+        new_class.consumers = consumers
+        new_class.attach_to namespace
+      }
+
+      swap.call(::ActionController::LogSubscriber, RailsBand::ActionController::LogSubscriber, :action_controller)
+      swap.call(::ActionView::LogSubscriber, RailsBand::ActionView::LogSubscriber, :action_view)
+
+      if defined?(::ActiveRecord)
+        require 'active_record/log_subscriber'
+        swap.call(::ActiveRecord::LogSubscriber, RailsBand::ActiveRecord::LogSubscriber, :active_record)
+      end
+    end
+  end
+end

data/lib/rails_band/version.rb

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

data/lib/rails_band.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'rails_band/version'
+require 'rails_band/configuration'
+require 'rails_band/base_event'
+require 'rails_band/railtie'
+
+# Rails::Band unsubscribes all default LogSubscribers from Rails Instrumentation API,
+# and it subscribes our own custom LogSubscribers to make it easy to access Rails Instrumentation API.
+module RailsBand
+  module ActionController
+    autoload :LogSubscriber, 'rails_band/action_controller/log_subscriber'
+  end
+
+  module ActionView
+    autoload :LogSubscriber, 'rails_band/action_view/log_subscriber'
+  end
+
+  module ActiveRecord
+    autoload :LogSubscriber, 'rails_band/active_record/log_subscriber'
+  end
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: rails_band
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yutaka Kamei
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-10-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+description: A Rails plugin to facilitate the use of Rails Instrumentation API.
+email:
+- kamei@yykamei.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- lib/rails_band.rb
+- lib/rails_band/action_controller/event/exist_fragment.rb
+- lib/rails_band/action_controller/event/expire_fragment.rb
+- lib/rails_band/action_controller/event/halted_callback.rb
+- lib/rails_band/action_controller/event/process_action.rb
+- lib/rails_band/action_controller/event/read_fragment.rb
+- lib/rails_band/action_controller/event/redirect_to.rb
+- lib/rails_band/action_controller/event/send_data.rb
+- lib/rails_band/action_controller/event/send_file.rb
+- lib/rails_band/action_controller/event/start_processing.rb
+- lib/rails_band/action_controller/event/unpermitted_parameters.rb
+- lib/rails_band/action_controller/event/write_fragment.rb
+- lib/rails_band/action_controller/log_subscriber.rb
+- lib/rails_band/action_view/event/render_collection.rb
+- lib/rails_band/action_view/event/render_partial.rb
+- lib/rails_band/action_view/event/render_template.rb
+- lib/rails_band/action_view/from_views.rb
+- lib/rails_band/action_view/log_subscriber.rb
+- lib/rails_band/active_record/event/instantiation.rb
+- 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/base_event.rb
+- lib/rails_band/configuration.rb
+- lib/rails_band/railtie.rb
+- lib/rails_band/version.rb
+homepage: https://github.com/yykamei/rails_band
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/yykamei/rails_band
+  source_code_uri: https://github.com/yykamei/rails_band
+  changelog_uri: https://github.com/yykamei/rails_band/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: Easy-to-use Rails Instrumentation API
+test_files: []