doc/man/lttng-stop.1.txt

   1 lttng-stop(1)
   2 =============
   3 :revdate: 14 June 2021
   4
   5
   6 NAME
   7 ----
   8 lttng-stop - Stop an LTTng recording session
   9
  10
  11 SYNOPSIS
  12 --------
  13 [verse]
  14 *lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *stop* [option:--no-wait] ['SESSION']
  15
  16
  17 DESCRIPTION
  18 -----------
  19 The `lttng stop` command stops a recording session, that is, it
  20 deactivates the LTTng tracers for:
  21
  22 With the 'SESSION' argument::
  23     The recording session named 'SESSION'.
  24
  25 Without the 'SESSION' argument::
  26     The current recording session (see man:lttng-concepts(7) to learn more
  27     about the current recording session).
  28
  29 See man:lttng-concepts(7) to learn more about recording sessions.
  30
  31 The selected recording session must be active (started; see
  32 man:lttng-start(1)). A recording session is inactive on creation (see
  33 man:lttng-create(1)).
  34
  35 A `stop-session` trigger action can also stop a recording session (see
  36 man:lttng-add-trigger(1)).
  37
  38 Start an inactive recording session with the man:lttng-start(1) command.
  39
  40 By default, the `stop` command ensures that the trace data of the
  41 selected recording session is valid before it exits. Make the command
  42 exit immediately with the option:--no-wait option. In this case,
  43 however, the traces(s) might not be valid when the command exits, and
  44 there's no way to know when it/they becomes valid.
  45
  46 If LTTng archived the current trace chunk (see man:lttng-rotate(1) and
  47 man:lttng-enable-rotation(1)) of the selected recording session at least
  48 once during its lifetime, the `stop` command renames the current trace
  49 chunk subdirectory and prints the renamed path. Although it's safe to
  50 read the content of this renamed subdirectory while the recording
  51 session remains inactive, it's :not: a trace chunk archive: you need to
  52 destroy the recording session with man:lttng-destroy(1) or perform a
  53 rotation with man:lttng-rotate(1) to archive it.
  54
  55 See the ``<<examples,EXAMPLES>>'' section below for usage examples.
  56
  57
  58 include::common-lttng-cmd-options-head.txt[]
  59
  60
  61 option:-n, option:--no-wait::
  62     Do :not: ensure that the trace data of the selected recording
  63     session is valid before exiting.
  64
  65
  66 include::common-lttng-cmd-help-options.txt[]
  67
  68
  69 include::common-lttng-cmd-after-options.txt[]
  70
  71
  72 [[examples]]
  73 EXAMPLES
  74 --------
  75 .Stop the current recording session.
  76 ====
  77 [role="term"]
  78 ----
  79 $ lttng stop
  80 ----
  81 ====
  82
  83 .Stop a specific recording session.
  84 ====
  85 [role="term"]
  86 ----
  87 $ lttng stop my-session
  88 ----
  89 ====
  90
  91 .Stop the current recording session without waiting for completion.
  92 ====
  93 See the option:--no-wait option.
  94
  95 [role="term"]
  96 ----
  97 $ lttng stop --no-wait
  98 ----
  99 ====
 100
 101
 102 include::common-footer.txt[]
 103
 104
 105 SEE ALSO
 106 --------
 107 man:lttng(1),
 108 man:lttng-add-trigger(1),
 109 man:lttng-create(1),
 110 man:lttng-enable-event(1),
 111 man:lttng-rotate(1),
 112 man:lttng-start(1),
 113 man:lttng-concepts(7)