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 | ||
56 | Example | |
57 | ~~~~~~~ | |
188419c4 PP |
58 | A common operation is to create a tracing session (see |
59 | man:lttng-create(1)), remove all the entries from the PID tracker | |
60 | inclusion set, start tracing, and then manually track PIDs while the | |
61 | tracing session is active. | |
882443a6 PP |
62 | |
63 | Assume the maximum system PID is 7 for this example. | |
64 | ||
188419c4 PP |
65 | . Command: |
66 | + | |
d4f093aa | 67 | [role="term"] |
03c5529d PP |
68 | ---- |
69 | $ lttng create | |
70 | ---- | |
188419c4 | 71 | + |
de332339 | 72 | Initial inclusion set: |
188419c4 | 73 | + |
882443a6 PP |
74 | ------------------------------- |
75 | [0] [1] [2] [3] [4] [5] [6] [7] | |
76 | ------------------------------- | |
77 | ||
188419c4 PP |
78 | . Command: |
79 | + | |
d4f093aa | 80 | [role="term"] |
03c5529d | 81 | ---- |
de332339 | 82 | $ lttng untrack --kernel --pid --all |
03c5529d | 83 | ---- |
188419c4 PP |
84 | + |
85 | Inclusion set: | |
86 | + | |
882443a6 PP |
87 | ------------------------------- |
88 | [ ] [ ] [ ] [ ] [ ] [ ] [ ] [ ] | |
89 | ------------------------------- | |
90 | ||
188419c4 PP |
91 | . Commands: |
92 | + | |
d4f093aa | 93 | [role="term"] |
03c5529d | 94 | ---- |
de332339 | 95 | $ lttng enable-event --kernel ... |
03c5529d PP |
96 | $ lttng start |
97 | $ # ... | |
de332339 | 98 | $ lttng track --kernel --pid=3,5 |
03c5529d | 99 | ---- |
188419c4 PP |
100 | + |
101 | Inclusion set: | |
102 | + | |
882443a6 PP |
103 | ------------------------------- |
104 | [ ] [ ] [ ] [3] [ ] [5] [ ] [ ] | |
105 | ------------------------------- | |
106 | ||
188419c4 PP |
107 | . Command: |
108 | + | |
d4f093aa | 109 | [role="term"] |
03c5529d | 110 | ---- |
de332339 | 111 | $ lttng track --kernel --pid=2 |
03c5529d | 112 | ---- |
188419c4 PP |
113 | + |
114 | Inclusion set: | |
115 | + | |
882443a6 PP |
116 | ------------------------------- |
117 | [ ] [ ] [2] [3] [ ] [5] [ ] [ ] | |
118 | ------------------------------- | |
119 | ||
120 | ||
121 | include::common-cmd-options-head.txt[] | |
122 | ||
123 | ||
188419c4 PP |
124 | Tracing domain |
125 | ~~~~~~~~~~~~~~ | |
882443a6 PP |
126 | One of: |
127 | ||
128 | option:-k, option:--kernel:: | |
188419c4 | 129 | Remove values from one or more Linux kernel inclusion sets. |
882443a6 PP |
130 | |
131 | option:-u, option:--userspace:: | |
188419c4 | 132 | Remove values from one or more user space inclusion sets. |
882443a6 PP |
133 | |
134 | ||
188419c4 PP |
135 | Recording target |
136 | ~~~~~~~~~~~~~~~~ | |
de332339 | 137 | option:-s 'SESSION', option:--session='SESSION':: |
188419c4 PP |
138 | Remove values from one or more inclusion sets of the tracing session |
139 | named 'SESSION' instead of the current tracing session. | |
882443a6 PP |
140 | |
141 | ||
188419c4 PP |
142 | Inclusion set selection |
143 | ~~~~~~~~~~~~~~~~~~~~~~~ | |
59b19c3c | 144 | option:-p ['PID'[,'PID']...], option:--pid[='PID'[,'PID']...]:: |
188419c4 PP |
145 | For each 'PID' argument, remove 'PID' from the process ID inclusion |
146 | set of the selected tracing session and domain. | |
de332339 | 147 | + |
188419c4 PP |
148 | 'PID' is the process ID attribute of a process as seen from the root |
149 | PID namespace (see man:pid_namespaces(7)). | |
882443a6 | 150 | + |
188419c4 | 151 | Only available with option:--kernel option. |
882443a6 | 152 | |
de332339 | 153 | option:--vpid[='VPID'[,'VPID']...]:: |
188419c4 PP |
154 | For each 'VPID' argument, remove 'VPID' from the virtual process ID |
155 | inclusion set of the selected tracing session and domain. | |
de332339 JG |
156 | + |
157 | 'VPID' is the virtual process ID attribute of a process as seen from | |
188419c4 | 158 | the PID namespace of the process (see man:pid_namespaces(7)). |
de332339 JG |
159 | |
160 | option:--uid[='USER'[,'USER']...]:: | |
188419c4 PP |
161 | For each 'USER' argument, remove 'USER' from the user ID inclusion |
162 | set of the selected tracing session and domain. | |
163 | + | |
164 | 'USER' is either: | |
de332339 | 165 | + |
188419c4 PP |
166 | -- |
167 | * The real user ID (see man:getuid(3)) of a process as seen | |
168 | from the root user namespace (see man:user_namespaces(7)). | |
169 | ||
170 | * A user name. | |
de332339 | 171 | + |
188419c4 PP |
172 | The connected LTTng session daemon (see man:lttng-sessiond(8)) performs |
173 | the user name resolution on removal from the user ID inclusion set. | |
174 | -- | |
de332339 | 175 | + |
188419c4 | 176 | Only available with option:--kernel option. |
de332339 | 177 | |
188419c4 PP |
178 | option:--vuid[='VUSER'[,'VUSER']...]:: |
179 | For each 'VUSER' argument, remove 'VUSER' from the virtual user ID | |
180 | inclusion set of the selected tracing session and domain. | |
de332339 | 181 | + |
188419c4 | 182 | 'VUSER' is either: |
de332339 | 183 | + |
188419c4 PP |
184 | -- |
185 | * The real user ID (see man:getuid(3)) of a process as seen | |
186 | from the user namespace (see man:user_namespaces(7)). | |
187 | ||
188 | * A user name. | |
de332339 | 189 | + |
188419c4 PP |
190 | The connected LTTng session daemon (see man:lttng-sessiond(8)) performs |
191 | the user name resolution on removal from the virtual user ID inclusion | |
192 | set. | |
193 | -- | |
de332339 JG |
194 | |
195 | option:--gid[='GROUP'[,'GROUP']...]:: | |
188419c4 PP |
196 | For each 'GROUP' argument, remove 'GROUP' from the group ID |
197 | inclusion set of the selected tracing session and domain. | |
198 | + | |
199 | 'GROUP' is either: | |
de332339 | 200 | + |
188419c4 PP |
201 | -- |
202 | * The real group ID (see man:getgid(3)) of a process as seen from the | |
203 | root user namespace (see man:user_namespaces(7)). | |
204 | ||
205 | * A group name. | |
de332339 | 206 | + |
188419c4 PP |
207 | The connected LTTng session daemon (see man:lttng-sessiond(8)) performs |
208 | the group name resolution on removal from the group ID inclusion set. | |
209 | -- | |
de332339 | 210 | + |
188419c4 | 211 | Only available with option:--kernel option. |
de332339 | 212 | |
188419c4 PP |
213 | option:--vgid[='VGROUP'[,'VGROUP']...]:: |
214 | For each 'VGROUP' argument, remove 'VGROUP' from the virtual group | |
215 | ID inclusion set of the selected tracing session and domain. | |
de332339 | 216 | + |
188419c4 | 217 | 'VGROUP' is either: |
de332339 | 218 | + |
188419c4 PP |
219 | -- |
220 | * The real group ID (see man:getgid(3)) of a process as seen | |
221 | from the user namespace (see man:user_namespaces(7)). | |
222 | ||
223 | * A group name. | |
de332339 | 224 | + |
188419c4 PP |
225 | The connected LTTng session daemon (see man:lttng-sessiond(8)) performs |
226 | the group name resolution on removal from the virtual group ID inclusion | |
227 | set. | |
228 | -- | |
229 | ||
230 | ||
231 | Inclusion set operation | |
232 | ~~~~~~~~~~~~~~~~~~~~~~~ | |
233 | option:-a, option:--all:: | |
234 | With one or more empty option:--pid, option:--vpid, option:--uid, | |
235 | option:--vuid, option:--gid, and option:--vgid options: clear the | |
236 | selected inclusion sets. | |
de332339 | 237 | |
882443a6 PP |
238 | |
239 | include::common-cmd-help-options.txt[] | |
240 | ||
241 | ||
242 | include::common-cmd-footer.txt[] | |
243 | ||
244 | ||
245 | SEE ALSO | |
246 | -------- | |
188419c4 PP |
247 | man:lttng(1), |
248 | man:lttng-concepts(7), | |
249 | man:lttng-track(1) |