xref: /freebsd/cddl/usr.sbin/dwatch/examples/profile_template (revision f81cdf24ba5436367377f7c8e8f51f6df2a75ca7)
1# -*- tab-width: 4 -*- ;; Emacs
2# vi: set filetype=sh tabstop=8 shiftwidth=8 noexpandtab :: Vi/ViM
3############################################################ IDENT(1)
4#
5# $Title: dwatch(8) profile for XXX entry $
6# $Copyright: 2014-2018 Devin Teske. All rights reserved. $
7#
8############################################################ DESCRIPTION
9#
10# XXX
11#
12############################################################ PRAGMAS
13
14# Optional: You can override the default pragmas (shown below)
15
16#DTRACE_PRAGMA="
17#	option quiet
18#	option dynvarsize=16m
19#	switchrate=10hz
20#" # END-QUOTE
21
22############################################################ PROBE
23
24# Optional: dwatch(8) initializes this to the expanded probe arguments
25
26#: ${PROBE:="XXX"}
27
28############################################################ ACTIONS
29
30# Optional actions to be performed before hitting the final print action
31
32#exec 9<<EOF
33#EOF
34#ACTIONS=$( cat <&9 )
35#ID=
36
37############################################################ EVENT ACTION
38
39# The default EVENT value is simply `entry'. This is paired with $PROBE.
40
41#EVENT=
42
43# Optional predicate which must be true before the event action will run
44
45#EVENT_TEST=
46
47############################################################ EVENT TAG
48
49# The EVENT_TAG is run inside the print action after the timestamp has been
50# printed. By default, `UID.GID CMD[PID]: ' of the process is printed.
51
52#exec 9<<EOF
53#EOF
54#EVENT_TAG=$( cat <&9 )
55
56############################################################ EVENT DETAILS
57
58# The DETAILS are run after the EVENT_TAG and by default, the program name and
59# arguments of the process hitting the EVENT action are shown. This can be
60# customized to call-specific information because the `-v' flag of dwatch(8)
61# can provide detailed process information for the EVENT action on lines below
62# the DETAILS.
63#
64# NB: Should produce a single-line and not print a trailing newline.
65
66#exec 9<<EOF
67#	printf("XXX");
68#EOF
69#DETAILS=$( cat <&9 )
70
71################################################################################
72# END
73################################################################################
74