doc/man/lttng-untrack.1.txt

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