babeltrace(1) - Linux manual page

NAME | SYNOPSIS | DESCRIPTION | OPTIONS | COMMANDS | PLUGINS | ENVIRONMENT VARIABLES | FILES | EXIT STATUS | BUGS | RESOURCES | AUTHORS | COPYRIGHT | SEE ALSO | COLOPHON

BABELTRACE(1)                 Babeltrace manual                BABELTRACE(1)

NAME         top

       babeltrace - Convert or process one or more traces, and more

SYNOPSIS         top

       babeltrace [--debug | --verbose | --log-level=LVL] [CMD] [CMD ARGS]

DESCRIPTION         top

       babeltrace is an open-source trace converter and processor. The tool
       can convert from one trace format to another, possibly with one or
       more filters in the conversion path, and perform other operations
       depending on the command CMD.

       See babeltrace-intro(7) to learn more about the Babeltrace project
       and its core concepts.

       Most of the babeltrace commands load Babeltrace plugins to perform
       their operation. The search path for Babeltrace plugins is, in this
       order:

        1. The colon-separated list of directories in the
           BABELTRACE_PLUGIN_PATH environment variable.

        2. The colon-separated list of directories in the specific command’s
           --plugin-path option.

        3. $HOME/.local/lib/babeltrace/plugins

        4. /usr/local/lib/babeltrace/plugins

       You can use the babeltrace-list-plugins(1) command to dynamically
       list the available plugins and what they offer. See PLUGINS for a
       list of plugins shipped with Babeltrace.

OPTIONS         top

       -d, --debug
           Turn the debugging mode on.

           This is equivalent to --log-level=VERBOSE.

       --log-level=LVL
           Set the log level of all known Babeltrace loggers to LVL. You can
           override the level of a specific logger with a dedicated log
           level environment variable. If you don’t specify this option, it
           is equivalent to --log-level=WARNING.

           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
               Potentially harmful 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, plugin, or library. This level can
               be enabled in production.

           DEBUG, D
               Debugging information, with a higher level of details than
               the VERBOSE level. This level should NOT be enabled in
               production.

           VERBOSE, V
               Low-level debugging context information. This level should
               NOT be enabled in production.

       -v, --verbose
           Turn the verbose mode on.

           This is equivalent to --log-level=INFO.

       -h, --help
           Show help and quit.

       -V, --version
           Show version and quit.

COMMANDS         top

       The following commands also have their own --help option.

       babeltrace-convert(1)
           Build a trace conversion graph and run it.

           This is the default command: you don’t need to explicitly specify
           this command name to use it.

       babeltrace-help(1)
           Get help for a specific plugin or plugin’s component class.

       babeltrace-list-plugins(1)
           List the available Babeltrace plugins and their component
           classes.

       babeltrace-query(1)
           Query an object from a component class.

       babeltrace-run(1)
           Build a trace processing graph and run it.

PLUGINS         top

       The following plugins are provided by the Babeltrace project itself:

       babeltrace-plugin-ctf(7)
           CTF trace input (from the file system and from the LTTng-live
           protocol) and output to the file system.

           ·   babeltrace-sink.ctf.fs(7)

           ·   babeltrace-source.ctf.fs(7)

           ·   babeltrace-source.ctf.lttng-live(7)

       babeltrace-plugin-lttng-utils(7)
           Processing graph utilities for LTTng traces.

           ·   babeltrace-filter.lttng-utils.debug-info(7)

       babeltrace-plugin-text(7)
           Text input and output.

           ·   babeltrace-sink.text.pretty(7)

           ·   babeltrace-source.text.dmesg(7)

       babeltrace-plugin-utils(7)
           Processing graph utilities.

           ·   babeltrace-filter.utils.muxer(7)

           ·   babeltrace-filter.utils.trimmer(7)

           ·   babeltrace-sink.utils.counter(7)

           ·   babeltrace-sink.utils.dummy(7)

