lttng-disable-event(1)

1LTTNG-DISABLE-EVEN(1)            LTTng Manual            LTTNG-DISABLE-EVEN(1)
2
3
4

NAME

6       lttng-disable-event - Disable LTTng recording event rules
7

SYNOPSIS

9       Disable one or more recording event rules matching Linux kernel events:
10
11       lttng [GENERAL OPTIONS] disable-event --kernel
12             [--tracepoint | --syscall | --probe | --function]
13             (--all-events | NAME[,NAME]...)
14             [--session=SESSION] [--channel=CHANNEL]
15
16       Disable one or more recording event rules matching user space
17       tracepoint or Java/Python logging events:
18
19       lttng [GENERAL OPTIONS] disable-event
20             (--userspace | --jul | --log4j | --python) [--tracepoint]
21             (--all-events | NAME[,NAME]...)
22             [--session=SESSION] [--channel=CHANNEL]
23

DESCRIPTION

25       The lttng disable-event command disables one or more enabled recording
26       event rules previously created with the lttng-enable-event(1) command
27       which belong to:
28
29       With the --session=SESSION option
30           The recording session named SESSION.
31
32       Without the --session option
33           The current recording session (see lttng-concepts(7) to learn more
34           about the current recording session).
35
36       With the --channel=CHANNEL option
37           The channel named CHANNEL.
38
39       Without the --channel option
40           The channel named channel0.
41
42           If there’s more than one channel for the selected recording session
43           and domain, the disable-event command fails.
44
45       See lttng-concepts(7) to learn more about recording event rules.
46
47       As of LTTng 2.13.4, the disable-event command can only find recording
48       event rules to disable by their instrumentation point type and event
49       name conditions. Therefore, you cannot disable recording event rules
50       having a specific instrumentation point log level condition, for
51       example.
52
53       With the --kernel option and no instrumentation point type condition
54       option, the disable-event command disables one or more Linux kernel
55       recording event rules regardless of their instrumentation point type.
56
57       List the recording event rules of a given recording session and/or
58       channel with the lttng-list(1) command.
59
60       Without the --all-events option, the disable-event command disables one
61       recording event rule per NAME argument. NAME is the exact event name
62       condition pattern of the recording event rule to disable, as listed in
63       the output of lttng list (see lttng-list(1)).
64
65       You may disable an enabled recording event rule regardless of the
66       activity (started or stopped) of its recording session (see lttng-
67       start(1) and lttng-stop(1)).
68
69       See the “EXAMPLES” section below for usage examples.
70

OPTIONS

72       See lttng(1) for GENERAL OPTIONS.
73
74   Tracing domain
75       One of:
76
77       -j, --jul
78           Disable recording event rules in the java.util.logging (JUL)
79           domain.
80
81       -k, --kernel
82           Disable recording event rules in the Linux kernel domain.
83
84       -l, --log4j
85           Disable recording event rules in the Apache log4j domain.
86
87       -p, --python
88           Disable recording event rules in the Python domain.
89
90       -u, --userspace
91           Disable recording event rules in the user space tracing domain.
92
93   Recording target
94       -c CHANNEL, --channel=CHANNEL
95           Disable recording event rules attached to the channel named CHANNEL
96           instead of channel0.
97
98       -s SESSION, --session=SESSION
99           Disable recording event rules in the recording session named
100           SESSION instead of the current recording session.
101
102   Instrumentation point type condition
103       At most one of:
104
105       --function
106           Only disable recording event rules which match Linux kretprobe
107           events.
108
109           Only available with the --kernel option.
110
111       --probe
112           Only disable recording event rules which match Linux kprobe events.
113
114           Only available with the --kernel option.
115
116       --syscall
117           Only disable recording event rules which match Linux system call
118           events.
119
120           Only available with the --kernel option.
121
122       --tracepoint
123           Only disable recording event rules which match:
124
125           With the --kernel or --userspace option
126               LTTng tracepoint events.
127
128           With the --jul, --log4j, or --python option
129               Logging events.
130
131   Event name condition
132       -a, --all-events
133           Disable recording event rules regardless of their event name
134           condition.
135
136   Program information
137       -h, --help
138           Show help.
139
140           This option attempts to launch /usr/bin/man to view this manual
141           page. Override the manual pager path with the LTTNG_MAN_BIN_PATH
142           environment variable.
143
144       --list-options
145           List available command options and quit.
146

