| 1 | lttng-destroy(1) |
| 2 | ================ |
| 3 | :revdate: 3 May 2021 |
| 4 | |
| 5 | |
| 6 | NAME |
| 7 | ---- |
| 8 | lttng-destroy - Destroy LTTng tracing sessions |
| 9 | |
| 10 | |
| 11 | SYNOPSIS |
| 12 | -------- |
| 13 | [verse] |
| 14 | *lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *destroy* [option:--no-wait] [option:--all | 'SESSION'] |
| 15 | |
| 16 | |
| 17 | DESCRIPTION |
| 18 | ----------- |
| 19 | The `lttng destroy` command destroys: |
| 20 | |
| 21 | With the 'SESSION' argument:: |
| 22 | The tracing session named 'SESSION'. |
| 23 | |
| 24 | With the option:--all option:: |
| 25 | *All* the tracing sessions of the connected session daemon for your |
| 26 | Unix user, or for all users if your Unix user is `root`, as listed |
| 27 | in the output of `lttng list` (see man:lttng-list(1)). |
| 28 | + |
| 29 | See the ``Session daemon connection'' section of man:lttng(1) to learn |
| 30 | how a user application connects to a session daemon. |
| 31 | |
| 32 | Otherwise:: |
| 33 | The current tracing session (see man:lttng-concepts(7) to learn more |
| 34 | about the current tracing session). |
| 35 | + |
| 36 | In that case, the current tracing session becomes nonexistent. |
| 37 | |
| 38 | See man:lttng-concepts(7) to learn more about tracing sessions. |
| 39 | |
| 40 | ``Destroying'' a tracing session means freeing the resources which the |
| 41 | LTTng daemons and tracers acquired for it, also making sure to flush all |
| 42 | the recorded trace data to either the local file system or the connected |
| 43 | LTTng relay daemon (see man:lttng-relayd(8)), depending on the tracing |
| 44 | session mode. |
| 45 | |
| 46 | The `destroy` command stops any tracing activity within the selected |
| 47 | tracing session(s). By default, the command runs an implicit |
| 48 | man:lttng-stop(1) command to ensure that the trace data of the tracing |
| 49 | session(s) is valid before it exits. Make the command exit immediately |
| 50 | with the option:--no-wait option. In this case, however, the traces(s) |
| 51 | might not be valid when the command exits, and there's no way to know |
| 52 | when it/they become valid. |
| 53 | |
| 54 | If, for a tracing session{nbsp}__TS__ to destroy with the `destroy` |
| 55 | command, the following statements are true: |
| 56 | |
| 57 | * You don't specify the option:--no-wait option. |
| 58 | |
| 59 | * LTTng archived the current trace chunk (see man:lttng-concepts(7)) |
| 60 | of{nbsp}__TS__ at least once during its lifetime. |
| 61 | |
| 62 | Then all the subdirectories of the output directory of{nbsp}__TS__ |
| 63 | (local or remote) are considered trace chunk archives once the `destroy` |
| 64 | command exits. In other words, it's safe to read them, modify them, move |
| 65 | them, or remove then. |
| 66 | |
| 67 | |
| 68 | include::common-cmd-options-head.txt[] |
| 69 | |
| 70 | |
| 71 | option:-a, option:--all:: |
| 72 | Destroy all the tracing sessions of your Unix user, or of all users |
| 73 | if your Unix user is `root`, as listed in the output of |
| 74 | man:lttng-list(1), instead of the current tracing session or the |
| 75 | tracing session named 'SESSION'. |
| 76 | |
| 77 | option:-n, option:--no-wait:: |
| 78 | Do :not: ensure that the trace data of the tracing session(s) to |
| 79 | destroy is valid before exiting. |
| 80 | |
| 81 | |
| 82 | include::common-cmd-help-options.txt[] |
| 83 | |
| 84 | |
| 85 | include::common-cmd-footer.txt[] |
| 86 | |
| 87 | |
| 88 | SEE ALSO |
| 89 | -------- |
| 90 | man:lttng(1), |
| 91 | man:lttng-concepts(7), |
| 92 | man:lttng-create(1), |
| 93 | man:lttng-list(1) |