LTTNG-METADATA(1)

📦
version 2.15.1 · 12 versions
, in ubuntu stonking

💅 LTTNG-METADATA — the lttng-metadata manual, bestie edition

okay so this is the page for lttng-metadata, which lives in the LTTng Manual (that's section 1 of the manual, if u were wondering). it's all about managing the metadata generation of an LTTng recording session. yes babes, metadata. it's giving ✨underrated✨.

🌸 NAME 🌸

lttng-metadata — manage the metadata generation of an LTTng recording session 🎀

🦋 SYNOPSIS 🦋

lttng [GENERAL OPTIONS] metadata regenerate [--session=SESSION]

💜 DESCRIPTION 💜

Warning 🚨 this command is deprecated, bestie. it got replaced by lttng regenerate metadata (go read lttng-regenerate(1) for the glow-up version). so like... it still exists, but it's the older sibling. 😭

✨ OPTIONS ✨

for GENERAL OPTIONS, go check lttng(1) — that's where the main-character general options hang out. 👑

  • -s SESSION, --session=SESSION — manage the metadata generation of the recording session named SESSION instead of the current recording session (and if u wanna know what even is the current recording session, lttng-concepts(7) has u covered 🫶).

🎀 Program information 🎀

  • -h, --help — show help.

this option literally tries to launch /usr/bin/man to pull up this very manual page. wanna use a different manual pager? override the path with the LTTNG_MAN_BIN_PATH environment variable. slay. 💅

  • --list-options — list the available command options and then quit. short, sweet, iconic. ✨

🔥 EXIT STATUS 🔥

  • 0 — success ✅
  • 1 — command error 😬
  • 2 — undefined command 💀
  • 3 — fatal error 😭
  • 4 — command warning (something went wrong during the command, like... not fatal but not fine either) 🙈

🌈 ENVIRONMENT 🌈

  • LTTNG_ABORT_ON_ERROR — set to 1 to abort the process after the first error is encountered. no second chances, periodt.
  • LTTNG_HOME — path to the LTTng home directory.

defaults to $HOME.

super 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. no cap. 📵

  • 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. it said "no thoughts, just ASCII". 🚫
  • 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.

heads up: the --sessiond-path general option overrides this environment variable. okay so listen to the flag first. 👑

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

the NO_COLOR environment variable overrides this one. sorry bestie, NO_COLOR wins. 💔

one of:

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

go learn more at the NO_COLOR site, https://no-color.org/ — it's a whole movement. 🫶

🍓 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. it's basically the "who am I rn" file. 📝

  • $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.

🧚 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 at https://github.com/lttng/lttng-tools/blob/master/LICENSE for the deets. 📜

💖 THANKS 💖

special thanks to Michel Dagenais and the DORSAL laboratory (http://www.dorsal.polymtl.ca/) at École Polytechnique de Montréal for the LTTng journey. y'all ate. 🙏

also thanks to the Ericsson teams working on tracing, who helped greatly with detailed bug reports and unusual test cases. the way u found those weird edge cases... iconic. 🔍

🫶 SEE ALSO 🫶

lttng(1), lttng-regenerate(1), lttng-concepts(7)

and that's the whole page, bestie 💜 this was LTTng 2.15.1, dated 14 June 2021 — no cap, that's the version and the date right there at the bottom of the original. now go regenerate some metadata (with the new command tho, fr fr) 🎀✨

📦 where this page comes from