The instrumentation API provided by Active Support allows developers to provide hooks which other developers may hook into. There are several of these within the Rails framework. With this API, developers can choose to be notified when certain events occur inside their application or another piece of Ruby code.
For example, there is a hook provided within Active Record that is called every time Active Record uses an SQL query on a database. This hook could be subscribed to, and used to track the number of queries during a certain action. There's another hook around the processing of an action of a controller. This could be used, for instance, to track how long a specific action has taken.
You are even able to create your own events inside your application which you can later subscribe to.
Within the Ruby on Rails framework, there are a number of hooks provided for common events. These are detailed below.
Key |
Value |
:key |
The complete key |
{
key: 'posts/1-dashboard-view'
}
Key |
Value |
:key |
The complete key |
{
key: 'posts/1-dashboard-view'
}
Key |
Value |
:key |
The complete key |
{
key: 'posts/1-dashboard-view'
}
Key |
Value |
:key |
The complete key |
{
key: 'posts/1-dashboard-view'
}
Key |
Value |
:path |
The complete path |
Key |
Value |
:path |
The complete path |
Key |
Value |
:controller |
The controller name |
:action |
The action |
:params |
Hash of request parameters without any filtered parameter |
:headers |
Request headers |
:format |
html/js/json/xml etc |
:method |
HTTP request verb |
:path |
Request path |
{
controller: "PostsController",
action: "new",
params: { "action" => "new", "controller" => "posts" },
headers: #<ActionDispatch::Http::Headers:0x0055a67a519b88>,
format: :html,
method: "GET",
path: "/posts/new"
}
Key |
Value |
:controller |
The controller name |
:action |
The action |
:params |
Hash of request parameters without any filtered parameter |
:headers |
Request headers |
:format |
html/js/json/xml etc |
:method |
HTTP request verb |
:path |
Request path |
:status |
HTTP status code |
:view_runtime |
Amount spent in view in ms |
:db_runtime |
Amount spent executing database queries in ms |
{
controller: "PostsController",
action: "index",
params: {"action" => "index", "controller" => "posts"},
headers: #<ActionDispatch::Http::Headers:0x0055a67a519b88>,
format: :html,
method: "GET",
path: "/posts",
status: 200,
view_runtime: 46.848,
db_runtime: 0.157
}
Key |
Value |
:path |
Complete path to the file |
Additional keys may be added by the caller.
ActionController
does not had any specific information to the payload. All options are passed through to the payload.
Key |
Value |
:status |
HTTP response code |
:location |
URL to redirect to |
{
status: 302,
location: "http://localhost:3000/posts/new"
}
Key |
Value |
:filter |
Filter that halted the action |
{
filter: ":halting_filter"
}
Key |
Value |
:keys |
Unpermitted keys |
Key |
Value |
:identifier |
Full path to template |
:layout |
Applicable layout |
{
identifier: "/Users/adam/projects/notifications/app/views/posts/index.html.erb",
layout: "layouts/application"
}
Key |
Value |
:identifier |
Full path to template |
{
identifier: "/Users/adam/projects/notifications/app/views/posts/_form.html.erb"
}
Key |
Value |
:identifier |
Full path to template |
:count |
Size of collection |
:cache_hits |
Number of partials fetched from cache |
:cache_hits
is only included if the collection is rendered with cached: true
.
{
identifier: "/Users/adam/projects/notifications/app/views/posts/_post.html.erb",
count: 3,
cache_hits: 0
}
Key |
Value |
:sql |
SQL statement |
:name |
Name of the operation |
:connection_id |
self.object_id |
:binds |
Bind parameters |
:cached |
true is added when cached queries used |
The adapters will add their own data as well.
{
sql: "SELECT \"posts\".* FROM \"posts\" ",
name: "Post Load",
connection_id: 70307250813140,
binds: []
}
Key |
Value |
:record_count |
Number of records that instantiated |
:class_name |
Record's class |
{
record_count: 1,
class_name: "User"
}
Key |
Value |
:mailer |
Name of the mailer class |
:message_id |
ID of the message, generated by the Mail gem |
:subject |
Subject of the mail |
:to |
To address(es) of the mail |
:from |
From address of the mail |
:bcc |
BCC addresses of the mail |
:cc |
CC addresses of the mail |
:date |
Date of the mail |
:mail |
The encoded form of the mail |
{
mailer: "Notification",
message_id: "4f5b5491f1774_181b23fc3d4434d38138e5@mba.local.mail",
subject: "Rails Guides",
to: ["users@rails.com", "dhh@rails.com"],
from: ["me@rails.com"],
date: Sat, 10 Mar 2012 14:18:09 +0100,
mail: "..." # omitted for brevity
}
Key |
Value |
:mailer |
Name of the mailer class |
:message_id |
ID of the message, generated by the Mail gem |
:subject |
Subject of the mail |
:to |
To address(es) of the mail |
:from |
From address of the mail |
:bcc |
BCC addresses of the mail |
:cc |
CC addresses of the mail |
:date |
Date of the mail |
:mail |
The encoded form of the mail |
{
mailer: "Notification",
message_id: "4f5b5491f1774_181b23fc3d4434d38138e5@mba.local.mail",
subject: "Rails Guides",
to: ["users@rails.com", "dhh@rails.com"],
from: ["me@rails.com"],
date: Sat, 10 Mar 2012 14:18:09 +0100,
mail: "..." # omitted for brevity
}
Key |
Value |
:mailer |
Name of the mailer class |
:action |
The action |
:args |
The arguments |
{
mailer: "Notification",
action: "welcome_email",
args: []
}
Key |
Value |
:key |
Key used in the store |
:hit |
If this read is a hit |
:super_operation |
:fetch is added when a read is used with #fetch
|
This event is only used when #fetch
is called with a block.
Key |
Value |
:key |
Key used in the store |
Options passed to fetch will be merged with the payload when writing to the store
{
key: 'name-of-complicated-computation'
}
This event is only used when #fetch
is called with a block.
Key |
Value |
:key |
Key used in the store |
Options passed to fetch will be merged with the payload.
{
key: 'name-of-complicated-computation'
}
Key |
Value |
:key |
Key used in the store |
Cache stores may add their own keys
{
key: 'name-of-complicated-computation'
}
Key |
Value |
:key |
Key used in the store |
{
key: 'name-of-complicated-computation'
}
Key |
Value |
:key |
Key used in the store |
{
key: 'name-of-complicated-computation'
}
Key |
Value |
:adapter |
QueueAdapter object processing the job |
:job |
Job object |
Key |
Value |
:adapter |
QueueAdapter object processing the job |
:job |
Job object |
Key |
Value |
:adapter |
QueueAdapter object processing the job |
:job |
Job object |
Key |
Value |
:adapter |
QueueAdapter object processing the job |
:job |
Job object |
Key |
Value |
:channel_class |
Name of the channel class |
:action |
The action |
:data |
A hash of data |
Key |
Value |
:channel_class |
Name of the channel class |
:data |
A hash of data |
:via |
Via |
Key |
Value |
:channel_class |
Name of the channel class |
Key |
Value |
:channel_class |
Name of the channel class |
Key |
Value |
:broadcasting |
A named broadcasting |
:message |
A hash of message |
:coder |
The coder |
Key |
Value |
:key |
Secure token |
:service |
Name of the service |
:checksum |
Checksum to ensure integrity |
Key |
Value |
:key |
Secure token |
:service |
Name of the service |
Key |
Value |
:key |
Secure token |
:service |
Name of the service |
Key |
Value |
:key |
Secure token |
:service |
Name of the service |
Key |
Value |
:prefix |
Key prefix |
:service |
Name of the service |
Key |
Value |
:key |
Secure token |
:service |
Name of the service |
:exist |
File or blob exists or not |
Key |
Value |
:key |
Secure token |
:service |
Name of the service |
:url |
Generated url |
Key |
Value |
:initializer |
Path to loaded initializer from config/initializers
|
Key |
Value |
:message |
The deprecation warning |
:callstack |
Where the deprecation came from |
Subscribing to an event is easy. Use ActiveSupport::Notifications.subscribe
with a block to
listen to any notification.
The block receives the following arguments:
- The name of the event
- Time when it started
- Time when it finished
- A unique ID for this event
- The payload (described in previous sections)
ActiveSupport::Notifications.subscribe "process_action.action_controller" do |name, started, finished, unique_id, data|
# your own custom stuff
Rails.logger.info "#{name} Received!"
end
Defining all those block arguments each time can be tedious. You can easily create an ActiveSupport::Notifications::Event
from block arguments like this:
ActiveSupport::Notifications.subscribe "process_action.action_controller" do |*args|
event = ActiveSupport::Notifications::Event.new *args
event.name # => "process_action.action_controller"
event.duration # => 10 (in milliseconds)
event.payload # => {:extra=>information}
Rails.logger.info "#{event} Received!"
end
Most times you only care about the data itself. Here is a shortcut to just get the data.
ActiveSupport::Notifications.subscribe "process_action.action_controller" do |*args|
data = args.extract_options!
data # { extra: :information }
end
You may also subscribe to events matching a regular expression. This enables you to subscribe to
multiple events at once. Here's you could subscribe to everything from ActionController
.
ActiveSupport::Notifications.subscribe /action_controller/ do |*args|
# inspect all ActionController events
end
Adding your own events is easy as well. ActiveSupport::Notifications
will take care of
all the heavy lifting for you. Simply call instrument
with a name
, payload
and a block.
The notification will be sent after the block returns. ActiveSupport
will generate the start and end times
as well as the unique ID. All data passed into the instrument
call will make it into the payload.
Here's an example:
ActiveSupport::Notifications.instrument "my.custom.event", this: :data do
# do your custom stuff here
end
Now you can listen to this event with:
ActiveSupport::Notifications.subscribe "my.custom.event" do |name, started, finished, unique_id, data|
puts data.inspect # {:this=>:data}
end
You should follow Rails conventions when defining your own events. The format is: event.library
.
If your application is sending Tweets, you should create an event named tweet.twitter
.
Feedback
You're encouraged to help improve the quality of this guide.
Please contribute if you see any typos or factual errors.
To get started, you can read our documentation contributions section.
You may also find incomplete content or stuff that is not up to date.
Please do add any missing documentation for master. Make sure to check
Edge Guides first to verify
if the issues are already fixed or not on the master branch.
Check the Ruby on Rails Guides Guidelines
for style and conventions.
If for whatever reason you spot something to fix but cannot patch it yourself, please
open an issue.
And last but not least, any kind of discussion regarding Ruby on Rails
documentation is very welcome on the rubyonrails-docs mailing list.