X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=doc%2Fman%2Flttng-enable-rotation.1.txt;fp=doc%2Fman%2Flttng-enable-rotation.1.txt;h=d8ec88e75e4f28469a0201e35ace732f5d73d732;hp=cd8de7309131468db42c44e0795de93cb14203b7;hb=26f0c7794376456fcb5b13d4eae91c0ccf0dfe66;hpb=65750bcdda3dd71b72683573d35a662c0b467a8f diff --git a/doc/man/lttng-enable-rotation.1.txt b/doc/man/lttng-enable-rotation.1.txt index cd8de7309..d8ec88e75 100644 --- a/doc/man/lttng-enable-rotation.1.txt +++ b/doc/man/lttng-enable-rotation.1.txt @@ -1,11 +1,11 @@ lttng-enable-rotation(1) ======================== -:revdate: 21 April 2021 +:revdate: 3 May 2021 NAME ---- -lttng-enable-rotation - Set a tracing session rotation schedule +lttng-enable-rotation - Set an LTTng tracing session rotation schedule SYNOPSIS @@ -24,12 +24,11 @@ With the option:--session='SESSION' option:: The tracing session named 'SESSION'. Without the option:--session option:: - The current tracing session (see man:lttng-create(1) and - man:lttng-set-session(1) to learn more about the current tracing - session). + The current tracing session (see man:lttng-concepts(7) to learn more + about the current tracing session). -See man:lttng-rotate(1) for more information about the concepts of a -tracing session _rotation_ and a _trace chunk_. +See man:lttng-concepts(7) to learn more about the tracing session +rotation and trace chunk concepts. With the option:--timer='PERIODUS' option, the `enable-rotation` command sets a rotation schedule so that LTTng performs an automatic rotation at @@ -43,7 +42,7 @@ least 'SIZE'. 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 man:lttng-enable-channel(1)). This means that: +of the man:lttng-enable-channel(1) command). This means that: * With the option:--timer='PERIODUS' option, LTTng can perform an automatic rotation when the elapsed time since the last automatic @@ -58,26 +57,26 @@ relies on the precision of the platform implementation of POSIX timers. You may combine the option:--timer and option:--size options. -The naming convention of a trace chunk archive which an automatic -rotation operation creates is the same as with the immediate rotation -command, man:lttng-rotate(1). +See the man:lttng-concepts(7) to learn how LTTng names a trace chunk +archive directory. Unset a tracing session rotation schedule with the man:lttng-disable-rotation(1) command. [IMPORTANT] ==== -The `enable-rotation` command only works when: +You may only use the `enable-rotation` command when: * 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 man:lttng-enable-channel(1)). + nloption:--tracefile-count options of the man:lttng-enable-channel(1) + command). For a given tracing session, LTTng only performs an automatic rotation -when no other rotation is currently happening. +when it's not currently performing a rotation. ==== @@ -95,8 +94,8 @@ 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 at - least every 'PERIODUS' microseconds. + 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. @@ -118,6 +117,7 @@ include::common-cmd-footer.txt[] SEE ALSO -------- man:lttng(1), +man:lttng-concepts(7), man:lttng-create(1), man:lttng-disable-rotation(1), man:lttng-rotate(1)