doc/man/lttng-untrack.1.txt

   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* ['linkgenoptions:(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 man: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 man: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 man: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 [role="term"]
  44 ----
  45 $ lttng create
  46 ----
  47
  48 Initial whitelist:
  49
  50 -------------------------------
  51 [0] [1] [2] [3] [4] [5] [6] [7]
  52 -------------------------------
  53
  54 Command:
  55
  56 [role="term"]
  57 ----
  58 $ lttng untrack --userspace --pid --all
  59 ----
  60
  61 Whitelist:
  62
  63 -------------------------------
  64 [ ] [ ] [ ] [ ] [ ] [ ] [ ] [ ]
  65 -------------------------------
  66
  67 Commands:
  68
  69 [role="term"]
  70 ----
  71 $ lttng enable-event --userspace ...
  72 $ lttng start
  73 $ # ...
  74 $ lttng track --userspace --pid=3,5
  75 ----
  76
  77 Whitelist:
  78
  79 -------------------------------
  80 [ ] [ ] [ ] [3] [ ] [5] [ ] [ ]
  81 -------------------------------
  82
  83 Command:
  84
  85 [role="term"]
  86 ----
  87 $ lttng track --userspace --pid=2
  88 ----
  89
  90 Whitelist:
  91
  92 -------------------------------
  93 [ ] [ ] [2] [3] [ ] [5] [ ] [ ]
  94 -------------------------------
  95
  96
  97 include::common-cmd-options-head.txt[]
  98
  99
 100 Domain
 101 ~~~~~~
 102 One of:
 103
 104 option:-k, option:--kernel::
 105     Untrack resources tracked in the Linux kernel domain.
 106
 107 option:-u, option:--userspace::
 108     Untrack resources tracked in the user space domain.
 109
 110
 111 Target
 112 ~~~~~~
 113 option:-s, option:--session='SESSION'::
 114     Untrack resources in the tracing session named 'SESSION' instead of
 115     the current tracing session.
 116
 117
 118 Untracking
 119 ~~~~~~~~~~
 120 option:-a, option:--all::
 121     Used in conjunction with an empty option:--pid option: untrack _all_
 122     process IDs (clear the whitelist).
 123
 124 option:-p ['PID'[,'PID']...], option:--pid[='PID'[,'PID']...]::
 125     Untrack process IDs 'PID' (remove them from the current whitelist).
 126 +
 127 The 'PID' argument must be omitted when also using the option:--all
 128 option.
 129
 130
 131 include::common-cmd-help-options.txt[]
 132
 133
 134 include::common-cmd-footer.txt[]
 135
 136
 137 SEE ALSO
 138 --------
 139 man:lttng-track(1),
 140 man:lttng(1)