lttng-stop(1)

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

NAME

6       lttng-stop - Stop LTTng tracers
7

SYNOPSIS

9       lttng [GENERAL OPTIONS] stop [--no-wait] [SESSION]
10

DESCRIPTION

12       The lttng stop command stops the various LTTng tracers for a given
13       active tracing session.
14
15       Stopping the LTTng tracers has the effect that all enabled event rules
16       within enabled channels cannot make event sources emit trace events
17       anymore.
18
19       A tracing session with no running tracers is said to be inactive.
20       Inactive tracing sessions can be set active using the lttng-start(1)
21       command.
22
23       If SESSION is omitted, the LTTng tracers are stopped for the current
24       tracing session (see lttng-create(1) for more information about the
25       current tracing session). Otherwise, they are stopped for the existing
26       tracing session named SESSION. lttng list outputs all the existing
27       tracing sessions (see lttng-list(1)).
28
29       By default, the lttng stop command ensures that the tracing session’s
30       trace data is valid before returning to the prompt. With the --no-wait
31       option, the command finishes immediately, hence a local trace might not
32       be valid when the command is done. In this case, there is no way to
33       know when the trace becomes valid.
34

OPTIONS

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

ENVIRONMENT VARIABLES

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

FILES

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

EXIT STATUS

107       0
108           Success
109
110       1
111           Command error
112
113       2
114           Undefined command
115
116       3
117           Fatal error
118
119       4
120           Command warning (something went wrong during the command)
121

BUGS

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

RESOURCES

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

COPYRIGHTS

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

THANKS

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

AUTHORS

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