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