Commit | Line | Data |
---|---|---|
882443a6 PP |
1 | lttng-untrack(1) |
2 | ================ | |
3 | ||
4 | ||
5 | NAME | |
6 | ---- | |
7 | lttng-untrack - Remove one or more entries from an LTTng resource tracker | |
8 | ||
9 | ||
10 | SYNOPSIS | |
11 | -------- | |
12 | [verse] | |
13 | *lttng* ['GENERAL OPTIONS'] *untrack* (option:--kernel | option:--userspace) | |
14 | [option:--session='SESSION'] (option:--pid='PID'[,'PID']... | option:--all option:--pid) | |
15 | ||
16 | ||
17 | DESCRIPTION | |
18 | ----------- | |
19 | The `lttng untrack` commands removes one or more entries from a | |
20 | resource tracker. | |
21 | ||
22 | See linklttng:lttng-track(1) to learn more about LTTng trackers. | |
23 | ||
24 | The untrack command removes specific resources from a tracker. The | |
25 | resources to remove must have been precedently added by | |
26 | linklttng:lttng-track(1). It is also possible to remove all the | |
27 | resources from the whitelist using the option:--all option. | |
28 | ||
29 | As of this version, the only available tracker is the PID tracker. | |
30 | ||
31 | ||
32 | Example | |
33 | ~~~~~~~ | |
34 | One common operation is to create a tracing session | |
35 | (see linklttng:lttng-create(1)), remove all the entries from the PID | |
36 | tracker whitelist, start tracing, and then manually track PIDs | |
37 | while tracing is active. | |
38 | ||
39 | Assume the maximum system PID is 7 for this example. | |
40 | ||
41 | Command: | |
42 | ||
43 | ------------ | |
44 | lttng create | |
45 | ------------ | |
46 | ||
47 | Initial whitelist: | |
48 | ||
49 | ------------------------------- | |
50 | [0] [1] [2] [3] [4] [5] [6] [7] | |
51 | ------------------------------- | |
52 | ||
53 | Command: | |
54 | ||
55 | ------------------------------------- | |
56 | lttng untrack --userspace --pid --all | |
57 | ------------------------------------- | |
58 | ||
59 | Whitelist: | |
60 | ||
61 | ------------------------------- | |
62 | [ ] [ ] [ ] [ ] [ ] [ ] [ ] [ ] | |
63 | ------------------------------- | |
64 | ||
65 | Commands: | |
66 | ||
67 | ---------------------------------- | |
68 | lttng enable-event --userspace ... | |
69 | lttng start | |
70 | ... | |
71 | lttng track --userspace --pid=3,5 | |
72 | ---------------------------------- | |
73 | ||
74 | Whitelist: | |
75 | ||
76 | ------------------------------- | |
77 | [ ] [ ] [ ] [3] [ ] [5] [ ] [ ] | |
78 | ------------------------------- | |
79 | ||
80 | Command: | |
81 | ||
82 | ------------------------------- | |
83 | lttng track --userspace --pid=2 | |
84 | ------------------------------- | |
85 | ||
86 | Whitelist: | |
87 | ||
88 | ------------------------------- | |
89 | [ ] [ ] [2] [3] [ ] [5] [ ] [ ] | |
90 | ------------------------------- | |
91 | ||
92 | ||
93 | include::common-cmd-options-head.txt[] | |
94 | ||
95 | ||
96 | Domain | |
97 | ~~~~~~ | |
98 | One of: | |
99 | ||
100 | option:-k, option:--kernel:: | |
101 | Untrack resources tracked in the Linux kernel domain. | |
102 | ||
103 | option:-u, option:--userspace:: | |
104 | Untrack resources tracked in the user space domain. | |
105 | ||
106 | ||
107 | Target | |
108 | ~~~~~~ | |
109 | option:-s, option:--session='SESSION':: | |
110 | Untrack resources in the tracing session named 'SESSION' instead of | |
111 | the current tracing session. | |
112 | ||
113 | ||
114 | Untracking | |
115 | ~~~~~~~~~~ | |
116 | option:-a, option:--all:: | |
117 | Used in conjunction with an empty option:--pid option: untrack _all_ | |
118 | process IDs (clear the whitelist). | |
119 | ||
120 | option:-p, option:--pid[='PID'[,'PID']...]:: | |
121 | Untrack process IDs 'PID' (remove them from the current whitelist). | |
122 | + | |
123 | The 'PID' argument must be omitted when also using the option:--all | |
124 | option. | |
125 | ||
126 | ||
127 | include::common-cmd-help-options.txt[] | |
128 | ||
129 | ||
130 | include::common-cmd-footer.txt[] | |
131 | ||
132 | ||
133 | SEE ALSO | |
134 | -------- | |
135 | linklttng:lttng-track(1), | |
136 | linklttng:lttng(1) |