Commit | Line | Data |
---|---|---|
290294e8 PP |
1 | lttng-disable-event(1) |
2 | ====================== | |
26f0c779 | 3 | :revdate: 3 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) | |
26f0c779 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 | |
d6b9e598 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 | ||
26f0c779 | 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 PP |
76 | |
77 | ||
f5511eea | 78 | include::common-lttng-cmd-options-head.txt[] |
290294e8 PP |
79 | |
80 | ||
484b2a0c PP |
81 | Tracing domain |
82 | ~~~~~~~~~~~~~~ | |
290294e8 PP |
83 | One of: |
84 | ||
85 | option:-j, option:--jul:: | |
484b2a0c PP |
86 | Disable recording event rules in the `java.util.logging` (JUL) |
87 | domain. | |
290294e8 PP |
88 | |
89 | option:-k, option:--kernel:: | |
484b2a0c | 90 | Disable recording event rules in the Linux kernel domain. |
290294e8 PP |
91 | |
92 | option:-l, option:--log4j:: | |
484b2a0c | 93 | Disable recording event rules in the Apache log4j domain. |
290294e8 PP |
94 | |
95 | option:-p, option:--python:: | |
484b2a0c | 96 | Disable recording event rules in the Python domain. |
290294e8 PP |
97 | |
98 | option:-u, option:--userspace:: | |
484b2a0c | 99 | Disable recording event rules in the user space tracing domain. |
290294e8 PP |
100 | |
101 | ||
484b2a0c PP |
102 | Recording target |
103 | ~~~~~~~~~~~~~~~~ | |
59b19c3c | 104 | option:-c 'CHANNEL', option:--channel='CHANNEL':: |
484b2a0c PP |
105 | Disable recording event rules attached to the channel named |
106 | 'CHANNEL' instead of `channel0`. | |
290294e8 | 107 | |
59b19c3c | 108 | option:-s 'SESSION', option:--session='SESSION':: |
484b2a0c | 109 | Disable recording event rules in the tracing session named 'SESSION' |
290294e8 PP |
110 | instead of the current tracing session. |
111 | ||
112 | ||
484b2a0c PP |
113 | Instrumentation point type condition |
114 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
115 | At most one of: | |
290294e8 PP |
116 | |
117 | option:--function:: | |
484b2a0c PP |
118 | Only disable recording event rules which match Linux kretprobe |
119 | events. | |
120 | + | |
121 | Only available with the option:--kernel option. | |
290294e8 PP |
122 | |
123 | option:--probe:: | |
484b2a0c PP |
124 | Only disable recording event rules which match Linux kprobe events. |
125 | + | |
126 | Only available with the option:--kernel option. | |
290294e8 PP |
127 | |
128 | option:--syscall:: | |
484b2a0c PP |
129 | Only disable recording event rules which match Linux system call |
130 | events. | |
131 | + | |
132 | Only available with the option:--kernel option. | |
290294e8 PP |
133 | |
134 | option:--tracepoint:: | |
484b2a0c PP |
135 | Only disable recording event rules which match: |
136 | + | |
137 | -- | |
138 | With the option:--kernel or option:--userspace option::: | |
139 | LTTng tracepoint events. | |
140 | With the option:--jul, option:--log4j, or option:--python option::: | |
141 | Logging events. | |
142 | -- | |
484b2a0c PP |
143 | |
144 | ||
145 | Event name condition | |
146 | ~~~~~~~~~~~~~~~~~~~~ | |
290294e8 | 147 | option:-a, option:--all-events:: |
484b2a0c | 148 | Disable recording event rules regardless of their event name |
26f0c779 | 149 | condition. |
484b2a0c | 150 | |
290294e8 | 151 | |
f5511eea | 152 | include::common-lttng-cmd-help-options.txt[] |
290294e8 PP |
153 | |
154 | ||
f5511eea PP |
155 | include::common-lttng-cmd-after-options.txt[] |
156 | ||
157 | ||
158 | include::common-footer.txt[] | |
290294e8 PP |
159 | |
160 | ||
161 | SEE ALSO | |
162 | -------- | |
484b2a0c | 163 | man:lttng(1), |
7c1a4458 | 164 | man:lttng-enable-event(1), |
af1c4164 PP |
165 | man:lttng-list(1), |
166 | man:lttng-concepts(7) |