doc/man/lttng-destroy.1.txt

   1 lttng-destroy(1)
   2 ================
   3 :revdate: 18 January 2018
   4
   5
   6 NAME
   7 ----
   8 lttng-destroy - Destroy an LTTng tracing session
   9
  10
  11 SYNOPSIS
  12 --------
  13 [verse]
  14 *lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *destroy* [option:--no-wait] [option:--all | 'SESSION']
  15
  16
  17 DESCRIPTION
  18 -----------
  19 The `lttng destroy` command destroys one or more tracing sessions.
  20
  21 If no options are specified, the current tracing session is destroyed
  22 (see man:lttng-create(1) for more information about the current
  23 tracing session).
  24
  25 If 'SESSION' is specified, the existing tracing session named 'SESSION'
  26 is destroyed. `lttng list` outputs all the existing tracing sessions
  27 (see man:lttng-list(1)).
  28
  29 If the option:--all option is used, *all* the tracing sessions, as listed
  30 in the output of `lttng list`, are destroyed.
  31
  32 Destroying a tracing session stops any tracing running within the
  33 latter. By default, the implicit man:lttng-stop(1) command invoked by
  34 the `lttng destroy` command ensures that the tracing session's trace
  35 data is valid before returning. With the option:--no-wait option, the
  36 man:lttng-stop(1) command finishes immediately, hence a local trace
  37 might not be valid when the command is done. In this case, there is no
  38 way to know when the trace becomes valid.
  39
  40 Destroying a tracing session does not destroy the recorded trace data,
  41 if any; it frees resources acquired by the session daemon and tracer
  42 side, making sure to flush all trace data.
  43
  44 If at least one rotation occurred during the chosen tracing session's
  45 lifetime (see man:lttng-rotate(1) and man:lttng-enable-rotation(1)), and
  46 without the option:--no-wait option, all the tracing session's output
  47 directory's subdirectories are considered trace chunk archives once the
  48 command returns: it is safe to read them, modify them, move them, or
  49 remove them.
  50
  51
  52 include::common-cmd-options-head.txt[]
  53
  54
  55 option:-a, option:--all::
  56     Destroy all tracing sessions.
  57
  58 option:-n, option:--no-wait::
  59     Do not ensure that the chosen tracing session's trace data is valid
  60     before returning to the prompt.
  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-create(1),
  72 man:lttng-set-session(1),
  73 man:lttng(1)