LTTNG-STOP(1)

📦
version 2.15.1 · 12 versions
, in ubuntu stonking

💅 lttng-stop — the "okay bestie, we're DONE recording" command 💅

part of the LTTng Manual girlies ✨ — stop one or more LTTng recording sessions, no cap

🌸 SYNOPSIS 🌸

lttng [GENERAL OPTIONS] stop [--no-wait]
      [--all | --glob=PATTERN | SESSION]

✨ DESCRIPTION ✨

Okay so lttng stop stops one or more recording sessions. Translation for the group chat: it deactivates the LTTng tracers for whichever sessions you point at. 🫷

Here's who gets stopped, depending on what you hand it:

  • With the SESSION argument — the recording session named SESSION. Just say their name and they come running. 💁‍♀️
  • With the --glob=PATTERN option — every recording session whose name matches the globbing pattern PATTERN. Fashion-matching but for session names. 🎀
  • With the --all option — literally all the recording sessions of the connected session daemon for your Unix user, or for all users if your Unix user is root — exactly as listed in the output of lttng list (peep lttng-list(1)). 👑
Wanna know how a user application even connects to a session daemon? Go read the "Session daemon connection" section of lttng(1). It's giving required reading fr fr.
  • Otherwise (you gave it nothing, iconique) — the current recording session. The default one. The main character. 🫶

Want the lore on what a "current recording session" even is? That's lttng-concepts(7). Also lttng-concepts(7) for recording sessions in general. Same page, double duty, slay. 💖

Important vibe check: the recording session(s) you selected must be active (started — see lttng-start(1)). A recording session is inactive when it's created (see lttng-create(1)), like a phone that's off, bestie.

Alsooo, a stop-session trigger action can stop a recording session too (see lttng-add-trigger(1)). Not everything has to be typed by hand, iykyk. ✨

Need to wake some inactive sessions back up? That's lttng-start(1). The circle of life. 🦋

By default, the stop command is a perfectionist 😌 — it makes sure the trace data of the selected recording session(s) is valid before it exits. If you want it to just dip immediately, use the --no-wait option. But hear me out on the trade-off:

⚠️ With --no-wait, the trace(s) might not be valid when the command exits, and there's no way to know when it/they becomes valid. Not knowing is the worst. 😭

Peep the "EXAMPLES" section below for usage examples! 🍓

🌈 OPTIONS 🌈

See lttng(1) for GENERAL OPTIONS. (The ✨general✨ ones, not these.)

  • -a, --all — Stop all the recording sessions of your Unix user, or of all users if your Unix user is root, as listed in the output of lttng-list(1). Go big or go home. 👑
  • -g PATTERN, --glob=PATTERN — Stop the recording sessions of which the globbing pattern PATTERN matches the name.

In PATTERN, the * character means "match anything". Wanna match a literal * character instead? Use \*. Escape her. 💅

  • -n, --no-wait — Do NOT ensure that the trace data of the selected recording session(s) is valid before exiting. Live fast, exit immediately. 🏃‍♀️

🎀 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. She knows a guy. 🧚

  • --list-options — List available command options and quit. A little menu, a little treat. 🍓

💀 EXIT STATUS 💀

  • 0 — Success. Ate. 💅
  • 1 — Command error.
  • 2 — Undefined command.
  • 3 — Fatal error.
  • 4 — Command warning (something went wrong during the command).

she tells you exactly how it went, no guessing ✨

🌸 ENVIRONMENT 🌸

  • LTTNG_ABORT_ON_ERROR — Set to 1 to abort the process after the first error is encountered. Zero tolerance policy. 🙈
  • 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. (Your home dir said "no" but LTTng said "bet".) 💜

  • 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. It's giving vintage, and vintage misses out. 🕰️
  • 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. Pick your own man girlie. 💖
  • LTTNG_NO_UTF_8 — Set to 1 to NOT emit multi-byte UTF-8 sequences, even if the locale claims to support it. The locale is lying, bestie. 😭
  • LTTNG_SESSION_CONFIG_XSD_PATH — Path to the directory containing the session.xsd recording session configuration XML schema. The blueprint. 📜
  • 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. Options stay winning. 👑

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

The NO_COLOR environment variable overrides this. (Yes, it's a whole hierarchy. Respect it.)

One of:

  • auto (default) — Only emit SGR codes when the standard output is connected to a color-capable terminal. She reads the room. 💅
  • always — Always emit SGR codes. Color maximalist behavior. 🌈
  • never — Never emit SGR codes. Minimalist era. 🖤
  • NO_COLOR — If set and not empty, then it's equivalent to setting LTTNG_TERM_COLOR to never.

See NO_COLOR <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. (Where the "who am I recording as" memory lives. 🧠)

  • $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. Do not let the default decide your destiny. ✨

  • $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)). The communal closet. 🎀
Note 📝 $LTTNG_HOME defaults to the value of the HOME environment variable.

🔥 EXAMPLES 🔥

Example 1. Stop the current recording session. — the "you know who" of sessions 💅

$ lttng stop

Example 2. Stop a specific recording session. — name names, bestie

$ lttng stop my-session

Example 3. Stop the current recording session without waiting for completion.

Peep the --no-wait option.

$ lttng stop --no-wait

Example 4. Stop all the recording sessions.

Peep the --all option.

$ lttng stop --all

Example 5. Stop all the recording sessions of which the name starts with bar.

Peep the --glob option.

$ lttng stop --glob='bar*'

🌈 RESOURCES 🌈

link in bio, every single one of them 🔗✨

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.

read the license, bestie, it's the rules 📜

💖 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. 🫶

Also thanks to the Ericsson teams working on tracing which helped us greatly with detailed bug reports and unusual test cases. The bug reports were detailed, the test cases were unusual, and honestly? Iconic. 🧚

🌟 SEE ALSO 🌟

lttng(1), lttng-add-trigger(1), lttng-create(1), lttng-enable-event(1), lttng-rotate(1), lttng-start(1), lttng-concepts(7)

mwah 💋 that's a wrap — this page is straight out of LTTng 2.15.1, dated 1 April 2025, LTTNG-STOP(1) girlie. Go stop something (a session, obviously 🫶). bye bestie! ✨🎀🦋💅

📦 where this page comes from