aboutsummaryrefslogtreecommitdiffstats
path: root/guides
diff options
context:
space:
mode:
authorGannon McGibbon <gannon.mcgibbon@gmail.com>2018-10-09 13:58:39 -0400
committerGitHub <noreply@github.com>2018-10-09 13:58:39 -0400
commit88813a98b95fda56232270e6754f553986036e57 (patch)
tree81b1dcc04e5353dcb425886a2a2710bf38f22e86 /guides
parent82ac2114a137e4f1a909b24028cd0330752d801c (diff)
parent881f4f38d44fb56db48ecd5683ebfffcc8fc284e (diff)
downloadrails-88813a98b95fda56232270e6754f553986036e57.tar.gz
rails-88813a98b95fda56232270e6754f553986036e57.tar.bz2
rails-88813a98b95fda56232270e6754f553986036e57.zip
Merge pull request #34105 from zvkemp/correct-asn-docs
clarify role of unique_id in ActiveSupport::Notifications [ci skip]
Diffstat (limited to 'guides')
-rw-r--r--guides/source/active_support_instrumentation.md5
1 files changed, 3 insertions, 2 deletions
diff --git a/guides/source/active_support_instrumentation.md b/guides/source/active_support_instrumentation.md
index 9963125fa2..64db141381 100644
--- a/guides/source/active_support_instrumentation.md
+++ b/guides/source/active_support_instrumentation.md
@@ -623,7 +623,7 @@ 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
+* A unique ID for the instrumenter that fired the event
* The payload (described in previous sections)
```ruby
@@ -672,7 +672,8 @@ Creating custom events
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.
+and add the instrumenter's unique ID. All data passed into the `instrument` call will make
+it into the payload.
Here's an example: