projects / lttng-tools.git / blame
| Commit | Line | Data |
|---|---|---|
| fb58d659 PP |
1 | lttng-stop(1) |
| 2 | ============= | |
| 484b2a0c | 3 | :revdate: 21 April 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:: | |
| 26 | The current tracing session (see man:lttng-create(1) and | |
| 27 | man:lttng-set-session(1) to learn more about the current tracing | |
| 28 | session). | |
| 29 | ||
| 30 | The selected tracing session must be active (started; see | |
| 31 | man:lttng-start(1)). A tracing session is inactive on creation (see | |
| 32 | man:lttng-create(1)). | |
| 33 | ||
| 34 | An active tracing session is an implicit recording event rule condition | |
| 35 | (see man:lttng-enable-event(1)). In other words, a recording event rule | |
| 36 | cannot match an event when its tracing session is inactive. | |
| 37 | ||
| 38 | A `stop-session` trigger action can also stop a tracing session (see | |
| 39 | man:lttng-add-trigger(1)). | |
| 40 | ||
| 41 | Start an inactive tracing session with the man:lttng-start(1) command. | |
| 42 | ||
| 43 | By default, the `stop` command ensures that the trace data of the | |
| 44 | selected tracing session is valid before it exits. Make the command exit | |
| 45 | immediately with the option:--no-wait option. In this case, however, the | |
| 46 | traces(s) might not be valid when the command exits, and there's no way | |
| 47 | to know when it/they becomes valid. | |
| 48 | ||
| 49 | If LTTng archived the current trace chunk (see man:lttng-rotate(1) and | |
| 50 | man:lttng-enable-rotation(1)) of the selected tracing session at least | |
| 51 | once during its lifetime, the `stop` command renames the current trace | |
| 52 | chunk subdirectory and prints the renamed path. Although it's safe to | |
| 53 | read the content of this renamed subdirectory while the tracing session | |
| 54 | remains inactive, it's :not: a trace chunk archive: you need to destroy | |
| 55 | the tracing session with man:lttng-destroy(1) or perform a rotation with | |
| 56 | man:lttng-rotate(1) to archive it. | |
| 980bb5fd | 57 | |
| fb58d659 PP |
58 | |
| 59 | include::common-cmd-options-head.txt[] | |
| 60 | ||
| 61 | ||
| 62 | option:-n, option:--no-wait:: | |
| 484b2a0c PP |
63 | Do :not: ensure that the trace data of the selected tracing session |
| 64 | is valid before exiting. | |
| fb58d659 PP |
65 | |
| 66 | ||
| 67 | include::common-cmd-help-options.txt[] | |
| 68 | ||
| 69 | ||
| 70 | include::common-cmd-footer.txt[] | |
| 71 | ||
| 72 | ||
| 73 | SEE ALSO | |
| 74 | -------- | |
| 484b2a0c PP |
75 | man:lttng(1), |
| 76 | man:lttng-add-trigger(1), | |
| 77 | man:lttng-create(1), | |
| 78 | man:lttng-enable-event(1), | |
| 79 | man:lttng-rotate(1), | |
| 80 | man:lttng-start(1) |