lttng-save(1)

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

NAME

6       lttng-save - Save LTTng tracing session configurations
7

SYNOPSIS

9       lttng [GENERAL OPTIONS] save [--force] [--output-path=PATH] [SESSION]
10

DESCRIPTION

12       The lttng save command saves the configurations of one or more tracing
13       sessions to files.
14
15       The lttng save command is used in conjunction with the lttng-load(1)
16       command to save and restore the complete configurations of tracing
17       sessions. This includes the enabled channels and event rules, the
18       context added to channels, the tracing activity, and more. lttng save
19       does not save tracing data, only the tracing session parameters.
20
21       If SESSION is omitted, all the existing tracing session configurations
22       are saved (equivalent to using the --all option). Otherwise, SESSION is
23       the name of an existing tracing session. lttng list outputs all the
24       existing tracing sessions (see lttng-list(1)).
25
26       The default output directory path is $LTTNG_HOME/.lttng/sessions
27       ($LTTNG_HOME defaults to $HOME). Each tracing session configuration
28       file is named SESSION.lttng, where SESSION is the original tracing
29       session name. The default output directory path can be overridden with
30       the --output-path option.
31
32       By default, existing tracing session configuration files are not
33       overwritten when saving; the command fails. The --force option can be
34       used to allow this.
35

OPTIONS

37       General options are described in lttng(1).
38
39       -a, --all
40           Save all tracing session configurations (default).
41
42       -f, --force
43           Overwrite existing tracing session configuration files when saving.
44
45       -o PATH, --output-path=PATH
46           Set output directory path to PATH.
47
48   Program information
49       -h, --help
50           Show command help.
51
52           This option, like lttng-help(1), attempts to launch /usr/bin/man to
53           view the command’s man page. The path to the man pager can be
54           overridden by the LTTNG_MAN_BIN_PATH environment variable.
55
56       --list-options
57           List available command options.
58

ENVIRONMENT VARIABLES

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

FILES

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

EXIT STATUS

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

BUGS

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

RESOURCES

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

COPYRIGHTS

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

THANKS

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