doc/man/lttng-clear.1.txt

   1 lttng-clear(1)
   2 ==============
   3 :revdate: 14 June 2021
   4
   5 NAME
   6 ----
   7 lttng-clear - Clear an LTTng recording 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 recording sessions, that
  19 is, it deletes the contents of their recording buffers and of all their
  20 local and streamed trace data.
  21
  22 See man:lttng-concepts(7) to learn more about recording sessions.
  23
  24 The `clear` command clears:
  25
  26 Without any option::
  27     The current recording session.
  28 +
  29 See man:lttng-concepts(7) to learn more about the current recording
  30 session.
  31
  32 With the 'SESSION' argument::
  33     The recording session named 'SESSION'.
  34
  35 With the option:--all option::
  36     *All* the recording sessions of the connected session daemon for
  37     your Unix user, or for all users if your Unix user is `root`, as
  38     listed 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 recording 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 recording buffers.
  46
  47 For a given recording session, if at least one rotation occurred (see
  48 man:lttng-concepts(7)), the `clear` command only clears its recording
  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 recording data over the network for the selected recording
  55 session(s) to an LTTng relay daemon configured as such, the `clear`
  56 command fails.
  57
  58 See the ``<<examples,EXAMPLES>>'' section below for usage examples.
  59
  60
  61 include::common-lttng-cmd-options-head.txt[]
  62
  63
  64 Recording target
  65 ~~~~~~~~~~~~~~~~
  66 option:-a, option:--all::
  67     Clear all the recording sessions of your Unix user, or of all users if
  68     your Unix user is `root`, as listed in the output of
  69     man:lttng-list(1), instead of the current recording session or the
  70     recording session named 'SESSION'.
  71
  72
  73 include::common-lttng-cmd-help-options.txt[]
  74
  75
  76 include::common-lttng-cmd-after-options.txt[]
  77
  78
  79 [[examples]]
  80 EXAMPLES
  81 --------
  82 .Clear the current recording session.
  83 ====
  84 [role="term"]
  85 ----
  86 $ lttng clear
  87 ----
  88 ====
  89
  90 .Clear a specific recording session.
  91 ====
  92 [role="term"]
  93 ----
  94 $ lttng clear my-session
  95 ----
  96 ====
  97
  98 .Clear all recording sessions.
  99 ====
 100 See the option:--all option.
 101
 102 [role="term"]
 103 ----
 104 $ lttng clear --all
 105 ----
 106 ====
 107
 108
 109 include::common-footer.txt[]
 110
 111
 112 SEE ALSO
 113 --------
 114 man:lttng(1),
 115 man:lttng-create(1),
 116 man:lttng-concepts(7),
 117 man:lttng-relayd(8)