X-Git-Url: http://git.lttng.org/?a=blobdiff_plain;f=doc%2Fman%2Flttng-untrack.1.txt;h=771c5e69cb49fe6c36481f83caeb1cb22274cc9c;hb=a55e08e0d331c3c0f75fbc76df660e954ee1337a;hp=01e82b1b4368bbab722f9ebfb4478722885c6e76;hpb=26f0c7794376456fcb5b13d4eae91c0ccf0dfe66;p=lttng-tools.git diff --git a/doc/man/lttng-untrack.1.txt b/doc/man/lttng-untrack.1.txt index 01e82b1b4..771c5e69c 100644 --- a/doc/man/lttng-untrack.1.txt +++ b/doc/man/lttng-untrack.1.txt @@ -1,6 +1,6 @@ lttng-untrack(1) ================ -:revdate: 1 May 2021 +:revdate: 17 May 2021 NAME @@ -52,13 +52,15 @@ recording event rules. The `untrack` command removes values from _inclusion sets_ of process attributes. See man:lttng-track(1) to learn more about inclusion sets. +See the <> section below for usage examples. -Example -~~~~~~~ + +Inclusion set example +~~~~~~~~~~~~~~~~~~~~~ A common operation is to create a tracing session (see -man:lttng-create(1)), remove all the entries from the PID tracker -inclusion set, start tracing, and then manually track PIDs while the -tracing session is active. +man:lttng-create(1)), remove all the entries from the Linux kernel +process ID inclusion set, start tracing, and then manually add PIDs +while the tracing session is active. Assume the maximum system PID is 7 for this example. @@ -79,7 +81,7 @@ Initial inclusion set: + [role="term"] ---- -$ lttng untrack --kernel --pid --all +$ lttng untrack --kernel --all --pid ---- + Inclusion set: @@ -118,7 +120,7 @@ Inclusion set: ------------------------------- -include::common-cmd-options-head.txt[] +include::common-lttng-cmd-options-head.txt[] Tracing domain @@ -236,14 +238,52 @@ option:-a, option:--all:: selected inclusion sets. -include::common-cmd-help-options.txt[] +include::common-lttng-cmd-help-options.txt[] + + +include::common-lttng-cmd-after-options.txt[] + + +[[examples]] +EXAMPLES +-------- +.Remove the PIDs 1728 and 3775 from the Linux kernel process ID inclusion set of the current tracing session. +==== +See the option:--pid option. + +[role="term"] +---- +$ lttng untrack --kernel --pid=1728,3775 +---- +==== + +.Remove the IDs of a specific groups from the user space virtual group ID inclusion set of a specific tracing session. +==== +See the option:--vgid and option:--session options. + +[role="term"] +---- +$ lttng untrack --userspace --session=my-session \ + --vgid=docker,mysql +---- +==== + +.Remove all the user IDs from the Linux kernel user ID inclusion set of the current tracing session. +==== +See the option:--all and option:--uid options. + +[role="term"] +---- +$ lttng untrack --kernel --all --uid +---- +==== -include::common-cmd-footer.txt[] +include::common-footer.txt[] SEE ALSO -------- man:lttng(1), -man:lttng-concepts(7), -man:lttng-track(1) +man:lttng-track(1), +man:lttng-concepts(7)