Fix: action-executor: leak of `work_item::subitems` field
[lttng-tools.git] / doc / man / lttng-rotate.1.txt
CommitLineData
980bb5fd
PP
1lttng-rotate(1)
2===============
26f0c779 3:revdate: 30 April 2021
980bb5fd
PP
4
5
6NAME
7----
26f0c779 8lttng-rotate - Archive the current trace chunk of an LTTng tracing session
980bb5fd
PP
9
10
11SYNOPSIS
12--------
13[verse]
14*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *rotate* [option:--no-wait] ['SESSION']
15
16
17DESCRIPTION
18-----------
26f0c779
PP
19The `lttng rotate` command archives to the file system
20the current trace chunk of:
adc4b5c8 21
26f0c779
PP
22With the 'SESSION' argument::
23 The tracing session named 'SESSION'.
980bb5fd 24
26f0c779
PP
25Without the 'SESSION' argument::
26 The current tracing session (see man:lttng-concepts(7) to learn more
27 about the current tracing session).
980bb5fd 28
26f0c779 29This action is called a _tracing session rotation_.
980bb5fd 30
26f0c779
PP
31See man:lttng-concepts(7) to learn more about the tracing session
32rotation and trace chunk concepts.
adc4b5c8 33
26f0c779 34You can use the `rotate` command:
980bb5fd 35
26f0c779 36* Any time the tracing session is active.
980bb5fd 37
26f0c779 38* A single time once the tracing session becomes inactive.
980bb5fd 39
26f0c779
PP
40See man:lttng-concepts(7) to learn more about the activity of a
41tracing session.
980bb5fd 42
26f0c779
PP
43By default, the `rotate` command ensures that LTTng finished performing
44the tracing session rotation before it prints the path of the archived
45trace chunk and exits. The printed path is absolute when the tracing
46session was created in normal mode and relative to the base output
47directory of the relay daemon (see the nloption:--output option of
48man:lttng-relayd(8)) when it was created in network streaming mode (see
49man:lttng-create(1)).
980bb5fd 50
26f0c779
PP
51Make the command exit immediately with the option:--no-wait option. In
52this case, there's no easy way to know when the current trace chunk
53becomes archived, and the command does :not: print the path of the
54archived trace chunk.
980bb5fd 55
26f0c779
PP
56Because LTTng flushes the current sub-buffers of the selected tracing
57session when it performs a tracing session rotation, archived trace
58chunks are never redundant, that is, they do not overlap over time like
59snapshots can (see man:lttng-snapshot(1)). Also, a rotation does :not:
60directly cause discarded event records or packets.
980bb5fd 61
26f0c779
PP
62A `rotate-session` trigger action can also rotate a tracing session (see
63man:lttng-add-trigger(1)).
980bb5fd 64
26f0c779
PP
65[IMPORTANT]
66====
67You may only use the `rotate` command when:
980bb5fd 68
26f0c779
PP
69* The selected tracing session was created in normal mode or in network
70 streaming mode (see man:lttng-create(1)).
980bb5fd 71
26f0c779
PP
72* No channel was created with a configured trace file count or size
73 limit (see the nloption:--tracefile-size and
74 nloption:--tracefile-count options of the man:lttng-enable-channel(1)
75 command).
980bb5fd 76
26f0c779
PP
77* LTTng is not currently performing an immediate rotation (this
78 command).
79====
980bb5fd 80
980bb5fd 81
26f0c779 82include::common-cmd-options-head.txt[]
980bb5fd 83
980bb5fd 84
26f0c779
PP
85option:-n, option:--no-wait::
86 Do not ensure that the tracing session rotation operation is
87 completed before exiting.
980bb5fd 88
980bb5fd 89
26f0c779 90include::common-cmd-help-options.txt[]
980bb5fd 91
980bb5fd
PP
92
93include::common-cmd-footer.txt[]
94
95
96SEE ALSO
97--------
26f0c779
PP
98man:lttng(1),
99man:lttng-concepts(7),
980bb5fd 100man:lttng-disable-rotation(1),
26f0c779 101man:lttng-enable-rotation(1)
This page took 0.035591 seconds and 4 git commands to generate.