| 1 | lttng-stop(1) |
| 2 | ============= |
| 3 | :revdate: 18 January 2018 |
| 4 | |
| 5 | |
| 6 | NAME |
| 7 | ---- |
| 8 | lttng-stop - Stop LTTng tracers |
| 9 | |
| 10 | |
| 11 | SYNOPSIS |
| 12 | -------- |
| 13 | [verse] |
| 14 | *lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *stop* [option:--no-wait] ['SESSION'] |
| 15 | |
| 16 | |
| 17 | DESCRIPTION |
| 18 | ----------- |
| 19 | The `lttng stop` command stops the various LTTng tracers for a given |
| 20 | active tracing session. |
| 21 | |
| 22 | Stopping the LTTng tracers has the effect that all enabled event rules |
| 23 | within enabled channels cannot make event sources _emit_ trace events |
| 24 | anymore. |
| 25 | |
| 26 | A tracing session with no running tracers is said to be _inactive_. |
| 27 | Inactive tracing sessions can be set active using the |
| 28 | man:lttng-start(1) command. |
| 29 | |
| 30 | If 'SESSION' is omitted, the LTTng tracers are stopped for the current |
| 31 | tracing session (see man:lttng-create(1) for more information |
| 32 | about the current tracing session). Otherwise, they are stopped for the |
| 33 | existing tracing session named 'SESSION'. `lttng list` |
| 34 | outputs all the existing tracing sessions (see man:lttng-list(1)). |
| 35 | |
| 36 | By default, the `lttng stop` command ensures that the tracing session's |
| 37 | trace data is valid before returning to the prompt. With the |
| 38 | option:--no-wait option, the command finishes immediately, hence a local |
| 39 | trace might not be valid when the command is done. In this case, there |
| 40 | is no way to know when the trace becomes valid. |
| 41 | |
| 42 | If at least one rotation occurred during the chosen tracing session's |
| 43 | lifetime (see man:lttng-rotate(1) and man:lttng-enable-rotation(1)), the |
| 44 | `lttng stop` command renames the current trace chunk subdirectory and |
| 45 | prints the renamed path. Although it is safe to read the content of this |
| 46 | renamed subdirectory while the tracing session remains inactive (until |
| 47 | the next man:lttng-start(1)), it is :not: a trace chunk archive: you |
| 48 | need to destroy the tracing session with man:lttng-destroy(1) or make |
| 49 | a rotation with man:lttng-rotate(1) to archive it. |
| 50 | |
| 51 | |
| 52 | include::common-cmd-options-head.txt[] |
| 53 | |
| 54 | |
| 55 | option:-n, option:--no-wait:: |
| 56 | Do not ensure that the chosen tracing session's trace data is valid |
| 57 | before returning to the prompt. |
| 58 | |
| 59 | |
| 60 | include::common-cmd-help-options.txt[] |
| 61 | |
| 62 | |
| 63 | include::common-cmd-footer.txt[] |
| 64 | |
| 65 | |
| 66 | SEE ALSO |
| 67 | -------- |
| 68 | man:lttng-start(1), |
| 69 | man:lttng(1) |