1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169
|
lttng-load(1)
=============
:revdate: 14 June 2021
NAME
----
lttng-load - Load LTTng recording session configurations
SYNOPSIS
--------
[verse]
*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *load* [option:--force] [option:--input-path='PATH']
[option:--override-url='URL'] [option:--all | 'SESSION' [option:--override-name='NAME']]
DESCRIPTION
-----------
The `lttng load` command loads the configurations of one or more
recording sessions from files.
See man:lttng-concepts(7) to learn more about recording sessions.
Use the `load` command in conjunction with the man:lttng-save(1) command
to save and restore the complete configurations of recording sessions. A
recording session configuration includes the enabled channels and
recording event rules, the context fields to be recorded, the recording
activity, and more.
Once LTTng loads one or more recording session configurations, they
appear exactly as they were saved from the user's point of view.
LTTng searches the following directories, non-recursively, in this order
for recording session configuration files:
. `$LTTNG_HOME/.lttng/sessions` (`$LTTNG_HOME` defaults to `$HOME`)
. +{system_sessions_dir}+
Override the input path with the option:--input-path='PATH' option. With
this option, LTTng does :not: search the default directories above.
'PATH' can be the path of one of:
A directory::
With the 'SESSION' argument:::
LTTng searches for the recording session configuration named
'SESSION' in all the files of the directory 'PATH' and loads it
if found.
Without the 'SESSION' argument:::
The option:--all option is implicit: LTTng loads all the
recording session configurations found in all the files in the
directory 'PATH'.
A file::
With the 'SESSION' argument:::
LTTng searches for the recording session configuration named
'SESSION' in the file 'PATH' and loads it if found.
Without the 'SESSION' argument:::
The option:--all option is implicit: LTTng loads all the
recording session configurations found in the file 'PATH'.
Override the output URL of the loaded recording session configurations
with the option:--override-url option.
With the 'SESSION' argument, override the name of the loaded recording
session configuration with the option:--override-name option.
By default, the `load` command does :not: overwrite existing recording
sessions: the command fails. Allow the `load` command to overwrite
existing recording sessions with the option:--force option.
See the ``<<examples,EXAMPLES>>'' section below for usage examples.
include::common-lttng-cmd-options-head.txt[]
option:-a, option:--all::
Load all the recording session configurations (default).
option:-f, option:--force::
Overwrite existing recording sessions when loading.
option:-i 'PATH', option:--input-path='PATH'::
Load recording session configurations from 'PATH', either a
directory or a file, instead of loading them from the default search
directories.
option:--override-name='NAME'::
Override the name of the loaded recording session configuration,
'SESSION', with 'NAME'.
option:--override-url='URL'::
Override the output URL of the loaded recording session
configurations with 'URL'.
+
This is the equivalent of the nloption:--set-url option of
man:lttng-create(1). The validity of the URL override depends on the
type of recording session configurations to load. This option applies to
_all_ the loaded recording session configurations.
include::common-lttng-cmd-help-options.txt[]
include::common-lttng-cmd-after-options.txt[]
[[examples]]
EXAMPLES
--------
.Load all the recording session configurations from the default search directories.
====
[role="term"]
----
$ lttng load
----
====
.Load all the recording session configurations from a specific directory.
====
See the option:--input-path option.
[role="term"]
----
$ lttng load --input-path=/path/to/sessions
----
====
.Load a specific recording session configuration from the default search directories.
====
[role="term"]
----
$ lttng load my-session
----
====
.Allow LTTng to overwrite existing recording sessions when loading.
====
See the option:--force option.
[role="term"]
----
$ lttng load --force
----
====
.Load a specific recording session configuration from a specific file, overriding its name.
====
See the option:--input-path and option:--override-name options.
[role="term"]
----
$ lttng load my-session --input-path=/path/to/sessions.lttng \
--override-name=new-test
----
====
include::common-footer.txt[]
SEE ALSO
--------
man:lttng(1),
man:lttng-save(1),
man:lttng-concepts(7)
|