1 lttng-enable-rotation(1)
2 ========================
8 lttng-enable-rotation - Set an LTTng recording session rotation schedule
14 *lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *enable-rotation* [option:--session='SESSION']
15 (option:--timer='PERIODUS' | option:--size='SIZE' | option:--timer='PERIODUS' option:--size='SIZE')
20 The `lttng enable-rotation` command sets a recording session rotation
23 With the option:--session='SESSION' option::
24 The recording session named 'SESSION'.
26 Without the option:--session option::
27 The current recording session (see man:lttng-concepts(7) to learn more
28 about the current recording session).
30 See man:lttng-concepts(7) to learn more about the recording session
31 rotation and trace chunk concepts.
33 With the option:--timer='PERIODUS' option, the `enable-rotation` command
34 sets a rotation schedule so that LTTng performs an automatic rotation at
35 least every 'PERIODUS'.
37 With the option:--size='SIZE' option, the `enable-rotation` command sets
38 a rotation schedule so that LTTng performs an automatic rotation every
39 time the total size of the flushed part of the current trace chunk is at
42 For both the option:--timer and option:--size options, LTTng checks the
43 schedule condition periodically using the monitor timers of the channels
44 of the selected recording session (see the nloption:--monitor-timer
45 option of the man:lttng-enable-channel(1) command). This means that:
47 * With the option:--timer='PERIODUS' option, LTTng can perform an
48 automatic rotation when the elapsed time since the last automatic
49 rotation is slightly greater than 'PERIODUS'.
51 The exact precision depends on the precision of the monitor timer, which
52 relies on the precision of the platform implementation of POSIX timers.
54 * With the option:--size='SIZE' option, LTTng can perform an automatic
55 rotation when the size of the flushed part of the current trace chunk
56 is greater than 'SIZE'.
58 You may combine the option:--timer and option:--size options.
60 See the man:lttng-concepts(7) to learn how LTTng names a trace chunk
63 See the ``<<examples,EXAMPLES>>'' section below for usage examples.
65 Unset a recording session rotation schedule with the
66 man:lttng-disable-rotation(1) command.
70 You may only use the `enable-rotation` command when:
72 * The selected recording session was created in normal mode or in
73 network streaming mode (see man:lttng-create(1)).
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 the man:lttng-enable-channel(1)
80 For a given recording session, LTTng only performs an automatic rotation
81 when it's not currently performing a rotation.
85 include::common-lttng-cmd-options-head.txt[]
88 Rotation schedule condition
89 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
90 option:--size='SIZE'::
91 Set a rotation schedule so that LTTng performs an automatic rotation
92 every time the total size of the flushed part of the current trace
93 chunk is at least 'SIZE' bytes.
95 The `k`{nbsp}(KiB), `M`{nbsp}(MiB), and `G`{nbsp}(GiB) suffixes are
98 option:--timer='PERIODUS'::
99 Set a rotation schedule so that LTTng performs an automatic rotation
100 approximately every 'PERIODUS' microseconds.
102 The `ms`{nbsp}(milliseconds), `s`{nbsp}(seconds), `m`{nbsp}(minutes),
103 and `h`{nbsp}(hours) suffixes are supported.
108 option:-s 'SESSION', option:--session='SESSION'::
109 Set a rotation schedule for the recording session named 'SESSION'
110 instead of the current recording session.
113 include::common-lttng-cmd-help-options.txt[]
116 include::common-lttng-cmd-after-options.txt[]
122 .Set the size-based rotation schedule of the current recording session.
124 See the option:--size option.
128 $ lttng disable-rotation --size=256M
132 .Set the periodic rotation schedule of a specific recording session.
134 See the option:--timer and option:--session options.
138 $ lttng disable-rotation --session=my-session --timer=5m
143 include::common-footer.txt[]
150 man:lttng-disable-rotation(1),
152 man:lttng-concepts(7)