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