lttng-destroy(1)
================
-:revdate: 12 April 2021
+:revdate: 14 June 2021
NAME
----
-lttng-destroy - Destroy LTTng tracing sessions
+lttng-destroy - Destroy LTTng recording sessions
SYNOPSIS
--------
[verse]
-*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *destroy* [option:--no-wait] [option:--all | 'SESSION']
+*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *destroy* [option:--no-wait] [option:--all | option:--glob 'SESSION' | 'SESSION']
DESCRIPTION
-----------
-The `lttng destroy` command destroys one or more tracing sessions
-previously created with the man:lttng-create(1) command.
-
-``Destroying'' a tracing session means freeing the resources acquired by
-the LTTng daemons and tracers for it, also making sure to flush all the
-recorded trace data to either the local file system or the connected
-LTTng relay daemon (see man:lttng-relayd(8)), depending on the tracing
-session mode.
-
-Use the `destroy` command to destroy:
+The `lttng destroy` command destroys:
With the 'SESSION' argument::
- The tracing session named 'SESSION'.
+ The recording session named 'SESSION'.
With the option:--all option::
- *All* the tracing sessions of your Unix user,
- as listed in the output of `lttng list` (see man:lttng-list(1)).
+ *All* the recording sessions of the connected session daemon for
+ your Unix user, or for all users if your Unix user is `root`, as
+ listed in the output of `lttng list` (see man:lttng-list(1)).
++
+See the ``Session daemon connection'' section of man:lttng(1) to learn
+how a user application connects to a session daemon.
Otherwise::
- The current tracing session (see man:lttng-create(1) and
- man:lttng-set-session(1) to learn more about the current tracing
- session).
+ The current recording session (see man:lttng-concepts(7) to learn
+ more about the current recording session).
+
-In that case, the current tracing session becomes nonexistent.
+In that case, the current recording session becomes nonexistent.
-The `destroy` command stops any tracing activity within the selected
-tracing session(s). By default, the command runs the implicit
-man:lttng-stop(1) command to ensure that the trace data of the tracing
+See man:lttng-concepts(7) to learn more about recording sessions.
+
+``Destroying'' a recording session means freeing the resources which the
+LTTng daemons and tracers acquired for it, also making sure to flush all
+the recorded trace data to either the local file system or the connected
+LTTng relay daemon (see man:lttng-relayd(8)), depending on the recording
+session mode.
+
+The `destroy` command stops any recording activity within the selected
+recording session(s). By default, the command runs an implicit
+man:lttng-stop(1) command to ensure that the trace data of the recording
session(s) is valid before it exits. Make the command exit immediately
with the option:--no-wait option. In this case, however, the traces(s)
might not be valid when the command exits, and there's no way to know
-when it/they becomes valid.
+when it/they become valid.
-If, for a tracing session{nbsp}__TS__ to destroy with the `destroy`
+If, for a recording session{nbsp}__RS__ to destroy with the `destroy`
command, the following statements are true:
-* You don't use the option:--no-wait option.
+* You don't specify the option:--no-wait option.
-* LTTng archived the current trace chunk (see man:lttng-rotate(1) and
- man:lttng-enable-rotation(1)) of{nbsp}__TS__ at least once during its
- lifetime.
+* LTTng archived the current trace chunk (see man:lttng-concepts(7))
+ of{nbsp}__RS__ at least once during its lifetime.
-Then all the subdirectories of the output directory of{nbsp}__TS__
+Then all the subdirectories of the output directory of{nbsp}__RS__
(local or remote) are considered trace chunk archives once the `destroy`
command exits. In other words, it's safe to read them, modify them, move
them, or remove then.
+See the ``<<examples,EXAMPLES>>'' section below for usage examples.
+
-include::common-cmd-options-head.txt[]
+include::common-lttng-cmd-options-head.txt[]
option:-a, option:--all::
- Destroy all the tracing sessions of your Unix user, as listed in the
- output of man:lttng-list(1).
+ Destroy all the recording sessions of your Unix user, or of all
+ users if your Unix user is `root`, as listed in the output of
+ man:lttng-list(1), instead of the current recording session or the
+ recording session named 'SESSION'.
+
+option:-g, option:--glob::
+ Interpret SESSION as a globbing pattern.
option:-n, option:--no-wait::
- Do :not: ensure that the trace data of the tracing session(s) to
+ Do :not: ensure that the trace data of the recording session(s) to
destroy is valid before exiting.
-include::common-cmd-help-options.txt[]
+include::common-lttng-cmd-help-options.txt[]
+
+
+include::common-lttng-cmd-after-options.txt[]
+
+
+[[examples]]
+EXAMPLES
+--------
+.Destroy the current recording session.
+====
+[role="term"]
+----
+$ lttng destroy
+----
+====
+
+.Destroy the current recording session without waiting for completion.
+====
+See the option:--no-wait option.
+
+[role="term"]
+----
+$ lttng destroy --no-wait
+----
+====
+
+.Destroy a specific recording session.
+====
+[role="term"]
+----
+$ lttng destroy my-session
+----
+====
+
+.Destroy all recording sessions.
+====
+See the option:--all option.
+
+[role="term"]
+----
+$ lttng destroy --all
+----
+====
+
+.Destroy all recording sessions with the suffix foo.
+====
+See the option:--glob option.
+
+[role="term"]
+----
+$ lttng destroy --global '*foo'
+----
+====
-include::common-cmd-footer.txt[]
+include::common-footer.txt[]
SEE ALSO
man:lttng(1),
man:lttng-create(1),
man:lttng-list(1),
-man:lttng-set-session(1)
+man:lttng-concepts(7)