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

OPTIONS

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

ENVIRONMENT VARIABLES

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

FILES

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

EXIT STATUS

112       0
113           Success
114
115       1
116           Command error
117
118       2
119           Undefined command
120
121       3
122           Fatal error
123
124       4
125           Command warning (something went wrong during the command)
126

BUGS

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

RESOURCES

132       ·   LTTng project website <http://lttng.org>
133
134       ·   LTTng documentation <http://lttng.org/docs>
135
136       ·   Git repositories <http://git.lttng.org>
137
138       ·   GitHub organization <http://github.com/lttng>
139
140       ·   Continuous integration <http://ci.lttng.org/>
141
142       ·   Mailing list <http://lists.lttng.org> for support and development:
143           lttng-dev@lists.lttng.org
144
145       ·   IRC channel <irc://irc.oftc.net/lttng>: #lttng on irc.oftc.net
146

COPYRIGHTS

148       This program is part of the LTTng-tools project.
149
150       LTTng-tools is distributed under the GNU General Public License version
151       2 <http://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html>. See the
152       LICENSE <https://github.com/lttng/lttng-tools/blob/master/LICENSE> file
153       for details.
154

THANKS

156       Special thanks to Michel Dagenais and the DORSAL laboratory
157       <http://www.dorsal.polymtl.ca/> at École Polytechnique de Montréal for
158       the LTTng journey.
159
160       Also thanks to the Ericsson teams working on tracing which helped us
161       greatly with detailed bug reports and unusual test cases.
162

AUTHORS

164       LTTng-tools was originally written by Mathieu Desnoyers, Julien
165       Desfossez, and David Goulet. More people have since contributed to it.
166
167       LTTng-tools is currently maintained by Jérémie Galarneau
168       <mailto:jeremie.galarneau@efficios.com>.
169