NAME | SYNOPSIS | DESCRIPTION | OPTIONS | LIMITATIONS | ENVIRONMENT VARIABLES | FILES | EXIT STATUS | BUGS | RESOURCES | COPYRIGHTS | THANKS | AUTHORS | SEE ALSO | COLOPHON

LTTNG-ENABLE-ROTAT(1)           LTTng Manual           LTTNG-ENABLE-ROTAT(1)

NAME         top

       lttng-enable-rotation - Set a tracing session's automatic rotation
       schedule

SYNOPSIS         top

       lttng [GENERAL OPTIONS] enable-rotation (--timer=PERIOD | --size=SIZE)
             [--session=SESSION]

DESCRIPTION         top

       The lttng enable-rotation command sets an automatic rotation schedule
       for the current tracing session, or for the tracing session named
       SESSION if provided. See lttng-rotate(1) for more information about
       the concepts of a tracing session rotation and a trace chunk.

       With the --timer option, the rotation schedule is set so that an
       automatic rotation occurs at least every PERIOD (microseconds without
       a unit suffix).

       With the --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).

       With both the --timer and --size options, LTTng checks the schedule
       condition periodically using the monitor timers of the tracing
       session’s channels. This means that, with the --timer option, the
       automatic rotation can occur when the elapsed time since the last
       automatic rotation is greater than PERIOD, and with the --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
       --monitor-timer option in lttng-enable-channel(1) for more
       information about the monitor timer.

       The naming convention of a trace chunk archive which an automatic
       rotation creates is the same as with the manual rotation command,
       lttng-rotate(1).

       For a given tracing session, you cannot set multiple automatic
       rotation schedules with the --timer or the --size option.

       You can unset an automatic rotation schedule with the
       lttng-disable-rotation(1) command.

       See LIMITATIONS for important limitations regarding this command.

OPTIONS         top

       General options are described in lttng(1).

   Automatic rotation schedule condition
       One of:

       --size=SIZE
           Set an automatic 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.

       --timer=PERIOD
           Set an automatic 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.

   Target
       -s SESSION, --session=SESSION
           Set an automatic rotation schedule for the tracing session named
           SESSION instead of the current tracing session.

   Program information
       -h, --help
           Show command help.

           This option, like lttng-help(1), attempts to launch /usr/bin/man
           to view the command’s man page. The path to the man pager can be
           overridden by the LTTNG_MAN_BIN_PATH environment variable.

       --list-options
           List available command options.

LIMITATIONS         top

       The lttng enable-rotation command only works when:

       ·   The tracing session is created in normal mode or in network
           streaming mode (see lttng-create(1)).

       ·   No channel was created with a configured trace file count or size
           limit (see the --tracefile-size and --tracefile-count options in
           lttng-enable-channel(1)).

       For a given tracing session, LTTng only performs an automatic
       rotation when no other rotation is currently happening.

ENVIRONMENT VARIABLES         top

       LTTNG_ABORT_ON_ERROR
           Set to 1 to abort the process after the first error is
           encountered.

       LTTNG_HOME
           Overrides the $HOME environment variable. Useful when the user
           running the commands has a non-writable home directory.

       LTTNG_MAN_BIN_PATH
           Absolute path to the man pager to use for viewing help
           information about LTTng commands (using lttng-help(1) or lttng
           COMMAND --help).

       LTTNG_SESSION_CONFIG_XSD_PATH
           Path in which the session.xsd session configuration XML schema
           may be found.

       LTTNG_SESSIOND_PATH
           Full session daemon binary path.

           The --sessiond-path option has precedence over this environment
           variable.

       Note that the lttng-create(1) command can spawn an LTTng session
       daemon automatically if none is running. See lttng-sessiond(8) for
       the environment variables influencing the execution of the session
       daemon.

FILES         top

       $LTTNG_HOME/.lttngrc
           User LTTng runtime configuration.

           This is where the per-user current tracing session is stored
           between executions of lttng(1). The current tracing session can
           be set with lttng-set-session(1). See lttng-create(1) for more
           information about tracing sessions.

       $LTTNG_HOME/lttng-traces
           Default output directory of LTTng traces. This can be overridden
           with the --output option of the lttng-create(1) command.

       $LTTNG_HOME/.lttng
           User LTTng runtime and configuration directory.

       $LTTNG_HOME/.lttng/sessions
           Default location of saved user tracing sessions (see
           lttng-save(1) and lttng-load(1)).

       /usr/local/etc/lttng/sessions
           System-wide location of saved tracing sessions (see lttng-save(1)
           and lttng-load(1)).

           Note
           $LTTNG_HOME defaults to $HOME when not explicitly set.

EXIT STATUS         top

       0
           Success

       1
           Command error

       2
           Undefined command

       3
           Fatal error

       4
           Command warning (something went wrong during the command)

BUGS         top

       If you encounter any issue or usability problem, please report it on
       the LTTng bug tracker <https://bugs.lttng.org/projects/lttng-tools>.

RESOURCES         top

       ·   LTTng project website <http://lttng.org>

       ·   LTTng documentation <http://lttng.org/docs>

       ·   Git repositories <http://git.lttng.org>

       ·   GitHub organization <http://github.com/lttng>

       ·   Continuous integration <http://ci.lttng.org/>

       ·   Mailing list <http://lists.lttng.org> for support and
           development: lttng-dev@lists.lttng.org

       ·   IRC channel <irc://irc.oftc.net/lttng>: #lttng on irc.oftc.net

COPYRIGHTS         top

       This program is part of the LTTng-tools project.

       LTTng-tools is distributed under the GNU General Public License
       version 2 <http://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html>.
       See the LICENSE <https://github.com/lttng/lttng-
       tools/blob/master/LICENSE> file for details.

THANKS         top

       Special thanks to Michel Dagenais and the DORSAL laboratory
       <http://www.dorsal.polymtl.ca/> at École Polytechnique de Montréal
       for the LTTng journey.

       Also thanks to the Ericsson teams working on tracing which helped us
       greatly with detailed bug reports and unusual test cases.

AUTHORS         top

       LTTng-tools was originally written by Mathieu Desnoyers, Julien
       Desfossez, and David Goulet. More people have since contributed to
       it.

       LTTng-tools is currently maintained by Jérémie Galarneau
       <mailto:jeremie.galarneau@efficios.com>.

SEE ALSO         top

       lttng-rotate(1), lttng-disable-rotation(1), lttng(1)

COLOPHON         top

       This page is part of the LTTng-Tools (    LTTng tools) project.
       Information about the project can be found at ⟨http://lttng.org/⟩.
       It is not known how to report bugs for this man page; if you know,
       please send a mail to man-pages@man7.org.  This page was obtained
       from the project's upstream Git repository
       ⟨git://git.lttng.org/lttng-tools.git⟩ on 2018-04-30.  (At that time,
       the date of the most recent commit that was found in the repository
       was 2018-04-27.)  If you discover any rendering problems in this HTML
       version of the page, or you believe there is a better or more up-to-
       date source for the page, or you have corrections or improvements to
       the information in this COLOPHON (which is not part of the original
       manual page), send a mail to man-pages@man7.org

LTTng 2.11.0-pre                 04/30/2018            LTTNG-ENABLE-ROTAT(1)

Pages that refer to this page: lttng(1)lttng-destroy(1)lttng-disable-rotation(1)lttng-enable-channel(1)lttng-regenerate(1)lttng-rotate(1)lttng-stop(1)