lttng-load(1)
=============
-:revdate: 17 May 2021
+:revdate: 14 June 2021
NAME
----
-lttng-load - Load LTTng tracing session configurations
+lttng-load - Load LTTng recording session configurations
SYNOPSIS
DESCRIPTION
-----------
The `lttng load` command loads the configurations of one or more
-tracing sessions from files.
+recording sessions from files.
-See man:lttng-concepts(7) to learn more about tracing sessions.
+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 tracing sessions. A
-tracing session configuration includes the enabled channels and
-recording event rules, the context fields to be recorded, the tracing
+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 tracing session configurations, they appear
-exactly as they were saved from the user's point of view.
+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 tracing session configuration files:
+for recording session configuration files:
. `$LTTNG_HOME/.lttng/sessions` (`$LTTNG_HOME` defaults to `$HOME`)
. +{system_sessions_dir}+
A directory::
With the 'SESSION' argument:::
- LTTng searches for the tracing session configuration named
+ 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 tracing
- session configurations found in all the files in the directory
- 'PATH'.
+ 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 tracing session configuration named
+ 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 tracing
- session configurations found in the file 'PATH'.
+ 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 tracing session configurations
+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 tracing
+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 tracing
+By default, the `load` command does :not: overwrite existing recording
sessions: the command fails. Allow the `load` command to overwrite
-existing tracing sessions with the option:--force option.
+existing recording sessions with the option:--force option.
See the ``<<examples,EXAMPLES>>'' section below for usage examples.
option:-a, option:--all::
- Load all the tracing session configurations (default).
+ Load all the recording session configurations (default).
option:-f, option:--force::
- Overwrite existing tracing sessions when loading.
+ Overwrite existing recording sessions when loading.
option:-i 'PATH', option:--input-path='PATH'::
- Load tracing session configurations from 'PATH', either a directory
- or a file, instead of loading them from the default search
+ 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 tracing session configuration,
+ Override the name of the loaded recording session configuration,
'SESSION', with 'NAME'.
option:--override-url='URL'::
- Override the output URL of the loaded tracing session configurations
- with '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 tracing session configurations to load. This option applies to
-_all_ the loaded tracing session configurations.
+type of recording session configurations to load. This option applies to
+_all_ the loaded recording session configurations.
include::common-lttng-cmd-help-options.txt[]
[[examples]]
EXAMPLES
--------
-.Load all the tracing session configurations from the default search directories.
+.Load all the recording session configurations from the default search directories.
====
[role="term"]
----
----
====
-.Load all the tracing session configurations from a specific directory.
+.Load all the recording session configurations from a specific directory.
====
See the option:--input-path option.
----
====
-.Load a specific tracing session configuration from the default search directories.
+.Load a specific recording session configuration from the default search directories.
====
[role="term"]
----
----
====
-.Allow LTTng to overwrite existing tracing sessions when loading.
+.Allow LTTng to overwrite existing recording sessions when loading.
====
See the option:--force option.
----
====
-.Load a specific tracing session configuration from a specific file, overriding its name.
+.Load a specific recording session configuration from a specific file, overriding its name.
====
See the option:--input-path and option:--override-name options.
projects / lttng-tools.git / blobdiff