BABELTRACE2-HELP(1)

📦
version 2.1.2 · 9 versions
, in fedora 43, fedora 44

💖 babeltrace2-help — get the tea on a Babeltrace 2 plugin or component class 💖

okay so bestie, welcome to BABELTRACE2-HELP(1), aka the page that lives in the Babeltrace 2 manual and tells you how to ask babeltrace2 to spill the details about a plugin or a component class. it's giving "please explain yourself" but make it Unix. 🫶

✨ NAME ✨

babeltrace2-help — get help for a Babeltrace 2 plugin or component class

🌸 SYNOPSIS 🌸

so there's two ways to pull this off, and honestly both ate:

get help for a Babeltrace 2 plugin:

babeltrace2 [GENERAL OPTIONS] help PLUGIN-NAME

get help for a Babeltrace 2 component class:

babeltrace2 [GENERAL OPTIONS] help
            COMP-CLS-TYPE.PLUGIN-NAME.COMP-CLS-NAME

🦋 DESCRIPTION 🦋

the help command prints the details and help text of either:

  • the Babeltrace 2 plugin named PLUGIN-NAME, or
  • the specific component class of type COMP-CLS-TYPE named COMP-CLS-NAME that lives inside the plugin named PLUGIN-NAME.

if you wanna actually understand the Babeltrace 2 project and its core concepts (main character lore, fr fr), go read babeltrace2-intro(7). 💅

the available values for COMP-CLS-TYPE are, and yes you can use either spelling:

  • source, src — source component class.
  • filter, flt — filter component class.
  • sink — sink component class.

peep “EXAMPLES” below for usage examples, i promise they're cute. ✨

🎀 OPTIONS 🎀

General 💜

you can use these options before the command name, like a little pre-game. see babeltrace2(1) for more details.

  • -d, --debug — legacy option, babes: this is equivalent to --log-level=TRACE.
  • -l LVL, --log-level=LVL — set the log level of all known Babeltrace 2 loggers to LVL.
  • --omit-home-plugin-path — don't search for plugins in $HOME/.local/lib/babeltrace2/plugins.
  • --omit-system-plugin-path — don't search for plugins in /usr/local/lib/babeltrace2/plugins.
  • --plugin-path=PATH[:PATH]... — add PATH to the list of paths in which plugins can be found.
  • -v, --verbose — legacy option: this is equivalent to --log-level=INFO.

Command information 🌈

  • -h, --help — show the command help and quit. the classic "wait what does this do again" move.

🌟 EXAMPLES 🌟

Example 1. Get help for a plugin and all its component classes.

$ babeltrace2 help ctf

Example 2. Get help for a specific source component class.

$ babeltrace2 help source.ctf.fs

Example 3. Get help for a specific sink component class.

$ babeltrace2 help sink.text.pretty

🧚 ENVIRONMENT VARIABLES 🧚

Babeltrace 2 library 📚

  • BABELTRACE_EXEC_ON_ABORT=CMDLINE — execute the command line CMDLINE, as parsed like a UNIX 98 shell, when any part of the Babeltrace 2 project unexpectedly aborts.

the application only aborts when the executed command returns, ignoring its exit status.

this environment variable is ignored when the application has the setuid or the setgid access right flag set.
  • BABELTRACE_TERM_COLOR=(AUTO | NEVER | ALWAYS) — force the terminal color support for the babeltrace2(1) program and the project plugins.

