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