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
35       If at least one rotation occurred during the chosen tracing session’s
36       lifetime (see lttng-rotate(1) and lttng-enable-rotation(1)), the lttng
37       stop command renames the current trace chunk subdirectory and prints
38       the renamed path. Although it is safe to read the content of this
39       renamed subdirectory while the tracing session remains inactive (until
40       the next lttng-start(1)), it is NOT a trace chunk archive: you need to
41       destroy the tracing session with lttng-destroy(1) or make a rotation
42       with lttng-rotate(1) to archive it.
43

OPTIONS

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

ENVIRONMENT VARIABLES

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

FILES

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

EXIT STATUS

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

BUGS

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

RESOURCES

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

COPYRIGHTS

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

THANKS

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