ENVIRONMENT VARIABLES         top

   Babeltrace library
       BABELTRACE_COMMON_LOG_LEVEL
           Common functions’s log level. The available values are the same
           as for the --log-level option of babeltrace(1).

       BABELTRACE_COMPAT_LOG_LEVEL
           Compatibility functions’s log level. The available values are the
           same as for the --log-level option of babeltrace(1).

       BABELTRACE_TERM_COLOR
           Force the terminal color support. 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.

           ALWAYS
               Always emit terminal color codes.

       BABELTRACE_DISABLE_PYTHON_PLUGINS
           Set to 1 to disable the loading of any Babeltrace Python plugin.

       BABELTRACE_LOGGING_GLOBAL_LEVEL
           Babeltrace library’s global log level. The available values are
           the same as for the --log-level option of babeltrace(1)

       BABELTRACE_NO_DLCLOSE
           Set to 1 to make the Babeltrace library leave any dynamically
           loaded modules (plugins and Python plugin provider) open at exit.
           This can be useful for debugging purposes.

       BABELTRACE_PLUGIN_PATH
           Colon-separated list of directories, in order, in which dynamic
           plugins can be found before other directories are considered.

   Python plugin provider
       BABELTRACE_PYTHON_PLUGIN_PROVIDER_LOG_LEVEL
           Python plugin provider’s log level. The available values are the
           same as for the --log-level option of babeltrace(1).

   CLI
       BABELTRACE_CLI_LOG_LEVEL
           babeltrace CLI’s log level. The available values are the same as
           for the --log-level option.

       BABELTRACE_CLI_WARN_COMMAND_NAME_DIRECTORY_CLASH
           Set to 0 to disable the warning message which babeltrace prints
           when you convert a trace with a relative path that’s also the
           name of a babeltrace command.

FILES         top

       $HOME/.local/lib/babeltrace/plugins
           User plugin directory.

       /usr/local/lib/babeltrace/plugins
           System plugin directory.

EXIT STATUS         top

       0 on success, 1 otherwise.

BUGS         top

       If you encounter any issue or usability problem, please report it on
       the Babeltrace bug tracker (see
       <https://bugs.linuxfoundation.org/buglist.cgi?product=Diamon&component=Babeltrace>).

RESOURCES         top

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

       ·   Babeltrace website (see <http://diamon.org/babeltrace>)

       ·   Git repository (see
           <http://git.linuxfoundation.org/?p=diamon/babeltrace.git>)

       ·   EfficiOS GitHub organization (see <http://github.com/efficios/>)

       ·   Continuous integration (see
           <https://ci.lttng.org/job/babeltrace_master_build/>)

       ·   Mailing list (see <http://lists.lttng.org>) for support and
           development: lttng-dev@lists.lttng.org

       ·   IRC channel (see <irc://irc.oftc.net/lttng>): #lttng on
           irc.oftc.net

AUTHORS         top

       The Babeltrace project is the result of efforts by many regular
       developers and occasional contributors.

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

COPYRIGHT         top

       This program is part of the Babeltrace project.

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

SEE ALSO         top

       babeltrace-convert(1), babeltrace-help(1),
       babeltrace-list-plugins(1), babeltrace-query(1), babeltrace-run(1),
       babeltrace-intro(7)

COLOPHON         top

       This page is part of the babeltrace (trace read and write libraries
       and a trace converter) project.  Information about the project can be
       found at ⟨http://www.efficios.com/babeltrace⟩.  If you have a bug
       report for this manual page, send it to lttng-dev@lists.lttng.org.
       This page was obtained from the project's upstream Git repository
       ⟨git://git.efficios.com/babeltrace.git⟩ on 2018-02-02.  (At that
       time, the date of the most recent commit that was found in the repos‐
       itory was 2018-01-30.)  If you discover any rendering problems in
       this HTML version of the page, or you believe there is a better or
       more up-to-date source for the page, or you have corrections or
       improvements to the information in this COLOPHON (which is not part
       of the original manual page), send a mail to man-pages@man7.org

Babeltrace 2.0.0-pre4          5 October 2017                  BABELTRACE(1)

Pages that refer to this page: babeltrace(1)babeltrace-convert(1)babeltrace-help(1)babeltrace-list-plugins(1)babeltrace-log(1)babeltrace-query(1)babeltrace-run(1)lttng(1)lttng-calibrate(1)lttng-crash(1)lttng-view(1)lttng-ust(3)babeltrace-filter.lttng-utils.debug-info(7)babeltrace-filter.utils.muxer(7)babeltrace-filter.utils.trimmer(7)babeltrace-intro(7)babeltrace-plugin-utils(7)babeltrace-sink.ctf.fs(7)babeltrace-sink.text.pretty(7)babeltrace-sink.utils.counter(7)babeltrace-sink.utils.dummy(7)babeltrace-source.ctf.fs(7)babeltrace-source.ctf.lttng-live(7)babeltrace-source.text.dmesg(7)lttng-relayd(8)lttng-sessiond(8)