LTTNG-DISABLE-ROTA(1)

📦
version 2.15.1 · 12 versions
, in ubuntu stonking

💅 lttng-disable-rotation — from the LTTng Manual (yes bestie, LTTNG-DISABLE-ROTA(1), that's the one)

✨ NAME ✨

lttng-disable-rotation — unset an LTTng recording session rotation schedule 🎀

🌸 SYNOPSIS 🌸

lttng [GENERAL OPTIONS] disable-rotation [--session=SESSION]
      (--timer | --size | --timer --size)

🦋 DESCRIPTION 🦋

okay so the lttng disable-rotation command unsets a rotation schedule that you (or someone iconic) previously set with the lttng-enable-rotation(1) command. and who is it doing this for?? depends:

  • with the --session=SESSION option — it's for the recording session named SESSION, periodt 💅
  • without the --session option — it's for the current recording session (go peek at lttng-concepts(7) if you wanna learn more about what "the current recording session" even means, iykyk)

also go read lttng-concepts(7) to learn more about the recording session rotation and trace chunk concepts — it's giving lore, honestly 📚

and scroll down to the EXAMPLES section for usage examples, because seeing it > reading it, fr fr ✨

💖 OPTIONS 💖

see lttng(1) for GENERAL OPTIONS — those are the shared ones, not our problem here 🌈

Rotation schedule condition 🎀

  • --size — unset the rotation schedule that was previously set with the --size option of the lttng-enable-rotation(1) command. bye bye size-based schedule 💀
  • --timer — unset the rotation schedule that was previously set with the --timer option of the lttng-enable-rotation(1) command. the timer schedule is so over 🕐✨

Recording target 🫶

  • -s SESSION, --session=SESSION — unset a rotation schedule for the recording session named SESSION instead of the current recording session. main character session selection, no cap 👑

Program information ⭐

  • -h, --help — show help.

this option attempts to launch /usr/bin/man to view this manual page. override the manual pager path with the LTTNG_MAN_BIN_PATH environment variable. it's lowkey doing its best 🥺

  • --list-options — list available command options and quit. a lil menu, a lil snack, we love her 🍓

💀 EXIT STATUS 💀

  • 0 — success 🎉 ate and left no crumbs
  • 1 — command error 😭
  • 2 — undefined command 🙈
  • 3 — fatal error 💀 not slay
  • 4 — command warning (something went wrong during the command) 👀

🌈 ENVIRONMENT 🌈

  • LTTNG_ABORT_ON_ERROR — set to 1 to abort the process after the first error is encountered. zero patience, we respect it ✋
  • LTTNG_HOME — path to the LTTng home directory.

defaults to $HOME.

useful when the Unix user running the commands has a non-writable home directory. (we've all been there 🫠)

  • LTTNG_LIST_LEGACY — set to 1 to use the legacy output format (LTTng 2.14 and earlier) for the lttng-list(1) command instead of the modern output format.

note that the legacy output doesn't show anything related to features introduced after LTTng 2.14. so like, it's giving nostalgic but also missing stuff 👵

  • LTTNG_MAN_BIN_PATH — absolute path to the manual pager to use to read the LTTng command-line help (with lttng-help(1) or with the --help option) instead of /usr/bin/man.
  • LTTNG_NO_UTF_8 — set to 1 to NOT emit multi-byte UTF-8 sequences, even if the locale claims to support it. plain text mode on purpose, respect 🧚
  • LTTNG_SESSION_CONFIG_XSD_PATH — path to the directory containing the session.xsd recording session configuration XML schema.
  • LTTNG_SESSIOND_PATH — absolute path to the LTTng session daemon binary (see lttng-sessiond(8)) to spawn from the lttng-create(1) command.

the --sessiond-path general option overrides this environment variable. so the CLI wins the vibe check 💅

  • LTTNG_TERM_COLOR — controls when to emit terminal SGR codes in the output.

the NO_COLOR environment variable overrides this.

one of:

  • auto (default) — only emit SGR codes when the standard output is connected to a color-capable terminal.
  • always — always emit SGR codes. rainbow always on 🌈
  • never — never emit SGR codes. boring but valid 🚫
  • NO_COLOR — if set and not empty, then it's equivalent to setting LTTNG_TERM_COLOR to never.

see NO_COLOR at https://no-color.org/ to learn more.

📁 FILES 📁

  • $LTTNG_HOME/.lttngrc — Unix user's LTTng runtime configuration.

this is where LTTng stores the name of the Unix user's current recording session between executions of lttng(1). lttng-create(1) and lttng-set-session(1) set the current recording session. the memory keeper bestie 🧠✨

  • $LTTNG_HOME/lttng-traces — default output directory of LTTng traces in local and snapshot modes.

override this path with the --output option of the lttng-create(1) command.

  • $LTTNG_HOME/.lttng — Unix user's LTTng runtime and configuration directory.
  • $LTTNG_HOME/.lttng/sessions — default directory containing the Unix user's saved recording session configurations (see lttng-save(1) and lttng-load(1)).
  • /etc/lttng/sessions — directory containing the system-wide saved recording session configurations (see lttng-save(1) and lttng-load(1)).
Note 💡: $LTTNG_HOME defaults to the value of the HOME environment variable.

🌟 EXAMPLES 🌟

Example 1. Unset the size-based rotation schedule of the current recording session.

see the --size option 👆

$ lttng disable-rotation --size

Example 2. Unset the periodic rotation schedule of a specific recording session.

see the --timer and --session options 👆

$ lttng disable-rotation --session=my-session --timer

🔥 RESOURCES 🔥

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 file for details — https://github.com/lttng/lttng-tools/blob/master/LICENSE.

🫶 THANKS 🫶

special thanks to Michel Dagenais and the DORSAL laboratory at École Polytechnique de Montréal (http://www.dorsal.polymtl.ca/) for the LTTng journey. iconic behavior, truly 🎓💖

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

🧚 SEE ALSO 🧚

lttng(1), lttng-enable-rotation(1), lttng-rotate(1), lttng-concepts(7)

k that's the whole page bestie 💅

this was LTTng 2.15.1, dated 14 June 2021, and the page you just read is LTTNG-DISABLE-ROTA(1) — now go unset a rotation schedule, you've got this 💖✨🎀

📦 where this page comes from