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