Commit | Line | Data |
---|---|---|
44f5039e PP |
1 | lttng-load(1) |
2 | ============= | |
3 | ||
4 | ||
5 | NAME | |
6 | ---- | |
7 | lttng-load - Load LTTng tracing session configurations | |
8 | ||
9 | ||
10 | SYNOPSIS | |
11 | -------- | |
12 | [verse] | |
fe559816 JR |
13 | *lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *load* [option:--force] [option:--input-path='PATH'] |
14 | [option:--override-url='URL]' ['SESSION'] | |
44f5039e PP |
15 | |
16 | ||
17 | DESCRIPTION | |
18 | ----------- | |
19 | The `lttng load` command loads the configurations of one or more | |
20 | tracing sessions from files. | |
21 | ||
22 | The `lttng load` command is used in conjunction with the | |
7c1a4458 | 23 | man:lttng-save(1) command to save and restore the complete |
44f5039e PP |
24 | configurations of tracing sessions. This includes the enabled channels |
25 | and event rules, the context added to channels, the tracing activity, | |
26 | and more. | |
27 | ||
28 | Once one or more tracing session configurations are loaded, they appear | |
29 | exactly as they were saved from the user's point of view. | |
30 | ||
7a0f38c7 PP |
31 | The following directories are searched, non-recursively, in this order |
32 | for configuration files: | |
33 | ||
34 | . `$LTTNG_HOME/.lttng/sessions` (`$LTTNG_HOME` defaults to `$HOME`) | |
35 | . +{system_sessions_dir}+ | |
36 | ||
37 | The input path can be overridden with the option:--input-path option. | |
38 | When this option is specified, the default directories are :not: | |
39 | searched for configuration files. When it's not specified, _both_ | |
40 | default directories are searched for configuration files. | |
44f5039e | 41 | |
9014e3a8 PP |
42 | If the input path is a *directory*, then: |
43 | ||
44 | * If 'SESSION' is specified, the tracing session configuration named | |
45 | 'SESSION' is searched for in all the files of this directory and | |
46 | loaded if found. | |
47 | * If 'SESSION' is not specified, the option:--all option is implicit: | |
48 | all the tracing session configurations found in all the files in this | |
49 | directory are loaded. | |
50 | ||
51 | If the input path is a *file*, then: | |
52 | ||
53 | * If 'SESSION' is specified, the tracing session configuration named | |
54 | 'SESSION' is searched for in this file and loaded if found. | |
55 | * If 'SESSION' is not specified, the option:--all option is implicit: | |
56 | all the tracing session configurations found in this file are loaded. | |
57 | ||
fe559816 JR |
58 | Aspects of the loaded configurations can be overridden at load time. |
59 | ||
60 | option:--override-url:: | |
61 | Provides the equivalent of the option:--set-url option | |
62 | of the (1)lttng-create command. The validity of the url override is | |
63 | dependant on the type of session(s) to be loaded. Refer to (1)lttng-create for | |
64 | the accepted URL format. | |
65 | ||
9014e3a8 | 66 | By default, existing tracing sessions are not overwritten when loading: |
44f5039e PP |
67 | the command fails. The option:--force option can be used to allow this. |
68 | ||
69 | ||
70 | include::common-cmd-options-head.txt[] | |
71 | ||
72 | ||
73 | option:-a, option:--all:: | |
74 | Load all tracing session configurations (default). | |
75 | ||
76 | option:-f, option:--force:: | |
77 | Overwrite existing tracing sessions when loading. | |
78 | ||
79 | option:-i, option:--input-path='PATH':: | |
7a0f38c7 PP |
80 | Load tracing session configurations from 'PATH', either a directory |
81 | or a file, instead of loading them from the default search | |
82 | directories. | |
44f5039e | 83 | |
fe559816 JR |
84 | option:-U, option:--override-url='URL':: |
85 | Load tracing session configurations and apply an url override | |
86 | while loading. Applies to all sessions loaded. | |
44f5039e PP |
87 | |
88 | include::common-cmd-help-options.txt[] | |
89 | ||
90 | ||
91 | include::common-cmd-footer.txt[] | |
92 | ||
93 | ||
94 | SEE ALSO | |
95 | -------- | |
7c1a4458 PP |
96 | man:lttng-save(1), |
97 | man:lttng(1) |