doc/man/lttng-clear.1.txt

   1 lttng-clear(1)
   2 ==============
   3 :revdate: 8 April 2021
   4
   5 NAME
   6 ----
   7 lttng-clear - Clear a 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 The `clear` command clears:
  23
  24 Without any option::
  25     The current tracing session.
  26 +
  27 See man:lttng-create(1) and man:lttng-set-session(1) to learn more about
  28 the current tracing session.
  29
  30 With the 'SESSION' argument::
  31     The existing tracing session named 'SESSION'.
  32
  33 With the option:--all option::
  34     *All* the tracing sessions of your Unix user, as listed in the
  35     output of `lttng list` (see man:lttng-list(1)).
  36
  37 If a tracing session is configured in snapshot mode (see the
  38 nloption:--snapshot option of the man:lttng-create(1) command), the
  39 `clear` command only clears the tracing buffers.
  40
  41 For a given tracing session, if at least one rotation occurred (see
  42 man:lttng-rotate(1)), the `clear` command only clears its tracing
  43 buffers and its current trace chunk, :not: its archived trace chunks.
  44
  45 NOTE: The nloption:--disallow-clear option and the
  46 `LTTNG_RELAYD_DISALLOW_CLEAR` environment variable of
  47 man:lttng-relayd(8) can disable remote clearing operations. If LTTng
  48 sends tracing data over the network for the selected tracing session(s)
  49 to an LTTng relay daemon configured as such, the `clear` command fails.
  50
  51
  52 include::common-cmd-options-head.txt[]
  53
  54
  55 Recording target
  56 ~~~~~~~~~~~~~~~~
  57 option:-a, option:--all::
  58     Clear all the tracing sessions of your Unix user, as listed in the
  59     output of man:lttng-list(1), instead of the current tracing session
  60     or the tracing session named 'SESSION'.
  61
  62
  63 include::common-cmd-help-options.txt[]
  64
  65
  66 include::common-cmd-footer.txt[]
  67
  68
  69 SEE ALSO
  70 --------
  71 man:lttng(1),
  72 man:lttng-create(1),
  73 man:lttng-relayd(8),
  74 man:lttng-rotate(1),
  75 man:lttng-set-session(1)