lttng-load(1)

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

NAME

6       lttng-load - Load LTTng tracing session configurations
7

SYNOPSIS

9       lttng [GENERAL OPTIONS] load [--force] [--input-path=PATH]
10             [--override-url=URL] [SESSION [--override-name=NAME]]
11

DESCRIPTION

13       The lttng load command loads the configurations of one or more tracing
14       sessions from files.
15
16       The lttng load command is used in conjunction with the lttng-save(1)
17       command to save and restore the complete configurations of tracing
18       sessions. This includes the enabled channels and event rules, the
19       context added to channels, the tracing activity, and more.
20
21       Once one or more tracing session configurations are loaded, they appear
22       exactly as they were saved from the user’s point of view.
23
24       The following directories are searched, non-recursively, in this order
25       for configuration files:
26
27        1. $LTTNG_HOME/.lttng/sessions ($LTTNG_HOME defaults to $HOME)
28
29        2. /usr/local/etc/lttng/sessions
30
31       The input path can be overridden with the --input-path option. When
32       this option is specified, the default directories are NOT searched for
33       configuration files. When it’s not specified, both default directories
34       are searched for configuration files.
35
36       If the input path is a directory, then:
37
38       •   If SESSION is specified, the tracing session configuration named
39           SESSION is searched for in all the files of this directory and
40           loaded if found.
41
42       •   If SESSION is not specified, the --all option is implicit: all the
43           tracing session configurations found in all the files in this
44           directory are loaded.
45
46       If the input path is a file, then:
47
48       •   If SESSION is specified, the tracing session configuration named
49           SESSION is searched for in this file and loaded if found.
50
51       •   If SESSION is not specified, the --all option is implicit: all the
52           tracing session configurations found in this file are loaded.
53
54       Aspects of the loaded configurations can be overridden at load time
55       using the --override-url and --override-name options.
56
57       By default, existing tracing sessions are not overwritten when loading:
58       the command fails. The --force option can be used to allow this.
59

OPTIONS

61       General options are described in lttng(1).
62
63       -a, --all
64           Load all tracing session configurations (default).
65
66       -f, --force
67           Overwrite existing tracing sessions when loading.
68
69       -i PATH, --input-path=PATH
70           Load tracing session configurations from PATH, either a directory
71           or a file, instead of loading them from the default search
72           directories.
73
74       --override-name=NAME
75           Override the name of the loaded tracing session configuration,
76           SESSION, with NAME.
77
78           You must specify a tracing session name to load (SESSION) and NOT
79           use the --all option when using this option.
80
81       --override-url=URL
82           Override the URL of the loaded tracing session configurations with
83           URL.
84
85           This is the equivalent of the --set-url option of lttng-create(1).
86           The validity of the URL override depends on the type of tracing
87           session configurations to load. This option applies to all the
88           loaded tracing session configurations.
89
90   Program information
91       -h, --help
92           Show command help.
93
94           This option, like lttng-help(1), attempts to launch /usr/bin/man to
95           view the command’s man page. The path to the man pager can be
96           overridden by the LTTNG_MAN_BIN_PATH environment variable.
97
98       --list-options
99           List available command options.
100

ENVIRONMENT VARIABLES

102       LTTNG_ABORT_ON_ERROR
103           Set to 1 to abort the process after the first error is encountered.
104
105       LTTNG_HOME
106           Overrides the $HOME environment variable. Useful when the user
107           running the commands has a non-writable home directory.
108
109       LTTNG_MAN_BIN_PATH
110           Absolute path to the man pager to use for viewing help information
111           about LTTng commands (using lttng-help(1) or lttng COMMAND --help).
112
113       LTTNG_SESSION_CONFIG_XSD_PATH
114           Path in which the session.xsd session configuration XML schema may
115           be found.
116
117       LTTNG_SESSIOND_PATH
118           Full session daemon binary path.
119
120           The --sessiond-path option has precedence over this environment
121           variable.
122
123       Note that the lttng-create(1) command can spawn an LTTng session daemon
124       automatically if none is running. See lttng-sessiond(8) for the
125       environment variables influencing the execution of the session daemon.
126

FILES

128       $LTTNG_HOME/.lttngrc
129           User LTTng runtime configuration.
130
131           This is where the per-user current tracing session is stored
132           between executions of lttng(1). The current tracing session can be
133           set with lttng-set-session(1). See lttng-create(1) for more
134           information about tracing sessions.
135
136       $LTTNG_HOME/lttng-traces
137           Default output directory of LTTng traces. This can be overridden
138           with the --output option of the lttng-create(1) command.
139
140       $LTTNG_HOME/.lttng
141           User LTTng runtime and configuration directory.
142
143       $LTTNG_HOME/.lttng/sessions
144           Default location of saved user tracing sessions (see lttng-save(1)
145           and lttng-load(1)).
146
147       /usr/local/etc/lttng/sessions
148           System-wide location of saved tracing sessions (see lttng-save(1)
149           and lttng-load(1)).
150
151           Note
152           $LTTNG_HOME defaults to $HOME when not explicitly set.
153

EXIT STATUS

155       0
156           Success
157
158       1
159           Command error
160
161       2
162           Undefined command
163
164       3
165           Fatal error
166
167       4
168           Command warning (something went wrong during the command)
169

BUGS

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

RESOURCES

175       •   LTTng project website <https://lttng.org>
176
177       •   LTTng documentation <https://lttng.org/docs>
178
179       •   Git repositories <http://git.lttng.org>
180
181       •   GitHub organization <http://github.com/lttng>
182
183       •   Continuous integration <http://ci.lttng.org/>
184
185       •   Mailing list <http://lists.lttng.org> for support and development:
186           lttng-dev@lists.lttng.org
187
188       •   IRC channel <irc://irc.oftc.net/lttng>: #lttng on irc.oftc.net
189

COPYRIGHTS

191       This program is part of the LTTng-tools project.
192
193       LTTng-tools is distributed under the GNU General Public License version
194       2 <http://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html>. See the
195       LICENSE <https://github.com/lttng/lttng-tools/blob/master/LICENSE> file
196       for details.
197

THANKS

199       Special thanks to Michel Dagenais and the DORSAL laboratory
200       <http://www.dorsal.polymtl.ca/> at École Polytechnique de Montréal for
201       the LTTng journey.
202
203       Also thanks to the Ericsson teams working on tracing which helped us
204       greatly with detailed bug reports and unusual test cases.
205