EXIT STATUS

148       0
149           Success
150
151       1
152           Command error
153
154       2
155           Undefined command
156
157       3
158           Fatal error
159
160       4
161           Command warning (something went wrong during the command)
162

ENVIRONMENT

164       LTTNG_ABORT_ON_ERROR
165           Set to 1 to abort the process after the first error is encountered.
166
167       LTTNG_HOME
168           Path to the LTTng home directory.
169
170           Defaults to $HOME.
171
172           Useful when the Unix user running the commands has a non-writable
173           home directory.
174
175       LTTNG_MAN_BIN_PATH
176           Absolute path to the manual pager to use to read the LTTng
177           command-line help (with lttng-help(1) or with the --help option)
178           instead of /usr/bin/man.
179
180       LTTNG_SESSION_CONFIG_XSD_PATH
181           Path to the directory containing the session.xsd recording session
182           configuration XML schema.
183
184       LTTNG_SESSIOND_PATH
185           Absolute path to the LTTng session daemon binary (see lttng-
186           sessiond(8)) to spawn from the lttng-create(1) command.
187
188           The --sessiond-path general option overrides this environment
189           variable.
190

FILES

192       $LTTNG_HOME/.lttngrc
193           Unix user’s LTTng runtime configuration.
194
195           This is where LTTng stores the name of the Unix user’s current
196           recording session between executions of lttng(1).  lttng-create(1)
197           and lttng-set-session(1) set the current recording session.
198
199       $LTTNG_HOME/lttng-traces
200           Default output directory of LTTng traces in local and snapshot
201           modes.
202
203           Override this path with the --output option of the lttng-create(1)
204           command.
205
206       $LTTNG_HOME/.lttng
207           Unix user’s LTTng runtime and configuration directory.
208
209       $LTTNG_HOME/.lttng/sessions
210           Default directory containing the Unix user’s saved recording
211           session configurations (see lttng-save(1) and lttng-load(1)).
212
213       /usr/local/etc/lttng/sessions
214           Directory containing the system-wide saved recording session
215           configurations (see lttng-save(1) and lttng-load(1)).
216
217       Note
218           $LTTNG_HOME defaults to the value of the HOME environment variable.
219

EXAMPLES

221       Example 1. Disable all Linux kernel tracepoint recording event rules in
222       the default channel of the current recording session.
223
224           See the --all-events option.
225
226               $ lttng disable-event --kernel --tracepoint --all-events
227
228       Example 2. Disable specific Apache log4j recording event rules in the
229       default channel of a specific recording session.
230
231           See the --session option.
232
233               $ lttng disable-event --session=my-session --log4j \
234                                     MySingleton,MyProxy,MyFacade
235
236       Example 3. Disable all user space recording event rules in a specific
237       channel of the current recording session.
238
239           See the --channel option.
240
241               $ lttng disable-event --channel=my-channel --userspace \
242                                     --all-events
243
244       Example 4. Disable specific Linux kernel system call recording event
245       rules in the default channel of the current recording session.
246
247               $ lttng disable-event --kernel --syscall pipe2,eventfd
248

RESOURCES

250       •   LTTng project website <https://lttng.org>
251
252       •   LTTng documentation <https://lttng.org/docs>
253
254       •   LTTng bug tracker <https://bugs.lttng.org>
255
256       •   Git repositories <https://git.lttng.org>
257
258       •   GitHub organization <https://github.com/lttng>
259
260       •   Continuous integration <https://ci.lttng.org/>
261
262       •   Mailing list <https://lists.lttng.org/> for support and
263           development: lttng-dev@lists.lttng.org
264
265       •   IRC channel <irc://irc.oftc.net/lttng>: #lttng on irc.oftc.net
266

COPYRIGHT

268       This program is part of the LTTng-tools project.
269
270       LTTng-tools is distributed under the GNU General Public License
271       version 2 <http://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html>.
272       See the LICENSE <https://github.com/lttng/lttng-
273       tools/blob/master/LICENSE> file for details.
274

THANKS

276       Special thanks to Michel Dagenais and the DORSAL laboratory
277       <http://www.dorsal.polymtl.ca/> at École Polytechnique de Montréal for
278       the LTTng journey.
279
280       Also thanks to the Ericsson teams working on tracing which helped us
281       greatly with detailed bug reports and unusual test cases.
282