lttng-destroy(1)

1LTTNG-DESTROY(1)                 LTTng Manual                 LTTNG-DESTROY(1)
2
3
4

NAME

6       lttng-destroy - Destroy an LTTng tracing session
7

SYNOPSIS

9       lttng [GENERAL OPTIONS] destroy [--no-wait] [--all | SESSION]
10

DESCRIPTION

12       The lttng destroy command destroys one or more tracing sessions.
13
14       If no options are specified, the current tracing session is destroyed
15       (see lttng-create(1) for more information about the current tracing
16       session).
17
18       If SESSION is specified, the existing tracing session named SESSION is
19       destroyed. lttng list outputs all the existing tracing sessions (see
20       lttng-list(1)).
21
22       If the --all option is used, all the tracing sessions, as listed in the
23       output of lttng list, are destroyed.
24
25       Destroying a tracing session stops any tracing running within the
26       latter. By default, the implicit lttng-stop(1) command invoked by the
27       lttng destroy command ensures that the tracing session’s trace data is
28       valid before returning. With the --no-wait option, the lttng-stop(1)
29       command finishes immediately, hence a local trace might not be valid
30       when the command is done. In this case, there is no way to know when
31       the trace becomes valid.
32
33       Destroying a tracing session does not destroy the recorded trace data,
34       if any; it frees resources acquired by the session daemon and tracer
35       side, making sure to flush all trace data.
36
37       If at least one rotation occurred during the chosen tracing session’s
38       lifetime (see lttng-rotate(1) and lttng-enable-rotation(1)), and
39       without the --no-wait option, all the tracing session’s output
40       directory’s subdirectories are considered trace chunk archives once the
41       command returns: it is safe to read them, modify them, move them, or
42       remove them.
43

OPTIONS

45       General options are described in lttng(1).
46
47       -a, --all
48           Destroy all tracing sessions.
49
50       -n, --no-wait
51           Do not ensure that the chosen tracing session’s trace data is valid
52           before returning to the prompt.
53
54   Program information
55       -h, --help
56           Show command help.
57
58           This option, like lttng-help(1), attempts to launch /usr/bin/man to
59           view the command’s man page. The path to the man pager can be
60           overridden by the LTTNG_MAN_BIN_PATH environment variable.
61
62       --list-options
63           List available command options.
64

ENVIRONMENT VARIABLES

66       LTTNG_ABORT_ON_ERROR
67           Set to 1 to abort the process after the first error is encountered.
68
69       LTTNG_HOME
70           Overrides the $HOME environment variable. Useful when the user
71           running the commands has a non-writable home directory.
72
73       LTTNG_MAN_BIN_PATH
74           Absolute path to the man pager to use for viewing help information
75           about LTTng commands (using lttng-help(1) or lttng COMMAND --help).
76
77       LTTNG_SESSION_CONFIG_XSD_PATH
78           Path in which the session.xsd session configuration XML schema may
79           be found.
80
81       LTTNG_SESSIOND_PATH
82           Full session daemon binary path.
83
84           The --sessiond-path option has precedence over this environment
85           variable.
86
87       Note that the lttng-create(1) command can spawn an LTTng session daemon
88       automatically if none is running. See lttng-sessiond(8) for the
89       environment variables influencing the execution of the session daemon.
90

FILES

92       $LTTNG_HOME/.lttngrc
93           User LTTng runtime configuration.
94
95           This is where the per-user current tracing session is stored
96           between executions of lttng(1). The current tracing session can be
97           set with lttng-set-session(1). See lttng-create(1) for more
98           information about tracing sessions.
99
100       $LTTNG_HOME/lttng-traces
101           Default output directory of LTTng traces. This can be overridden
102           with the --output option of the lttng-create(1) command.
103
104       $LTTNG_HOME/.lttng
105           User LTTng runtime and configuration directory.
106
107       $LTTNG_HOME/.lttng/sessions
108           Default location of saved user tracing sessions (see lttng-save(1)
109           and lttng-load(1)).
110
111       /usr/local/etc/lttng/sessions
112           System-wide location of saved tracing sessions (see lttng-save(1)
113           and lttng-load(1)).
114
115           Note
116           $LTTNG_HOME defaults to $HOME when not explicitly set.
117

EXIT STATUS

119       0
120           Success
121
122       1
123           Command error
124
125       2
126           Undefined command
127
128       3
129           Fatal error
130
131       4
132           Command warning (something went wrong during the command)
133

BUGS

135       If you encounter any issue or usability problem, please report it on
136       the LTTng bug tracker <https://bugs.lttng.org/projects/lttng-tools>.
137

RESOURCES

139       •   LTTng project website <https://lttng.org>
140
141       •   LTTng documentation <https://lttng.org/docs>
142
143       •   Git repositories <http://git.lttng.org>
144
145       •   GitHub organization <http://github.com/lttng>
146
147       •   Continuous integration <http://ci.lttng.org/>
148
149       •   Mailing list <http://lists.lttng.org> for support and development:
150           lttng-dev@lists.lttng.org
151
152       •   IRC channel <irc://irc.oftc.net/lttng>: #lttng on irc.oftc.net
153

COPYRIGHTS

155       This program is part of the LTTng-tools project.
156
157       LTTng-tools is distributed under the GNU General Public License version
158       2 <http://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html>. See the
159       LICENSE <https://github.com/lttng/lttng-tools/blob/master/LICENSE> file
160       for details.
161

THANKS

163       Special thanks to Michel Dagenais and the DORSAL laboratory
164       <http://www.dorsal.polymtl.ca/> at École Polytechnique de Montréal for
165       the LTTng journey.
166
167       Also thanks to the Ericsson teams working on tracing which helped us
168       greatly with detailed bug reports and unusual test cases.
169