Document tracing session rotation features
[lttng-tools.git] / doc / man / lttng-destroy.1.txt
CommitLineData
7bf169bd
PP
1lttng-destroy(1)
2===============
3
4
5NAME
6----
7lttng-destroy - Destroy an LTTng tracing session
8
9
10SYNOPSIS
11--------
12[verse]
d0d2c3e4 13*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *destroy* [option:--no-wait] [option:--all | 'SESSION']
7bf169bd
PP
14
15
16DESCRIPTION
17-----------
18The `lttng destroy` command destroys one or more tracing sessions.
19
20If no options are specified, the current tracing session is destroyed
7c1a4458 21(see man:lttng-create(1) for more information about the current
7bf169bd
PP
22tracing session).
23
24If 'SESSION' is specified, the existing tracing session named 'SESSION'
25is destroyed. `lttng list` outputs all the existing tracing sessions
7c1a4458 26(see man:lttng-list(1)).
7bf169bd
PP
27
28If the option:--all option is used, *all* the tracing sessions, as listed
29in the output of `lttng list`, are destroyed.
30
d0d2c3e4
PP
31Destroying a tracing session stops any tracing running within the
32latter. By default, the implicit man:lttng-stop(1) command invoked by
33the `lttng destroy` command ensures that the tracing session's trace
34data is valid before returning. With the option:--no-wait option, the
35man:lttng-stop(1) command finishes immediately, hence a local trace
36might not be valid when the command is done. In this case, there is no
37way to know when the trace becomes valid.
7bf169bd
PP
38
39Destroying a tracing session does not destroy the recorded trace data,
40if any; it frees resources acquired by the session daemon and tracer
41side, making sure to flush all trace data.
42
980bb5fd
PP
43If at least one rotation occurred during the chosen tracing session's
44lifetime (see man:lttng-rotate(1) and man:lttng-enable-rotation(1)), and
45without the option:--no-wait option, all the tracing session's output
46directory's subdirectories are considered trace chunk archives once the
47command returns: it is safe to read them, modify them, move them, or
48remove them.
49
7bf169bd
PP
50
51include::common-cmd-options-head.txt[]
52
53
54option:-a, option:--all::
55 Destroy all tracing sessions.
56
d0d2c3e4
PP
57option:-n, option:--no-wait::
58 Do not ensure that the chosen tracing session's trace data is valid
59 before returning to the prompt.
60
7bf169bd
PP
61
62include::common-cmd-help-options.txt[]
63
64
65include::common-cmd-footer.txt[]
66
67
68SEE ALSO
69--------
7c1a4458
PP
70man:lttng-create(1),
71man:lttng-set-session(1),
72man:lttng(1)
This page took 0.045794 seconds and 5 git commands to generate.