Easy-to-use Rails Instrumentation API.

Add this line to your application's Gemfile:

gem 'rails_band'

And then execute:

bundle

Or install it yourself as:

gem install rails_band

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.application.config.rails_band.consumers = ->(event) { Rails.logger.info(event.to_h) }

You can also configure it by specifying event names:

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!

These are Rails Instrumentation API hooks supported by this gem so far.

Contributing is welcome 😄 Please open a pull request!

The gem is available as open source under the terms of the MIT License.