X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=doc%2Fman%2Flttng-enable-rotation.1.txt;h=a002085aa6c24e528bb3367f37d9dfe8d5981f3f;hp=eb7622d54f86034169afaf37924440030005551b;hb=89751b0293d364dca2e6a89d85ab9e7c9cda8bf6;hpb=17bb414db4aa496cf78525e10a947a4e47dd5f9c diff --git a/doc/man/lttng-enable-rotation.1.txt b/doc/man/lttng-enable-rotation.1.txt index eb7622d54..a002085aa 100644 --- a/doc/man/lttng-enable-rotation.1.txt +++ b/doc/man/lttng-enable-rotation.1.txt @@ -1,5 +1,6 @@ lttng-enable-rotation(1) ======================== +:revdate: 13 November 2018 NAME @@ -10,8 +11,8 @@ lttng-enable-rotation - Set a tracing session's 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='PERIOD' | option:--size='SIZE' | option:--timer='PERIOD' option:--size='SIZE') DESCRIPTION @@ -32,14 +33,20 @@ without a unit suffix). For both 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'. Therefore the -'PERIOD' and 'SIZE' arguments are approximations. See the -nloption:--monitor-timer option in man:lttng-enable-channel(1) for more -information about the monitor timer. +session's channels (see the nloption:--monitor-timer option of the +man:lttng-enable-channel(1) command). This means that: + +* With the option:--timer option, the automatic rotation can occur when + the elapsed time since the last automatic rotation is slightly greater + than 'PERIOD'. The exact precision is governed by the monitor timer's + precision, which relies on the precision of the platform's + implementation of POSIX timers. + +* 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'. + +You can combine the option:--timer and option:--size options. The naming convention of a trace chunk archive which an automatic rotation creates is the same as with the immediate rotation command, @@ -57,8 +64,6 @@ include::common-cmd-options-head.txt[] Rotation schedule condition ~~~~~~~~~~~~~~~~~~~~~~~~~~~ -One of: - 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