summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorAvdi Grimm <avdi@users.noreply.github.com>2020-05-16 16:29:05 -0500
committerSamuel Williams <samuel.williams@oriontransfer.co.nz>2020-05-18 17:39:21 +1200
commitafd84c58acfe9126d31c3f7673b049f11b67b095 (patch)
tree24c00a573b40e737cd8a297766243c3daf2d55ce /doc
parent0e5a58b6bf6aae72b6290a8d68e0a1b6d9eb4f79 (diff)
Document how to enable USDT method entry/exit tracepoints
Notes
Notes: Merged: https://github.com/ruby/ruby/pull/3115
Diffstat (limited to 'doc')
-rw-r--r--doc/dtrace_probes.rdoc6
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/dtrace_probes.rdoc b/doc/dtrace_probes.rdoc
index d2cdd56902..afb4216876 100644
--- a/doc/dtrace_probes.rdoc
+++ b/doc/dtrace_probes.rdoc
@@ -56,10 +56,16 @@ with when they are fired and the arguments they take:
methodname name of the method about to be executed (a string)
filename the file name where the method is _being called_ (a string)
lineno the line number where the method is _being called_ (an int)
+
+ *NOTE*: will only be fired if tracing is enabled, e.g. with: +TracePoint.new{}.enable+.
+ See {ticket #14104}[https://bugs.ruby-lang.org/issues/14104] for more details.
[ruby:::method-return(classname, methodname, filename, lineno);]
This probe is fired just after a method has returned. The arguments are the
same as "ruby:::method-entry".
+
+ *NOTE*: will only be fired if tracing is enabled, e.g. with: +TracePoint.new{}.enable+.
+ See {ticket #14104}[https://bugs.ruby-lang.org/issues/14104] for more details.
[ruby:::cmethod-entry(classname, methodname, filename, lineno);]
This probe is fired just before a C method is entered. The arguments are the