Commit | Line | Data |
---|---|---|
882443a6 PP |
1 | lttng-untrack(1) |
2 | ================ | |
188419c4 | 3 | :revdate: 1 May 2021 |
882443a6 PP |
4 | |
5 | ||
6 | NAME | |
7 | ---- | |
188419c4 | 8 | lttng-untrack - Disallow specific processes to record LTTng events |
882443a6 PP |
9 | |
10 | ||
11 | SYNOPSIS | |
12 | -------- | |
188419c4 | 13 | Disallow specific processes to record Linux kernel events: |
de332339 JG |
14 | |
15 | [verse] | |
188419c4 | 16 | *lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *untrack* option:--kernel [option:--session='SESSION'] |
de332339 | 17 | (option:--pid=PID[,PID]... | option:--vpid=VPID[,VPID]... | |
188419c4 PP |
18 | option:--uid=UID[,UID]... | option:--vuid=VUSER[,VUSER]... | |
19 | option:--gid=GID[,GID]... | option:--vgid=VGROUP[,VGROUP]...)... | |
de332339 JG |
20 | |
21 | [verse] | |
188419c4 PP |
22 | *lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *untrack* option:--kernel [option:--session='SESSION'] |
23 | option:--all (option:--pid | option:--vpid | option:--uid | option:--vuid | option:--gid | option:--vgid)... | |
de332339 | 24 | |
188419c4 | 25 | Disallow specific processes to record user space events: |
de332339 JG |
26 | |
27 | [verse] | |
188419c4 PP |
28 | *lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *untrack* option:--userspace [option:--session='SESSION'] |
29 | (option:--vpid=VPID[,VPID]... | option:--vuid=VUSER[,VUSER]... | | |
30 | option:--vgid=VGROUP[,VGROUP]...)... | |
de332339 | 31 | |
882443a6 | 32 | [verse] |
188419c4 | 33 | *lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *untrack* option:--userspace [option:--session='SESSION'] |
de332339 | 34 | option:--all (option:--vpid | option:--vgid | option:--vuid)... |
882443a6 PP |
35 | |
36 | ||
37 | DESCRIPTION | |
38 | ----------- | |
188419c4 PP |
39 | The `lttng untrack` command disallows one or more processes to record |
40 | LTTng events based on their attributes within: | |
41 | ||
42 | With the option:--session='SESSION' option:: | |
43 | The tracing session named 'SESSION'. | |
882443a6 | 44 | |
188419c4 PP |
45 | Without the option:--session option:: |
46 | The current tracing session (see man:lttng-concepts(7) to learn more | |
47 | about the current tracing session). | |
882443a6 | 48 | |
188419c4 PP |
49 | See man:lttng-concepts(7) to learn more about tracing sessions and |
50 | recording event rules. | |
51 | ||
52 | The `untrack` command removes values from _inclusion sets_ of process | |
53 | attributes. See man:lttng-track(1) to learn more about inclusion sets. | |
882443a6 PP |
54 | |
55 | ||
0e9929b4 PP |
56 | |
57 | Inclusion set example | |
58 | ~~~~~~~~~~~~~~~~~~~~~ | |
188419c4 | 59 | A common operation is to create a tracing session (see |
0e9929b4 PP |
60 | man:lttng-create(1)), remove all the entries from the Linux kernel |
61 | process ID inclusion set, start tracing, and then manually add PIDs | |
62 | while the tracing session is active. | |
882443a6 PP |
63 | |
64 | Assume the maximum system PID is 7 for this example. | |
65 | ||
188419c4 PP |
66 | . Command: |
67 | + | |
d4f093aa | 68 | [role="term"] |
03c5529d PP |
69 | ---- |
70 | $ lttng create | |
71 | ---- | |
188419c4 | 72 | + |
de332339 | 73 | Initial inclusion set: |
188419c4 | 74 | + |
882443a6 PP |
75 | ------------------------------- |
76 | [0] [1] [2] [3] [4] [5] [6] [7] | |
77 | ------------------------------- | |
78 | ||
188419c4 PP |
79 | . Command: |
80 | + | |
d4f093aa | 81 | [role="term"] |
03c5529d | 82 | ---- |
0e9929b4 | 83 | $ lttng untrack --kernel --all --pid |
03c5529d | 84 | ---- |
188419c4 PP |
85 | + |
86 | Inclusion set: | |
87 | + | |
882443a6 PP |
88 | ------------------------------- |
89 | [ ] [ ] [ ] [ ] [ ] [ ] [ ] [ ] | |
90 | ------------------------------- | |
91 | ||
188419c4 PP |
92 | . Commands: |
93 | + | |
d4f093aa | 94 | [role="term"] |
03c5529d | 95 | ---- |
de332339 | 96 | $ lttng enable-event --kernel ... |
03c5529d PP |
97 | $ lttng start |
98 | $ # ... | |
de332339 | 99 | $ lttng track --kernel --pid=3,5 |
03c5529d | 100 | ---- |
188419c4 PP |
101 | + |
102 | Inclusion set: | |
103 | + | |
882443a6 PP |
104 | ------------------------------- |
105 | [ ] [ ] [ ] [3] [ ] [5] [ ] [ ] | |
106 | ------------------------------- | |
107 | ||
188419c4 PP |
108 | . Command: |
109 | + | |
d4f093aa | 110 | [role="term"] |
03c5529d | 111 | ---- |
de332339 | 112 | $ lttng track --kernel --pid=2 |
03c5529d | 113 | ---- |
188419c4 PP |
114 | + |
115 | Inclusion set: | |
116 | + | |
882443a6 PP |
117 | ------------------------------- |
118 | [ ] [ ] [2] [3] [ ] [5] [ ] [ ] | |
119 | ------------------------------- | |
120 | ||
121 | ||
55e06994 | 122 | include::common-lttng-cmd-options-head.txt[] |
882443a6 PP |
123 | |
124 | ||
188419c4 PP |
125 | Tracing domain |
126 | ~~~~~~~~~~~~~~ | |
882443a6 PP |
127 | One of: |
128 | ||
129 | option:-k, option:--kernel:: | |
188419c4 | 130 | Remove values from one or more Linux kernel inclusion sets. |
882443a6 PP |
131 | |
132 | option:-u, option:--userspace:: | |
188419c4 | 133 | Remove values from one or more user space inclusion sets. |
882443a6 PP |
134 | |
135 | ||
188419c4 PP |
136 | Recording target |
137 | ~~~~~~~~~~~~~~~~ | |
de332339 | 138 | option:-s 'SESSION', option:--session='SESSION':: |
188419c4 PP |
139 | Remove values from one or more inclusion sets of the tracing session |
140 | named 'SESSION' instead of the current tracing session. | |
882443a6 PP |
141 | |
142 | ||
188419c4 PP |
143 | Inclusion set selection |
144 | ~~~~~~~~~~~~~~~~~~~~~~~ | |
59b19c3c | 145 | option:-p ['PID'[,'PID']...], option:--pid[='PID'[,'PID']...]:: |
188419c4 PP |
146 | For each 'PID' argument, remove 'PID' from the process ID inclusion |
147 | set of the selected tracing session and domain. | |
de332339 | 148 | + |
188419c4 PP |
149 | 'PID' is the process ID attribute of a process as seen from the root |
150 | PID namespace (see man:pid_namespaces(7)). | |
882443a6 | 151 | + |
188419c4 | 152 | Only available with option:--kernel option. |
882443a6 | 153 | |
de332339 | 154 | option:--vpid[='VPID'[,'VPID']...]:: |
188419c4 PP |
155 | For each 'VPID' argument, remove 'VPID' from the virtual process ID |
156 | inclusion set of the selected tracing session and domain. | |
de332339 JG |
157 | + |
158 | 'VPID' is the virtual process ID attribute of a process as seen from | |
188419c4 | 159 | the PID namespace of the process (see man:pid_namespaces(7)). |
de332339 JG |
160 | |
161 | option:--uid[='USER'[,'USER']...]:: | |
188419c4 PP |
162 | For each 'USER' argument, remove 'USER' from the user ID inclusion |
163 | set of the selected tracing session and domain. | |
164 | + | |
165 | 'USER' is either: | |
de332339 | 166 | + |
188419c4 PP |
167 | -- |
168 | * The real user ID (see man:getuid(3)) of a process as seen | |
169 | from the root user namespace (see man:user_namespaces(7)). | |
170 | ||
171 | * A user name. | |
de332339 | 172 | + |
188419c4 PP |
173 | The connected LTTng session daemon (see man:lttng-sessiond(8)) performs |
174 | the user name resolution on removal from the user ID inclusion set. | |
175 | -- | |
de332339 | 176 | + |
188419c4 | 177 | Only available with option:--kernel option. |
de332339 | 178 | |
188419c4 PP |
179 | option:--vuid[='VUSER'[,'VUSER']...]:: |
180 | For each 'VUSER' argument, remove 'VUSER' from the virtual user ID | |
181 | inclusion set of the selected tracing session and domain. | |
de332339 | 182 | + |
188419c4 | 183 | 'VUSER' is either: |
de332339 | 184 | + |
188419c4 PP |
185 | -- |
186 | * The real user ID (see man:getuid(3)) of a process as seen | |
187 | from the user namespace (see man:user_namespaces(7)). | |
188 | ||
189 | * A user name. | |
de332339 | 190 | + |
188419c4 PP |
191 | The connected LTTng session daemon (see man:lttng-sessiond(8)) performs |
192 | the user name resolution on removal from the virtual user ID inclusion | |
193 | set. | |
194 | -- | |
de332339 JG |
195 | |
196 | option:--gid[='GROUP'[,'GROUP']...]:: | |
188419c4 PP |
197 | For each 'GROUP' argument, remove 'GROUP' from the group ID |
198 | inclusion set of the selected tracing session and domain. | |
199 | + | |
200 | 'GROUP' is either: | |
de332339 | 201 | + |
188419c4 PP |
202 | -- |
203 | * The real group ID (see man:getgid(3)) of a process as seen from the | |
204 | root user namespace (see man:user_namespaces(7)). | |
205 | ||
206 | * A group name. | |
de332339 | 207 | + |
188419c4 PP |
208 | The connected LTTng session daemon (see man:lttng-sessiond(8)) performs |
209 | the group name resolution on removal from the group ID inclusion set. | |
210 | -- | |
de332339 | 211 | + |
188419c4 | 212 | Only available with option:--kernel option. |
de332339 | 213 | |
188419c4 PP |
214 | option:--vgid[='VGROUP'[,'VGROUP']...]:: |
215 | For each 'VGROUP' argument, remove 'VGROUP' from the virtual group | |
216 | ID inclusion set of the selected tracing session and domain. | |
de332339 | 217 | + |
188419c4 | 218 | 'VGROUP' is either: |
de332339 | 219 | + |
188419c4 PP |
220 | -- |
221 | * The real group ID (see man:getgid(3)) of a process as seen | |
222 | from the user namespace (see man:user_namespaces(7)). | |
223 | ||
224 | * A group name. | |
de332339 | 225 | + |
188419c4 PP |
226 | The connected LTTng session daemon (see man:lttng-sessiond(8)) performs |
227 | the group name resolution on removal from the virtual group ID inclusion | |
228 | set. | |
229 | -- | |
230 | ||
231 | ||
232 | Inclusion set operation | |
233 | ~~~~~~~~~~~~~~~~~~~~~~~ | |
234 | option:-a, option:--all:: | |
235 | With one or more empty option:--pid, option:--vpid, option:--uid, | |
236 | option:--vuid, option:--gid, and option:--vgid options: clear the | |
237 | selected inclusion sets. | |
de332339 | 238 | |
882443a6 | 239 | |
55e06994 | 240 | include::common-lttng-cmd-help-options.txt[] |
882443a6 PP |
241 | |
242 | ||
55e06994 PP |
243 | include::common-lttng-cmd-after-options.txt[] |
244 | ||
245 | ||
246 | include::common-footer.txt[] | |
882443a6 PP |
247 | |
248 | ||
249 | SEE ALSO | |
250 | -------- | |
188419c4 | 251 | man:lttng(1), |
21b35b3a PP |
252 | man:lttng-track(1), |
253 | man:lttng-concepts(7) |