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