projects / lttng-tools.git / blame
| Commit | Line | Data |
|---|---|---|
| b3903b3a PP |
1 | lttng-save(1) |
| 2 | ============= | |
| 4605890e | 3 | :revdate: 28 November 2016 |
| b3903b3a PP |
4 | |
| 5 | ||
| 6 | NAME | |
| 7 | ---- | |
| 8 | lttng-save - Save LTTng tracing session configurations | |
| 9 | ||
| 10 | ||
| 11 | SYNOPSIS | |
| 12 | -------- | |
| 13 | [verse] | |
| ce19b9ed | 14 | *lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *save* [option:--force] [option:--output-path='PATH'] ['SESSION'] |
| b3903b3a PP |
15 | |
| 16 | ||
| 17 | DESCRIPTION | |
| 18 | ----------- | |
| 19 | The `lttng save` command saves the configurations of one or more | |
| 20 | tracing sessions to files. | |
| 21 | ||
| 22 | The `lttng save` command is used in conjunction with the | |
| 7c1a4458 | 23 | man:lttng-load(1) command to save and restore the complete |
| b3903b3a 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. `lttng save` does not save tracing data, only the tracing | |
| 27 | session parameters. | |
| 28 | ||
| 29 | If 'SESSION' is omitted, all the existing tracing session configurations | |
| 30 | are saved (equivalent to using the option:--all option). Otherwise, | |
| 31 | 'SESSION' is the name of an existing tracing session. `lttng list` | |
| 7c1a4458 | 32 | outputs all the existing tracing sessions (see man:lttng-list(1)). |
| b3903b3a PP |
33 | |
| 34 | The default output directory path is `$LTTNG_HOME/.lttng/sessions` | |
| 35 | (`$LTTNG_HOME` defaults to `$HOME`). Each tracing session configuration | |
| 36 | file is named `SESSION.lttng`, where `SESSION` is the original tracing | |
| 37 | session name. The default output directory path can be overridden with | |
| 38 | the option:--output-path option. | |
| 39 | ||
| 40 | By default, existing tracing session configuration files are not | |
| 41 | overwritten when saving; the command fails. The option:--force option | |
| 42 | can be used to allow this. | |
| 43 | ||
| 44 | ||
| 45 | include::common-cmd-options-head.txt[] | |
| 46 | ||
| 47 | ||
| 48 | option:-a, option:--all:: | |
| 49 | Save all tracing session configurations (default). | |
| 50 | ||
| 51 | option:-f, option:--force:: | |
| 52 | Overwrite existing tracing session configuration files when | |
| 53 | saving. | |
| 54 | ||
| 59b19c3c | 55 | option:-o 'PATH', option:--output-path='PATH':: |
| b3903b3a PP |
56 | Set output directory path to 'PATH'. |
| 57 | ||
| 58 | ||
| 59 | include::common-cmd-help-options.txt[] | |
| 60 | ||
| 61 | ||
| 62 | include::common-cmd-footer.txt[] | |
| 63 | ||
| 64 | ||
| 65 | SEE ALSO | |
| 66 | -------- | |
| 7c1a4458 PP |
67 | man:lttng-load(1), |
| 68 | man:lttng(1) |