doc/man/lttng-enable-rotation.1.txt

   1 lttng-enable-rotation(1)
   2 ========================
   3
   4
   5 NAME
   6 ----
   7 lttng-enable-rotation - Set a tracing session's automatic rotation schedule
   8
   9
  10 SYNOPSIS
  11 --------
  12 [verse]
  13 *lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *enable-rotation* (option:--timer='PERIOD' | option:--size='SIZE')
  14       [option:--session='SESSION']
  15
  16
  17 DESCRIPTION
  18 -----------
  19 The `lttng enable-rotation` command sets an automatic rotation schedule
  20 for the current tracing session, or for the tracing session named
  21 'SESSION' if provided. See man:lttng-rotate(1) for more information
  22 about the concepts of a tracing session _rotation_ and a _trace chunk_.
  23
  24 With the option:--timer option, the rotation schedule is set so that an
  25 automatic rotation occurs at least every 'PERIOD' (microseconds without
  26 a unit suffix).
  27
  28 With the option:--size option, the rotation schedule is set
  29 so that an automatic rotation occurs every time the total size of the
  30 flushed part of the current trace chunk is at least 'SIZE' (bytes
  31 without a unit suffix).
  32
  33 With both the option:--timer and option:--size options, LTTng checks the
  34 schedule condition periodically using the monitor timers of the tracing
  35 session's channels. This means that, with the option:--timer option, the
  36 automatic rotation can occur when the elapsed time since the last
  37 automatic rotation is greater than 'PERIOD', and with the option:--size
  38 option, the automatic rotation can occur when the size of the flushed
  39 part of the current trace chunk is greater than 'SIZE'. See the
  40 nloption:--monitor-timer option in man:lttng-enable-channel(1) for more
  41 information about the monitor timer.
  42
  43 The naming convention of a trace chunk archive which an automatic
  44 rotation creates is the same as with the manual rotation command,
  45 man:lttng-rotate(1).
  46
  47 For a given tracing session, you cannot set multiple automatic rotation
  48 schedules with the option:--timer or the option:--size option.
  49
  50 You can unset an automatic rotation schedule with the
  51 man:lttng-disable-rotation(1) command.
  52
  53 See <<limitations,LIMITATIONS>> for important limitations regarding
  54 this command.
  55
  56
  57 include::common-cmd-options-head.txt[]
  58
  59
  60 Automatic rotation schedule condition
  61 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  62 One of:
  63
  64 option:--size='SIZE'::
  65     Set an automatic rotation schedule so that an automatic rotation
  66     occurs every time the total size of the flushed part of the current
  67     trace chunk is at least 'SIZE' bytes. The `k` (kiB), `M` (MiB), and
  68     `G` (GiB) suffixes are supported.
  69
  70 option:--timer='PERIOD'::
  71     Set an automatic rotation schedule so that an automatic rotation
  72     occurs at least every 'PERIOD' microseconds. The
  73     `ms` (milliseconds), `s` (seconds), `m` (minutes), and `h` (hours)
  74     suffixes are supported.
  75
  76
  77 Target
  78 ~~~~~~
  79 option:-s 'SESSION', option:--session='SESSION'::
  80     Set an automatic rotation schedule for the tracing session named
  81     'SESSION' instead of the current tracing session.
  82
  83
  84 include::common-cmd-help-options.txt[]
  85
  86
  87 [[limitations]]
  88 LIMITATIONS
  89 -----------
  90 The `lttng enable-rotation` command only works when:
  91
  92 * The tracing session is created in normal mode or in network streaming
  93   mode (see man:lttng-create(1)).
  94
  95 * No channel was created with a configured trace file count or size
  96   limit (see the nloption:--tracefile-size and
  97   nloption:--tracefile-count options in man:lttng-enable-channel(1)).
  98
  99 For a given tracing session, LTTng only performs an automatic rotation
 100 when no other rotation is currently happening.
 101
 102
 103 include::common-cmd-footer.txt[]
 104
 105
 106 SEE ALSO
 107 --------
 108 man:lttng-rotate(1),
 109 man:lttng-disable-rotation(1),
 110 man:lttng(1)