Rename "tracing session" -> "recording session"
[lttng-tools.git] / doc / man / lttng-disable-event.1.txt
CommitLineData
290294e8
PP
1lttng-disable-event(1)
2======================
aaae4813 3:revdate: 14 June 2021
290294e8
PP
4
5
6NAME
7----
484b2a0c 8lttng-disable-event - Disable LTTng recording event rules
290294e8
PP
9
10
11SYNOPSIS
12--------
484b2a0c
PP
13Disable one or more recording event rules matching Linux kernel
14events:
15
16[verse]
17*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *disable-event* option:--kernel
18 [option:--tracepoint | option:--syscall | option:--probe | option:--function]
19 (option:--all-events | 'NAME'[,'NAME']...)
20 [option:--session='SESSION'] [option:--channel='CHANNEL']
21
22Disable one or more recording event rules matching user space
23tracepoint or Java/Python logging events:
24
290294e8 25[verse]
ce19b9ed 26*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *disable-event*
484b2a0c
PP
27 (option:--userspace | option:--jul | option:--log4j | option:--python) [option:--tracepoint]
28 (option:--all-events | 'NAME'[,'NAME']...)
290294e8 29 [option:--session='SESSION'] [option:--channel='CHANNEL']
484b2a0c 30
290294e8
PP
31
32DESCRIPTION
33-----------
484b2a0c
PP
34The `lttng disable-event` command disables one or more enabled recording
35event rules previously created with the man:lttng-enable-event(1)
188419c4
PP
36command which belong to:
37
38With the option:--session='SESSION' option::
aaae4813 39 The recording session named 'SESSION'.
188419c4
PP
40
41Without the option:--session option::
aaae4813
PP
42 The current recording session (see man:lttng-concepts(7) to learn
43 more about the current recording session).
188419c4
PP
44
45With the option:--channel='CHANNEL' option::
46 The channel named 'CHANNEL'.
47
48Without the option:--channel option::
49 The channel named `channel0`.
477f8971 50+
aaae4813 51If there's more than one channel for the selected recording session and
477f8971 52domain, the `disable-event` command fails.
188419c4
PP
53
54See man:lttng-concepts(7) to learn more about recording event rules.
290294e8 55
484b2a0c
PP
56As of LTTng{nbsp}{lttng_version}, the `disable-event` command can only
57find recording event rules to disable by their instrumentation point
58type and event name conditions. Therefore, you cannot disable recording
59event rules having a specific instrumentation point log level condition,
60for example.
290294e8 61
c4c1f01e
PP
62With the option:--kernel option and no instrumentation point type
63condition option, the `disable-event` command disables one or more Linux
64kernel recording event rules regardless of their instrumentation point
65type.
66
aaae4813 67List the recording event rules of a given recording session
484b2a0c 68and/or channel with the man:lttng-list(1) command.
290294e8 69
484b2a0c
PP
70Without the option:--all-events option, the `disable-event` command
71disables one recording event rule per 'NAME' argument. 'NAME' is the
72exact event name condition pattern of the recording event rule to
73disable, as listed in the output of `lttng list` (see
74man:lttng-list(1)).
290294e8 75
484b2a0c 76You may disable an enabled recording event rule regardless of the
aaae4813 77activity (started or stopped) of its recording session (see
484b2a0c 78man:lttng-start(1) and man:lttng-stop(1)).
290294e8 79
7d259724 80See the ``<<examples,EXAMPLES>>'' section below for usage examples.
6e8afcda 81
290294e8 82
55e06994 83include::common-lttng-cmd-options-head.txt[]
290294e8
PP
84
85
484b2a0c
PP
86Tracing domain
87~~~~~~~~~~~~~~
290294e8
PP
88One of:
89
90option:-j, option:--jul::
484b2a0c
PP
91 Disable recording event rules in the `java.util.logging` (JUL)
92 domain.
290294e8
PP
93
94option:-k, option:--kernel::
484b2a0c 95 Disable recording event rules in the Linux kernel domain.
290294e8
PP
96
97option:-l, option:--log4j::
484b2a0c 98 Disable recording event rules in the Apache log4j domain.
290294e8
PP
99
100option:-p, option:--python::
484b2a0c 101 Disable recording event rules in the Python domain.
290294e8
PP
102
103option:-u, option:--userspace::
484b2a0c 104 Disable recording event rules in the user space tracing domain.
290294e8
PP
105
106
484b2a0c
PP
107Recording target
108~~~~~~~~~~~~~~~~
59b19c3c 109option:-c 'CHANNEL', option:--channel='CHANNEL'::
484b2a0c
PP
110 Disable recording event rules attached to the channel named
111 'CHANNEL' instead of `channel0`.
290294e8 112
59b19c3c 113option:-s 'SESSION', option:--session='SESSION'::
aaae4813
PP
114 Disable recording event rules in the recording session named
115 'SESSION' instead of the current recording session.
290294e8
PP
116
117
484b2a0c
PP
118Instrumentation point type condition
119~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
120At most one of:
290294e8
PP
121
122option:--function::
484b2a0c
PP
123 Only disable recording event rules which match Linux kretprobe
124 events.
125+
126Only available with the option:--kernel option.
290294e8
PP
127
128option:--probe::
484b2a0c
PP
129 Only disable recording event rules which match Linux kprobe events.
130+
131Only available with the option:--kernel option.
290294e8
PP
132
133option:--syscall::
484b2a0c
PP
134 Only disable recording event rules which match Linux system call
135 events.
136+
137Only available with the option:--kernel option.
290294e8
PP
138
139option:--tracepoint::
484b2a0c
PP
140 Only disable recording event rules which match:
141+
142--
143With the option:--kernel or option:--userspace option:::
144 LTTng tracepoint events.
145With the option:--jul, option:--log4j, or option:--python option:::
146 Logging events.
147--
484b2a0c
PP
148
149
150Event name condition
151~~~~~~~~~~~~~~~~~~~~
290294e8 152option:-a, option:--all-events::
484b2a0c 153 Disable recording event rules regardless of their event name
188419c4 154 condition.
484b2a0c 155
290294e8 156
55e06994 157include::common-lttng-cmd-help-options.txt[]
290294e8
PP
158
159
55e06994
PP
160include::common-lttng-cmd-after-options.txt[]
161
162
6e8afcda
PP
163[[examples]]
164EXAMPLES
165--------
aaae4813 166.Disable all Linux kernel tracepoint recording event rules in the default channel of the current recording session.
6e8afcda
PP
167====
168See the option:--all-events option.
169
170[role="term"]
171----
172$ lttng disable-event --kernel --tracepoint --all-events
173----
174====
175
aaae4813 176.Disable specific Apache log4j recording event rules in the default channel of a specific recording session.
6e8afcda
PP
177====
178See the option:--session option.
179
180[role="term"]
181----
182$ lttng disable-event --session=my-session --log4j \
183 MySingleton,MyProxy,MyFacade
184----
185====
186
aaae4813 187.Disable all user space recording event rules in a specific channel of the current recording session.
6e8afcda
PP
188====
189See the option:--channel option.
190
191[role="term"]
192----
193$ lttng disable-event --channel=my-channel --userspace \
194 --all-events
195----
196====
197
aaae4813 198.Disable specific Linux kernel system call recording event rules in the default channel of the current recording session.
6e8afcda
PP
199====
200[role="term"]
201----
202$ lttng disable-event --kernel --syscall pipe2,eventfd
203----
204====
205
206
55e06994 207include::common-footer.txt[]
290294e8
PP
208
209
210SEE ALSO
211--------
484b2a0c 212man:lttng(1),
7c1a4458 213man:lttng-enable-event(1),
21b35b3a
PP
214man:lttng-list(1),
215man:lttng-concepts(7)
This page took 0.057114 seconds and 5 git commands to generate.