X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=doc%2Fman%2Flttng-rotate.1.txt;fp=doc%2Fman%2Flttng-rotate.1.txt;h=b994d7defd7ecf154e85ac69251514af4face3dc;hp=91df503feba6dbcc6603b3d28cdc612c67d99bfb;hb=e971184584781f70bbbfc52bbede8b9abf0436e5;hpb=da39b67ce2828bfc63a02db969048bfe1abd4ca0 diff --git a/doc/man/lttng-rotate.1.txt b/doc/man/lttng-rotate.1.txt index 91df503fe..b994d7def 100644 --- a/doc/man/lttng-rotate.1.txt +++ b/doc/man/lttng-rotate.1.txt @@ -1,11 +1,11 @@ lttng-rotate(1) =============== -:revdate: 17 May 2021 +:revdate: 14 June 2021 NAME ---- -lttng-rotate - Archive the current trace chunk of an LTTng tracing session +lttng-rotate - Archive the current trace chunk of an LTTng recording session SYNOPSIS @@ -20,29 +20,29 @@ The `lttng rotate` command archives to the file system the current trace chunk of: With the 'SESSION' argument:: - The tracing session named 'SESSION'. + The recording session named 'SESSION'. Without the 'SESSION' argument:: - The current tracing session (see man:lttng-concepts(7) to learn more - about the current tracing session). + The current recording session (see man:lttng-concepts(7) to learn + more about the current recording session). -This action is called a _tracing session rotation_. +This action is called a _recording session rotation_. -See man:lttng-concepts(7) to learn more about the tracing session +See man:lttng-concepts(7) to learn more about the recording session rotation and trace chunk concepts. You can use the `rotate` command: -* Any time the tracing session is active. +* Any time the recording session is active. -* A single time once the tracing session becomes inactive. +* A single time once the recording session becomes inactive. See man:lttng-concepts(7) to learn more about the activity of a -tracing session. +recording session. By default, the `rotate` command ensures that LTTng finished performing -the tracing session rotation before it prints the path of the archived -trace chunk and exits. The printed path is absolute when the tracing +the recording session rotation before it prints the path of the archived +trace chunk and exits. The printed path is absolute when the recording session was created in normal mode and relative to the base output directory of the relay daemon (see the nloption:--output option of man:lttng-relayd(8)) when it was created in network streaming mode (see @@ -53,14 +53,14 @@ this case, there's no easy way to know when the current trace chunk becomes archived, and the command does :not: print the path of the archived trace chunk. -Because LTTng flushes the current sub-buffers of the selected tracing -session when it performs a tracing session rotation, archived trace +Because LTTng flushes the current sub-buffers of the selected recording +session when it performs a recording session rotation, archived trace chunks are never redundant, that is, they do not overlap over time like snapshots can (see man:lttng-snapshot(1)). Also, a rotation does :not: directly cause discarded event records or packets. -A `rotate-session` trigger action can also rotate a tracing session (see -man:lttng-add-trigger(1)). +A `rotate-session` trigger action can also rotate a recording session +(see man:lttng-add-trigger(1)). See the ``<>'' section below for usage examples. @@ -68,8 +68,8 @@ See the ``<>'' section below for usage examples. ==== You may only use the `rotate` command when: -* The selected tracing session was created in normal mode or in network - streaming mode (see man:lttng-create(1)). +* The selected recording 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 @@ -85,7 +85,7 @@ include::common-lttng-cmd-options-head.txt[] option:-n, option:--no-wait:: - Do not ensure that the tracing session rotation operation is + Do not ensure that the recording session rotation operation is completed before exiting. @@ -98,7 +98,7 @@ include::common-lttng-cmd-after-options.txt[] [[examples]] EXAMPLES -------- -.Rotate the current tracing session. +.Rotate the current recording session. ==== [role="term"] ---- @@ -106,7 +106,7 @@ $ lttng rotate ---- ==== -.Rotate a specific tracing session. +.Rotate a specific recording session. ==== [role="term"] ---- @@ -114,7 +114,7 @@ $ lttng rotate my-session ---- ==== -.Rotate the current tracing session without waiting for completion. +.Rotate the current recording session without waiting for completion. ==== See the option:--no-wait option.