| 1 | lttng-destroy(1) |
| 2 | ================ |
| 3 | :revdate: 14 June 2021 |
| 4 | |
| 5 | |
| 6 | NAME |
| 7 | ---- |
| 8 | lttng-destroy - Destroy LTTng recording 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 recording session named 'SESSION'. |
| 23 | |
| 24 | With the option:--all option:: |
| 25 | *All* the recording sessions of the connected session daemon for |
| 26 | your Unix user, or for all users if your Unix user is `root`, as |
| 27 | listed 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 recording session (see man:lttng-concepts(7) to learn |
| 34 | more about the current recording session). |
| 35 | + |
| 36 | In that case, the current recording session becomes nonexistent. |
| 37 | |
| 38 | See man:lttng-concepts(7) to learn more about recording sessions. |
| 39 | |
| 40 | ``Destroying'' a recording 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 recording |
| 44 | session mode. |
| 45 | |
| 46 | The `destroy` command stops any recording activity within the selected |
| 47 | recording session(s). By default, the command runs an implicit |
| 48 | man:lttng-stop(1) command to ensure that the trace data of the recording |
| 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 recording session{nbsp}__RS__ 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}__RS__ at least once during its lifetime. |
| 61 | |
| 62 | Then all the subdirectories of the output directory of{nbsp}__RS__ |
| 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 | See the ``<<examples,EXAMPLES>>'' section below for usage examples. |
| 68 | |
| 69 | |
| 70 | include::common-lttng-cmd-options-head.txt[] |
| 71 | |
| 72 | |
| 73 | option:-a, option:--all:: |
| 74 | Destroy all the recording sessions of your Unix user, or of all |
| 75 | users if your Unix user is `root`, as listed in the output of |
| 76 | man:lttng-list(1), instead of the current recording session or the |
| 77 | recording session named 'SESSION'. |
| 78 | |
| 79 | option:-n, option:--no-wait:: |
| 80 | Do :not: ensure that the trace data of the recording session(s) to |
| 81 | destroy is valid before exiting. |
| 82 | |
| 83 | |
| 84 | include::common-lttng-cmd-help-options.txt[] |
| 85 | |
| 86 | |
| 87 | include::common-lttng-cmd-after-options.txt[] |
| 88 | |
| 89 | |
| 90 | [[examples]] |
| 91 | EXAMPLES |
| 92 | -------- |
| 93 | .Destroy the current recording session. |
| 94 | ==== |
| 95 | [role="term"] |
| 96 | ---- |
| 97 | $ lttng destroy |
| 98 | ---- |
| 99 | ==== |
| 100 | |
| 101 | .Destroy the current recording session without waiting for completion. |
| 102 | ==== |
| 103 | See the option:--no-wait option. |
| 104 | |
| 105 | [role="term"] |
| 106 | ---- |
| 107 | $ lttng destroy --no-wait |
| 108 | ---- |
| 109 | ==== |
| 110 | |
| 111 | .Destroy a specific recording session. |
| 112 | ==== |
| 113 | [role="term"] |
| 114 | ---- |
| 115 | $ lttng destroy my-session |
| 116 | ---- |
| 117 | ==== |
| 118 | |
| 119 | .Destroy all recording sessions. |
| 120 | ==== |
| 121 | See the option:--all option. |
| 122 | |
| 123 | [role="term"] |
| 124 | ---- |
| 125 | $ lttng destroy --all |
| 126 | ---- |
| 127 | ==== |
| 128 | |
| 129 | |
| 130 | include::common-footer.txt[] |
| 131 | |
| 132 | |
| 133 | SEE ALSO |
| 134 | -------- |
| 135 | man:lttng(1), |
| 136 | man:lttng-create(1), |
| 137 | man:lttng-list(1), |
| 138 | man:lttng-concepts(7) |