lttng-disable-channel - Disable LTTng channels

Copyright

       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.

Description

       The lttngdisable-channel command disables one or more channels previously enabled with the lttng-enable-channel(1) command which belong to:

       With the --session=SESSION option
           The recording session named SESSION.

       Without the --session option
           The current recording session (see lttng-concepts(7) to learn more about the current recording
           session).

       See lttng-concepts(7) to learn more about channels.

       The disable-channel command disables one channel per CHANNEL argument.

       As of LTTng 2.13.14, you may NOT enable a disabled channel once its recording session has been started
       (see lttng-start(1)) at least once.

       See the “EXAMPLES” section below for usage examples.

Environment

LTTNG_ABORT_ON_ERROR
           Set to 1 to abort the process after the first error is encountered.

       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.

       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_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.

Examples

Example1.DisableoneLinuxkernelchannelofthecurrentrecordingsession.

               $ lttng disable-channel --kernel my-channel

       Example2.Disabletwouserspacechannelsofaspecificrecordingsession.

           See the --session option.

               $ lttng disable-channel --kernel --session=my-session \
                                       little,box

Exit Status

0
           Success

       1
           Command error

       2
           Undefined command

       3
           Fatal error

       4
           Command warning (something went wrong during the command)

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.

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

Name

       lttng-disable-channel - Disable LTTng channels

Options

       See lttng(1) for GENERALOPTIONS.

   Tracingdomain
       One of:

       -k, --kernel
           Disable one or more Linux kernel channels.

       -u, --userspace
           Disable one or more user space channels.

   Recordingtarget-sSESSION, --session=SESSION
           Disable one or more channels of the recording session named SESSION instead of the current recording
           session.

   Programinformation-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.

       --list-options
           List available command options and quit.

Resources

       •   LTTng project website <https://lttng.org>

       •   LTTng documentation <https://lttng.org/docs>

       •   LTTng bug tracker <https://bugs.lttng.org>

       •   Git repositories <https://git.lttng.org>

       •   GitHub organization <https://github.com/lttng>

       •   Continuous integration <https://ci.lttng.org/>

       •   Mailing list <https://lists.lttng.org/> for support and development: lttng-dev@lists.lttng.org

       •   IRC channel <irc://irc.oftc.net/lttng>: #lttng on irc.oftc.net

Synopsis

lttng [GENERALOPTIONS] disable-channel (--kernel | --userspace)
             [--session=SESSION] CHANNEL[,CHANNEL]...

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.