doc/man/lttng-clear.1.txt

   1 lttng-clear(1)
   2 ==============
   3 :revdate: 3 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
  58 include::common-cmd-options-head.txt[]
  59
  60
  61 Recording target
  62 ~~~~~~~~~~~~~~~~
  63 option:-a, option:--all::
  64     Clear all the tracing sessions of your Unix user, or of all users if
  65     your Unix user is `root`, as listed in the output of
  66     man:lttng-list(1), instead of the current tracing session or the
  67     tracing session named 'SESSION'.
  68
  69
  70 include::common-cmd-help-options.txt[]
  71
  72
  73 include::common-cmd-footer.txt[]
  74
  75
  76 SEE ALSO
  77 --------
  78 man:lttng(1),
  79 man:lttng-create(1),
  80 man:lttng-concepts(7),
  81 man:lttng-relayd(8)