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