https://github.com/yykamei/rails_band

Easy-to-use Rails Instrumentation API
https://github.com/yykamei/rails_band
hacktoberfest instrumentation rails ruby ruby-on-rails
Last synced: 10 months ago
JSON representation
Easy-to-use Rails Instrumentation API
Host: GitHub
URL: https://github.com/yykamei/rails_band
Owner: yykamei
License: mit
Created: 2021-09-26T06:24:46.000Z (almost 5 years ago)
Default Branch: main
Last Pushed: 2024-10-02T00:25:34.000Z (almost 2 years ago)
Last Synced: 2024-10-29T14:18:22.561Z (over 1 year ago)
Topics: hacktoberfest, instrumentation, rails, ruby, ruby-on-rails
Language: Ruby
Homepage:
Size: 359 KB
Stars: 2
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project

README

          # 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!

## 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_stream.action_controller`](https://edgeguides.rubyonrails.org/active_support_instrumentation.html#send-stream-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) | ✅        |

| [`redirect.action_dispatch`](https://edgeguides.rubyonrails.org/active_support_instrumentation.html#redirect-action-dispatch)                 | ✅        |

| [`request.action_dispatch`](https://edgeguides.rubyonrails.org/active_support_instrumentation.html#request-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) | ✅        |

| [`render_layout.action_view`](https://edgeguides.rubyonrails.org/active_support_instrumentation.html#render-layout-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)             | ✅        |

| [`start_transaction.active_record`](https://edgeguides.rubyonrails.org/active_support_instrumentation.html#start-transaction-active-record) | ✅        |

| [`transaction.active_record`](https://edgeguides.rubyonrails.org/active_support_instrumentation.html#transaction-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 — Caching

| Event name                                                                                                                                          | Supported |

| --------------------------------------------------------------------------------------------------------------------------------------------------- | --------- |

| [`cache_read.active_support`](https://guides.rubyonrails.org/active_support_instrumentation.html#cache-read-active-support)                         | ✅        |

| [`cache_read_multi.active_support`](https://edgeguides.rubyonrails.org/active_support_instrumentation.html#cache-read-multi-active-support)         | ✅        |

| [`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`](https://edgeguides.rubyonrails.org/active_support_instrumentation.html#cache-write-multi-active-support)       | ✅        |

| [`cache_increment.active_support`](https://edgeguides.rubyonrails.org/active_support_instrumentation.html#cache-increment-active-support)           | ✅        |

| [`cache_decrement.active_support `](https://edgeguides.rubyonrails.org/active_support_instrumentation.html#cache-decrement-active-support)          | ✅        |

| [`cache_delete.active_support`](https://guides.rubyonrails.org/active_support_instrumentation.html#cache-delete-active-support)                     | ✅        |

| [`cache_delete_multi.active_support`](https://edgeguides.rubyonrails.org/active_support_instrumentation.html#cache-delete-multi-active-support)     | ✅        |

| [`cache_delete_matched.active_support`](https://edgeguides.rubyonrails.org/active_support_instrumentation.html#cache-delete-matched-active-support) | ✅        |

| [`cache_cleanup.active_support`](https://edgeguides.rubyonrails.org/active_support_instrumentation.html#cache-cleanup-active-support)               | ✅        |

| [`cache_prune.active_support`](https://edgeguides.rubyonrails.org/active_support_instrumentation.html#cache-prune-active-support)                   | ✅        |

| [`cache_exist?.active_support`](https://guides.rubyonrails.org/active_support_instrumentation.html#cache-exist-questionmark-active-support)         | ✅        |

### Active Support — Messages

| Event name                                                                                                                                                        | Supported |

| ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- |

| [`message_serializer_fallback.active_support`](https://edgeguides.rubyonrails.org/active_support_instrumentation.html#message-serializer-fallback-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)             | ✅        |

| [`enqueue_all.active_job`](https://edgeguides.rubyonrails.org/active_support_instrumentation.html#enqueue-all-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)                                       | ✅        |

| [`transform.active_storage`](https://guides.rubyonrails.org/active_support_instrumentation.html#transform-active-storage)                                   | ✅        |

| [`analyze.active_storage`](https://edgeguides.rubyonrails.org/active_support_instrumentation.html#analyze-active-storage)                                   | ✅        |

### Action Mailbox

| Event name                                                                                                                | Supported |

| ------------------------------------------------------------------------------------------------------------------------- | --------- |

| [`process.action_mailbox`](https://edgeguides.rubyonrails.org/active_support_instrumentation.html#process-action-mailbox) | ✅        |

### Railties

| Event name                                                                                                                                    | Supported |

| --------------------------------------------------------------------------------------------------------------------------------------------- | --------- |

| [`load_config_initializer.railties`](https://edgeguides.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!

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/yykamei/rails_band

Awesome Lists containing this project

README
