doc/man/manpage.xsl: do not indent the title of an admonition block
[lttng-tools.git] / doc / man / lttng-enable-rotation.1.txt
CommitLineData
980bb5fd
PP
1lttng-enable-rotation(1)
2========================
484b2a0c 3:revdate: 21 April 2021
980bb5fd
PP
4
5
6NAME
7----
484b2a0c 8lttng-enable-rotation - Set a tracing session rotation schedule
980bb5fd
PP
9
10
11SYNOPSIS
12--------
13[verse]
eb027cfc 14*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *enable-rotation* [option:--session='SESSION']
484b2a0c 15 (option:--timer='PERIODUS' | option:--size='SIZE' | option:--timer='PERIODUS' option:--size='SIZE')
980bb5fd
PP
16
17
18DESCRIPTION
19-----------
484b2a0c
PP
20The `lttng enable-rotation` command sets a tracing session rotation
21schedule for:
980bb5fd 22
484b2a0c
PP
23With the option:--session='SESSION' option::
24 The tracing session named 'SESSION'.
980bb5fd 25
484b2a0c
PP
26Without the option:--session option::
27 The current tracing session (see man:lttng-create(1) and
28 man:lttng-set-session(1) to learn more about the current tracing
29 session).
980bb5fd 30
484b2a0c
PP
31See man:lttng-rotate(1) for more information about the concepts of a
32tracing session _rotation_ and a _trace chunk_.
437afa71 33
484b2a0c
PP
34With the option:--timer='PERIODUS' option, the `enable-rotation` command
35sets a rotation schedule so that LTTng performs an automatic rotation at
36least every 'PERIODUS'.
437afa71 37
484b2a0c
PP
38With the option:--size='SIZE' option, the `enable-rotation` command sets
39a rotation schedule so that LTTng performs an automatic rotation every
40time the total size of the flushed part of the current trace chunk is at
41least 'SIZE'.
980bb5fd 42
484b2a0c
PP
43For both the option:--timer and option:--size options, LTTng checks the
44schedule condition periodically using the monitor timers of the channels
45of the selected tracing session (see the nloption:--monitor-timer option
46of man:lttng-enable-channel(1)). This means that:
47
48* With the option:--timer='PERIODUS' option, LTTng can perform an
49 automatic rotation when the elapsed time since the last automatic
50 rotation is slightly greater than 'PERIODUS'.
51+
52The exact precision depends on the precision of the monitor timer, which
53relies on the precision of the platform implementation of POSIX timers.
54
55* With the option:--size='SIZE' option, LTTng can perform an automatic
56 rotation when the size of the flushed part of the current trace chunk
57 is greater than 'SIZE'.
58
59You may combine the option:--timer and option:--size options.
eb027cfc 60
980bb5fd 61The naming convention of a trace chunk archive which an automatic
484b2a0c
PP
62rotation operation creates is the same as with the immediate rotation
63command, man:lttng-rotate(1).
64
65Unset a tracing session rotation schedule with the
66man:lttng-disable-rotation(1) command.
67
68[IMPORTANT]
69====
70The `enable-rotation` command only works when:
71
72* The selected tracing session was created in normal mode or in network
73 streaming mode (see man:lttng-create(1)).
980bb5fd 74
484b2a0c
PP
75* No channel was created with a configured trace file count or size
76 limit (see the nloption:--tracefile-size and
77 nloption:--tracefile-count options of man:lttng-enable-channel(1)).
980bb5fd 78
484b2a0c
PP
79For a given tracing session, LTTng only performs an automatic rotation
80when no other rotation is currently happening.
81====
980bb5fd
PP
82
83
84include::common-cmd-options-head.txt[]
85
86
31099add
PP
87Rotation schedule condition
88~~~~~~~~~~~~~~~~~~~~~~~~~~~
980bb5fd 89option:--size='SIZE'::
484b2a0c
PP
90 Set a rotation schedule so that LTTng performs an automatic rotation
91 every time the total size of the flushed part of the current trace
92 chunk is at least 'SIZE' bytes.
93+
94The `k`{nbsp}(KiB), `M`{nbsp}(MiB), and `G`{nbsp}(GiB) suffixes are
95supported.
96
97option:--timer='PERIODUS'::
98 Set a rotation schedule so that LTTng performs an automatic rotation at
99 least every 'PERIODUS' microseconds.
100+
101The `ms`{nbsp}(milliseconds), `s`{nbsp}(seconds), `m`{nbsp}(minutes),
102and `h`{nbsp}(hours) suffixes are supported.
103
104
105Recording target
106~~~~~~~~~~~~~~~~
980bb5fd 107option:-s 'SESSION', option:--session='SESSION'::
31099add
PP
108 Set a rotation schedule for the tracing session named 'SESSION'
109 instead of the current tracing session.
980bb5fd
PP
110
111
112include::common-cmd-help-options.txt[]
113
114
980bb5fd
PP
115include::common-cmd-footer.txt[]
116
117
118SEE ALSO
119--------
484b2a0c
PP
120man:lttng(1),
121man:lttng-create(1),
980bb5fd 122man:lttng-disable-rotation(1),
484b2a0c 123man:lttng-rotate(1)
This page took 0.04602 seconds and 5 git commands to generate.