the available values are:

  • AUTO — only emit terminal color codes when the standard output and error streams are connected to a color-capable terminal.
  • NEVER — never emit terminal color codes. (sad, muted, grayscale energy 😭)
  • ALWAYS — always emit terminal color codes. (rainbow mode, no off switch 🌈)
  • BABELTRACE_TERM_COLOR_BRIGHT_MEANS_BOLD=0 — set to 0 to emit SGR (see <https://en.wikipedia.org/wiki/ANSI_escape_code>) codes 90 to 97 for bright colors instead of bold (SGR code 1) and standard color codes (SGR codes 30 to 37).
  • BABELTRACE_PLUGIN_PATH=PATHS — set the list of directories, in order, in which dynamic plugins can be found before other directories are considered to PATHS (colon-separated, or semicolon on Windows).
  • LIBBABELTRACE2_DISABLE_PYTHON_PLUGINS=1 — disable the loading of any Babeltrace 2 Python plugin.
  • LIBBABELTRACE2_INIT_LOG_LEVEL=LVL — force the initial log level of the Babeltrace 2 library to be LVL.

if this environment variable is set, then it overrides the log level set by the --log-level option for the Babeltrace 2 library logger.

the available values for LVL are:

  • NONE, N — logging is disabled.
  • FATAL, F — severe errors that lead the execution to abort immediately. this level should be enabled in production.
  • ERROR, E — errors that might still allow the execution to continue. usually, once one or more errors are reported at this level, the application, plugin, or library won't perform any more useful task, but it should still exit cleanly. this level should be enabled in production.
  • WARN, WARNING, W — unexpected situations which still allow the execution to continue. this level should be enabled in production.
  • INFO, I — informational messages that highlight progress or important states of the application, plugins, or library. this level can be enabled in production.
  • DEBUG, D — debugging information, with a higher level of details than the TRACE level. this level should NOT be enabled in production.
  • TRACE, T — low-level debugging context information. this level should NOT be enabled in production.
  • LIBBABELTRACE2_NO_DLCLOSE=1 — make the Babeltrace 2 library leave any dynamically loaded modules (plugins and plugin providers) open at exit. this can be useful for debugging purposes.
  • LIBBABELTRACE2_PLUGIN_PROVIDER_DIR=DIR — set the directory from which the Babeltrace 2 library dynamically loads plugin provider shared objects to DIR.

if this environment variable is set, then it overrides the default plugin provider directory.

Babeltrace 2 Python bindings 🐍

  • BABELTRACE_PYTHON_BT2_LOG_LEVEL=LVL — force the Babeltrace 2 Python bindings log level to be LVL.

if this environment variable is set, then it overrides the log level set by the --log-level option for the Python bindings logger.

the available values for LVL are:

  • NONE, N — logging is disabled.
  • FATAL, F — severe errors that lead the execution to abort immediately. this level should be enabled in production.
  • ERROR, E — errors that might still allow the execution to continue. usually, once one or more errors are reported at this level, the application, plugin, or library won't perform any more useful task, but it should still exit cleanly. this level should be enabled in production.
  • WARN, WARNING, W — unexpected situations which still allow the execution to continue. this level should be enabled in production.
  • INFO, I — informational messages that highlight progress or important states of the application, plugins, or library. this level can be enabled in production.
  • DEBUG, D — debugging information, with a higher level of details than the TRACE level. this level should NOT be enabled in production.
  • TRACE, T — low-level debugging context information. this level should NOT be enabled in production.

CLI 💻

  • BABELTRACE_CLI_LOG_LEVEL=LVL — force the log level of the log level babeltrace2 CLI to be LVL.

if this environment variable is set, then it overrides the log level set by the --log-level option for the CLI logger.

the available values for LVL are:

  • NONE, N — logging is disabled.
  • FATAL, F — severe errors that lead the execution to abort immediately. this level should be enabled in production.
  • ERROR, E — errors that might still allow the execution to continue. usually, once one or more errors are reported at this level, the application, plugin, or library won't perform any more useful task, but it should still exit cleanly. this level should be enabled in production.
  • WARN, WARNING, W — unexpected situations which still allow the execution to continue. this level should be enabled in production.
  • INFO, I — informational messages that highlight progress or important states of the application, plugins, or library. this level can be enabled in production.
  • DEBUG, D — debugging information, with a higher level of details than the TRACE level. this level should NOT be enabled in production.
  • TRACE, T — low-level debugging context information. this level should NOT be enabled in production.
  • BABELTRACE_CLI_WARN_COMMAND_NAME_DIRECTORY_CLASH=0 — disable the warning message which babeltrace2-convert(1) prints when you convert a trace with a relative path that's also the name of a babeltrace2 command.
  • BABELTRACE_DEBUG=1 — legacy variable: equivalent to setting the --log-level option to TRACE.
  • BABELTRACE_VERBOSE=1 — legacy variable: equivalent to setting the --log-level option to INFO.

🌸 FILES 🌸

  • $HOME/.local/lib/babeltrace2/plugins — user plugin directory.
  • /usr/local/lib/babeltrace2/plugins — system plugin directory.
  • /usr/local/lib/babeltrace2/plugin-providers — system plugin provider directory.

⭐ EXIT STATUS ⭐

0 on success, 1 otherwise. that's it, that's the whole vibe check.

💀 BUGS 💀

if you encounter any issue or usability problem, please report it on the Babeltrace bug tracker (see <https://bugs.lttng.org/projects/babeltrace>). bestie we want your bug reports, no gatekeeping 🙈

🔥 RESOURCES 🔥

the Babeltrace project shares some communication channels with the LTTng project (see <https://lttng.org/>).

👑 AUTHORS 👑

the Babeltrace 2 project is the result of hard work by many regular developers and occasional contributors. (iconic behavior tbh 💅)

the current project maintainer is Jérémie Galarneau <mailto:jeremie.galarneau@efficios.com>.

this command is part of the Babeltrace 2 project.

Babeltrace is distributed under the MIT license (see <https://opensource.org/licenses/MIT>).

🫶 SEE ALSO 🫶

babeltrace2-intro(7), babeltrace2(1), babeltrace2-list-plugins(1)

and that's the whole page bestie!! this was Babeltrace 2.1.2, dated 14 September 2019, and it's the BABELTRACE2-HELP(1) page — go get your help, you got this ✨💖🎀

📦 where this page comes from