projects / lttng-tools.git / blame
| Commit | Line | Data |
|---|---|---|
| fb58d659 PP |
1 | lttng-stop(1) |
| 2 | ============= | |
| b93e8519 | 3 | :revdate: 17 May 2021 |
| fb58d659 PP |
4 | |
| 5 | ||
| 6 | NAME | |
| 7 | ---- | |
| 484b2a0c | 8 | lttng-stop - Stop an LTTng tracing session |
| fb58d659 PP |
9 | |
| 10 | ||
| 11 | SYNOPSIS | |
| 12 | -------- | |
| 13 | [verse] | |
| ce19b9ed | 14 | *lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *stop* [option:--no-wait] ['SESSION'] |
| fb58d659 PP |
15 | |
| 16 | ||
| 17 | DESCRIPTION | |
| 18 | ----------- | |
| 484b2a0c PP |
19 | The `lttng stop` command stops a tracing session, that is, it |
| 20 | deactivates the LTTng tracers for: | |
| 21 | ||
| 22 | With the 'SESSION' argument:: | |
| 23 | The tracing session named 'SESSION'. | |
| 24 | ||
| 25 | Without the 'SESSION' argument:: | |
| 188419c4 PP |
26 | The current tracing session (see man:lttng-concepts(7) to learn more |
| 27 | about the current tracing session). | |
| 28 | ||
| 29 | See man:lttng-concepts(7) to learn more about tracing sessions. | |
| 484b2a0c PP |
30 | |
| 31 | The selected tracing session must be active (started; see | |
| 32 | man:lttng-start(1)). A tracing session is inactive on creation (see | |
| 33 | man:lttng-create(1)). | |
| 34 | ||
| 484b2a0c PP |
35 | A `stop-session` trigger action can also stop a tracing session (see |
| 36 | man:lttng-add-trigger(1)). | |
| 37 | ||
| 38 | Start an inactive tracing session with the man:lttng-start(1) command. | |
| 39 | ||
| 40 | By default, the `stop` command ensures that the trace data of the | |
| 41 | selected tracing session is valid before it exits. Make the command exit | |
| 42 | immediately with the option:--no-wait option. In this case, however, the | |
| 43 | traces(s) might not be valid when the command exits, and there's no way | |
| 44 | to know when it/they becomes valid. | |
| 45 | ||
| 46 | If LTTng archived the current trace chunk (see man:lttng-rotate(1) and | |
| 47 | man:lttng-enable-rotation(1)) of the selected tracing session at least | |
| 48 | once during its lifetime, the `stop` command renames the current trace | |
| 49 | chunk subdirectory and prints the renamed path. Although it's safe to | |
| 50 | read the content of this renamed subdirectory while the tracing session | |
| 51 | remains inactive, it's :not: a trace chunk archive: you need to destroy | |
| 52 | the tracing session with man:lttng-destroy(1) or perform a rotation with | |
| 53 | man:lttng-rotate(1) to archive it. | |
| 980bb5fd | 54 | |
| b93e8519 PP |
55 | See the <<examples,EXAMPLES>> section below for usage examples. |
| 56 | ||
| fb58d659 | 57 | |
| 55e06994 | 58 | include::common-lttng-cmd-options-head.txt[] |
| fb58d659 PP |
59 | |
| 60 | ||
| 61 | option:-n, option:--no-wait:: | |
| 484b2a0c PP |
62 | Do :not: ensure that the trace data of the selected tracing session |
| 63 | is valid before exiting. | |
| fb58d659 PP |
64 | |
| 65 | ||
| 55e06994 | 66 | include::common-lttng-cmd-help-options.txt[] |
| fb58d659 PP |
67 | |
| 68 | ||
| 55e06994 PP |
69 | include::common-lttng-cmd-after-options.txt[] |
| 70 | ||
| 71 | ||
| b93e8519 PP |
72 | [[examples]] |
| 73 | EXAMPLES | |
| 74 | -------- | |
| 75 | .Stop the current tracing session. | |
| 76 | ==== | |
| 77 | [role="term"] | |
| 78 | ---- | |
| 79 | $ lttng stop | |
| 80 | ---- | |
| 81 | ==== | |
| 82 | ||
| 83 | .Stop a specific tracing session. | |
| 84 | ==== | |
| 85 | [role="term"] | |
| 86 | ---- | |
| 87 | $ lttng stop my-session | |
| 88 | ---- | |
| 89 | ==== | |
| 90 | ||
| 91 | .Stop the current tracing session without waiting for completion. | |
| 92 | ==== | |
| 93 | See the option:--no-wait option. | |
| 94 | ||
| 95 | [role="term"] | |
| 96 | ---- | |
| 97 | $ lttng stop --no-wait | |
| 98 | ---- | |
| 99 | ==== | |
| 100 | ||
| 101 | ||
| 55e06994 | 102 | include::common-footer.txt[] |
| fb58d659 PP |
103 | |
| 104 | ||
| 105 | SEE ALSO | |
| 106 | -------- | |
| 484b2a0c PP |
107 | man:lttng(1), |
| 108 | man:lttng-add-trigger(1), | |
| 109 | man:lttng-create(1), | |
| 110 | man:lttng-enable-event(1), | |
| 111 | man:lttng-rotate(1), | |
| 21b35b3a PP |
112 | man:lttng-start(1), |
| 113 | man:lttng-concepts(7) |