doc/man/lttng-clear.1.txt

   1 lttng-clear(1)
   2 ==============
   3 :revdate: 17 May 2021
   4
   5 NAME
   6 ----
   7 lttng-clear - Clear an LTTng tracing session
   8
   9
  10 SYNOPSIS
  11 --------
  12 [verse]
  13 *lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *clear* ['SESSION' | option:--all]
  14
  15
  16 DESCRIPTION
  17 -----------
  18 The `lttng clear` command clears one or more tracing sessions, that is,
  19 it deletes the contents of their tracing buffers and of all their local
  20 and streamed trace data.
  21
  22 See man:lttng-concepts(7) to learn more about tracing sessions.
  23
  24 The `clear` command clears:
  25
  26 Without any option::
  27     The current tracing session.
  28 +
  29 See man:lttng-concepts(7) to learn more about the current tracing
  30 session.
  31
  32 With the 'SESSION' argument::
  33     The tracing session named 'SESSION'.
  34
  35 With the option:--all option::
  36     *All* the tracing sessions of the connected session daemon for your
  37     Unix user, or for all users if your Unix user is `root`, as listed
  38     in the output of `lttng list` (see man:lttng-list(1)).
  39 +
  40 See the ``Session daemon connection'' section of man:lttng(1) to learn
  41 how a user application connects to a session daemon.
  42
  43 If a tracing session is configured in snapshot mode (see the
  44 nloption:--snapshot option of the man:lttng-create(1) command), the
  45 `clear` command only clears the tracing buffers.
  46
  47 For a given tracing session, if at least one rotation occurred (see
  48 man:lttng-concepts(7)), the `clear` command only clears its tracing
  49 buffers and its current trace chunk, :not: its archived trace chunks.
  50
  51 NOTE: The nloption:--disallow-clear option and the
  52 `LTTNG_RELAYD_DISALLOW_CLEAR` environment variable of
  53 man:lttng-relayd(8) can disable remote clearing operations. If LTTng
  54 sends tracing data over the network for the selected tracing session(s)
  55 to an LTTng relay daemon configured as such, the `clear` command fails.
  56
  57 See the ``<<examples,EXAMPLES>>'' section below for usage examples.
  58
  59
  60 include::common-lttng-cmd-options-head.txt[]
  61
  62
  63 Recording target
  64 ~~~~~~~~~~~~~~~~
  65 option:-a, option:--all::
  66     Clear all the tracing sessions of your Unix user, or of all users if
  67     your Unix user is `root`, as listed in the output of
  68     man:lttng-list(1), instead of the current tracing session or the
  69     tracing session named 'SESSION'.
  70
  71
  72 include::common-lttng-cmd-help-options.txt[]
  73
  74
  75 include::common-lttng-cmd-after-options.txt[]
  76
  77
  78 [[examples]]
  79 EXAMPLES
  80 --------
  81 .Clear the current tracing session.
  82 ====
  83 [role="term"]
  84 ----
  85 $ lttng clear
  86 ----
  87 ====
  88
  89 .Clear a specific tracing session.
  90 ====
  91 [role="term"]
  92 ----
  93 $ lttng clear my-session
  94 ----
  95 ====
  96
  97 .Clear all tracing sessions.
  98 ====
  99 See the option:--all option.
 100
 101 [role="term"]
 102 ----
 103 $ lttng clear --all
 104 ----
 105 ====
 106
 107
 108 include::common-footer.txt[]
 109
 110
 111 SEE ALSO
 112 --------
 113 man:lttng(1),
 114 man:lttng-create(1),
 115 man:lttng-concepts(7),
 116 man:lttng-relayd(8)