doc/man: follow man-pages(7) for section names/order and for "SEE ALSO"
[lttng-tools.git] / doc / man / lttng-enable-rotation.1.txt
index 53189da925137ef2cb2c431a794b06d33036a531..f965ed973e3bb2b1d06c4ef302520a4935b066c1 100644 (file)
 lttng-enable-rotation(1)
 ========================
+:revdate: 3 May 2021
 
 
 NAME
 ----
-lttng-enable-rotation - Set a tracing session's rotation schedule
+lttng-enable-rotation - Set an LTTng tracing session rotation schedule
 
 
 SYNOPSIS
 --------
 [verse]
-*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *enable-rotation* (option:--timer='PERIOD' | option:--size='SIZE')
-      [option:--session='SESSION']
+*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *enable-rotation* [option:--session='SESSION']
+      (option:--timer='PERIODUS' | option:--size='SIZE' | option:--timer='PERIODUS' option:--size='SIZE')
 
 
 DESCRIPTION
 -----------
-The `lttng enable-rotation` command sets a rotation schedule for the
-current tracing session, or for the tracing session named 'SESSION' if
-provided. See man:lttng-rotate(1) for more information about the
-concepts of a tracing session _rotation_ and a _trace chunk_.
+The `lttng enable-rotation` command sets a tracing session rotation
+schedule for:
 
-With the option:--timer option, the rotation schedule is set so that an
-automatic rotation occurs at least every 'PERIOD' (microseconds without
-a unit suffix).
+With the option:--session='SESSION' option::
+    The tracing session named 'SESSION'.
 
-With the option:--size option, the rotation schedule is set
-so that an automatic rotation occurs every time the total size of the
-flushed part of the current trace chunk is at least 'SIZE' (bytes
-without a unit suffix).
+Without the option:--session option::
+    The current tracing session (see man:lttng-concepts(7) to learn more
+    about the current tracing session).
 
-With both the option:--timer and option:--size options, LTTng checks the
-schedule condition periodically using the monitor timers of the tracing
-session's channels. This means that, with the option:--timer option, the
-automatic rotation can occur when the elapsed time since the last
-automatic rotation is greater than 'PERIOD', and with the option:--size
-option, the automatic rotation can occur when the size of the flushed
-part of the current trace chunk is greater than 'SIZE'. See the
-nloption:--monitor-timer option in man:lttng-enable-channel(1) for more
-information about the monitor timer.
+See man:lttng-concepts(7) to learn more about the tracing session
+rotation and trace chunk concepts.
 
-The naming convention of a trace chunk archive which an automatic
-rotation creates is the same as with the immediate rotation command,
-man:lttng-rotate(1).
+With the option:--timer='PERIODUS' option, the `enable-rotation` command
+sets a rotation schedule so that LTTng performs an automatic rotation at
+least every 'PERIODUS'.
 
-For a given tracing session, you cannot set multiple rotation schedules
-with the option:--timer or the option:--size option.
+With the option:--size='SIZE' option, the `enable-rotation` command sets
+a rotation schedule so that LTTng performs an automatic rotation every
+time the total size of the flushed part of the current trace chunk is at
+least 'SIZE'.
 
-You can unset a rotation schedule with the man:lttng-disable-rotation(1)
-command.
+For both the option:--timer and option:--size options, LTTng checks the
+schedule condition periodically using the monitor timers of the channels
+of the selected tracing session (see the nloption:--monitor-timer option
+of the man:lttng-enable-channel(1) command). This means that:
 
-See <<limitations,LIMITATIONS>> for important limitations regarding
-this command.
+* With the option:--timer='PERIODUS' option, LTTng can perform an
+  automatic rotation when the elapsed time since the last automatic
+  rotation is slightly greater than 'PERIODUS'.
++
+The exact precision depends on the precision of the monitor timer, which
+relies on the precision of the platform implementation of POSIX timers.
 
+* With the option:--size='SIZE' option, LTTng can perform an automatic
+  rotation when the size of the flushed part of the current trace chunk
+  is greater than 'SIZE'.
 
-include::common-cmd-options-head.txt[]
+You may combine the option:--timer and option:--size options.
 
+See the man:lttng-concepts(7) to learn how LTTng names a trace chunk
+archive directory.
 
-Rotation schedule condition
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
-One of:
+Unset a tracing session rotation schedule with the
+man:lttng-disable-rotation(1) command.
 
-option:--size='SIZE'::
-    Set a rotation schedule so that an automatic rotation occurs every
-    time the total size of the flushed part of the current trace chunk
-    is at least 'SIZE' bytes. The `k` (kiB), `M` (MiB), and `G` (GiB)
-    suffixes are supported.
+[IMPORTANT]
+====
+You may only use the `enable-rotation` command when:
 
-option:--timer='PERIOD'::
-    Set a rotation schedule so that an automatic rotation occurs at
-    least every 'PERIOD' microseconds. The `ms` (milliseconds), `s`
-    (seconds), `m` (minutes), and `h` (hours) suffixes are supported.
+* The selected tracing session was created in normal mode or in network
+  streaming mode (see man:lttng-create(1)).
 
+* No channel was created with a configured trace file count or size
+  limit (see the nloption:--tracefile-size and
+  nloption:--tracefile-count options of the man:lttng-enable-channel(1)
+  command).
 
-Target
-~~~~~~
-option:-s 'SESSION', option:--session='SESSION'::
-    Set a rotation schedule for the tracing session named 'SESSION'
-    instead of the current tracing session.
-
+For a given tracing session, LTTng only performs an automatic rotation
+when it's not currently performing a rotation.
+====
 
-include::common-cmd-help-options.txt[]
 
+include::common-cmd-options-head.txt[]
 
-[[limitations]]
-LIMITATIONS
------------
-The `lttng enable-rotation` command only works when:
 
-* The tracing session is created in normal mode or in network streaming
-  mode (see man:lttng-create(1)).
+Rotation schedule condition
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+option:--size='SIZE'::
+    Set a rotation schedule so that LTTng performs an automatic rotation
+    every time the total size of the flushed part of the current trace
+    chunk is at least 'SIZE' bytes.
++
+The `k`{nbsp}(KiB), `M`{nbsp}(MiB), and `G`{nbsp}(GiB) suffixes are
+supported.
+
+option:--timer='PERIODUS'::
+    Set a rotation schedule so that LTTng performs an automatic rotation
+    approximately every 'PERIODUS' microseconds.
++
+The `ms`{nbsp}(milliseconds), `s`{nbsp}(seconds), `m`{nbsp}(minutes),
+and `h`{nbsp}(hours) suffixes are supported.
+
+
+Recording target
+~~~~~~~~~~~~~~~~
+option:-s 'SESSION', option:--session='SESSION'::
+    Set a rotation schedule for the tracing session named 'SESSION'
+    instead of the current tracing session.
 
-* No channel was created with a configured trace file count or size
-  limit (see the nloption:--tracefile-size and
-  nloption:--tracefile-count options in man:lttng-enable-channel(1)).
 
-For a given tracing session, LTTng only performs an automatic rotation
-when no other rotation is currently happening.
+include::common-cmd-help-options.txt[]
 
 
 include::common-cmd-footer.txt[]
@@ -104,6 +116,8 @@ include::common-cmd-footer.txt[]
 
 SEE ALSO
 --------
-man:lttng-rotate(1),
+man:lttng(1),
+man:lttng-create(1),
 man:lttng-disable-rotation(1),
-man:lttng(1)
+man:lttng-rotate(1),
+man:lttng-concepts(7)
This page took 0.02666 seconds and 5 git commands to generate.