summaryrefslogtreecommitdiffstats
path: root/stapprobes.5.in
diff options
context:
space:
mode:
Diffstat (limited to 'stapprobes.5.in')
-rw-r--r--stapprobes.5.in12
1 files changed, 11 insertions, 1 deletions
diff --git a/stapprobes.5.in b/stapprobes.5.in
index efefc1bf..536991ec 100644
--- a/stapprobes.5.in
+++ b/stapprobes.5.in
@@ -53,7 +53,7 @@ wildcards or aliases), and all them are then probed. A probe
declaration may also contain several comma-separated specifications,
all of which are probed.
-.SS BEGIN/END
+.SS BEGIN/END/ERROR
The probe points
.IR begin " and " end
@@ -80,6 +80,16 @@ increasing order, and the order between handlers with the same sequence
number is unspecified. When "begin" or "end" are given without a
sequence, they are effectively sequence zero.
+The
+.IR error
+probe point is similar to the
+.IR end
+probe, except that each such probe handler run when the session and
+after errors having occurred. In such cases, "end" probes are
+skipped, but each "error" prober is still attempted. This kind of
+probe can be used to clean up or emit a final gasp message. It may
+also be numerically parametrized to set a sequence.
+
.SS NEVER
The probe point
.IR never