aboutsummaryrefslogtreecommitdiffstats
path: root/railties/guides/source/active_support_instrumentation.textile
diff options
context:
space:
mode:
authorAvi Tzurel <avi@kensodev.com>2012-03-12 12:03:57 +0200
committerAvi Tzurel <avi@kensodev.com>2012-03-12 12:03:57 +0200
commit78954acde740716746959aa77c5c0b103789f2e4 (patch)
treef96afc78c6725131551094301a43bd86dee9fea8 /railties/guides/source/active_support_instrumentation.textile
parent8de49fe4613ee4362385dd69d984da463d195a7e (diff)
parent36bd5c97420e46a19658e34dbe24bcab265311af (diff)
downloadrails-78954acde740716746959aa77c5c0b103789f2e4.tar.gz
rails-78954acde740716746959aa77c5c0b103789f2e4.tar.bz2
rails-78954acde740716746959aa77c5c0b103789f2e4.zip
Merge remote-tracking branch 'original_repo/master'
Diffstat (limited to 'railties/guides/source/active_support_instrumentation.textile')
-rw-r--r--railties/guides/source/active_support_instrumentation.textile57
1 files changed, 57 insertions, 0 deletions
diff --git a/railties/guides/source/active_support_instrumentation.textile b/railties/guides/source/active_support_instrumentation.textile
index f9452400ad..8e2866dfc3 100644
--- a/railties/guides/source/active_support_instrumentation.textile
+++ b/railties/guides/source/active_support_instrumentation.textile
@@ -21,10 +21,67 @@ You are even able to create your own events inside your application which you ca
h3. Rails framework hooks
+Within the Ruby on Rails framework, there are a number of hooks provided for common events. These are detailed below.
+
h4. Action Mailer
+h5. receive.action_mailer
+
+This hook is called when the +receive+ method of an +ActionMailer::Base+ class is called:
+
+<ruby>
+ class Mailer < ActionMailer::Base
+ def receive(mail)
+
+ end
+ end
+</ruby>
+
+The payload for this event has the following parameters related to the incoming email:
+
+|_.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|
+
+h5. deliver.action_mailer
+
+This hook is called when the +deliver+ method is called on a +Mail::Message+ object. This is due to a hook inserted by Action Mailer, rather than a specific feature of the Mail gem itself.
+
+The payload for this event has the following parameters related to the outgoing email:
+
+|_.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|
+
+
h4. Action Controller
+h5. write_fragment.action_controller
+
+h5. read_fragment.action_controller
+
+h5. exist_fragment?.action_controller
+
+h5. expire_fragment.action_controller
+
+h5. write_page.action_controller
+
+h5. expire_page.action_controller
+
h4. Action View
h4. Active Record