lttng-disable-channel(1)

1LTTNG-DISABLE-CHAN(1)            LTTng Manual            LTTNG-DISABLE-CHAN(1)
2
3
4

NAME

6       lttng-disable-channel - Disable LTTng channels
7

SYNOPSIS

9       lttng [GENERAL OPTIONS] disable-channel (--kernel | --userspace)
10             [--session=SESSION] CHANNEL[,CHANNEL]...
11

DESCRIPTION

13       The lttng disable-channel command disables one or more channels
14       previously enabled with the lttng-enable-channel(1) command which
15       belong to:
16
17       With the --session=SESSION option
18           The recording session named SESSION.
19
20       Without the --session option
21           The current recording session (see lttng-concepts(7) to learn more
22           about the current recording session).
23
24       See lttng-concepts(7) to learn more about channels.
25
26       The disable-channel command disables one channel per CHANNEL argument.
27
28       As of LTTng 2.13.9, you may NOT enable a disabled channel once its
29       recording session has been started (see lttng-start(1)) at least once.
30
31       See the “EXAMPLES” section below for usage examples.
32

OPTIONS

34       See lttng(1) for GENERAL OPTIONS.
35
36   Tracing domain
37       One of:
38
39       -k, --kernel
40           Disable one or more Linux kernel channels.
41
42       -u, --userspace
43           Disable one or more user space channels.
44
45   Recording target
46       -s SESSION, --session=SESSION
47           Disable one or more channels of the recording session named SESSION
48           instead of the current recording session.
49
50   Program information
51       -h, --help
52           Show help.
53
54           This option attempts to launch /usr/bin/man to view this manual
55           page. Override the manual pager path with the LTTNG_MAN_BIN_PATH
56           environment variable.
57
58       --list-options
59           List available command options and quit.
60

EXIT STATUS

62       0
63           Success
64
65       1
66           Command error
67
68       2
69           Undefined command
70
71       3
72           Fatal error
73
74       4
75           Command warning (something went wrong during the command)
76

ENVIRONMENT

78       LTTNG_ABORT_ON_ERROR
79           Set to 1 to abort the process after the first error is encountered.
80
81       LTTNG_HOME
82           Path to the LTTng home directory.
83
84           Defaults to $HOME.
85
86           Useful when the Unix user running the commands has a non-writable
87           home directory.
88
89       LTTNG_MAN_BIN_PATH
90           Absolute path to the manual pager to use to read the LTTng
91           command-line help (with lttng-help(1) or with the --help option)
92           instead of /usr/bin/man.
93
94       LTTNG_SESSION_CONFIG_XSD_PATH
95           Path to the directory containing the session.xsd recording session
96           configuration XML schema.
97
98       LTTNG_SESSIOND_PATH
99           Absolute path to the LTTng session daemon binary (see lttng-
100           sessiond(8)) to spawn from the lttng-create(1) command.
101
102           The --sessiond-path general option overrides this environment
103           variable.
104

FILES

106       $LTTNG_HOME/.lttngrc
107           Unix user’s LTTng runtime configuration.
108
109           This is where LTTng stores the name of the Unix user’s current
110           recording session between executions of lttng(1).  lttng-create(1)
111           and lttng-set-session(1) set the current recording session.
112
113       $LTTNG_HOME/lttng-traces
114           Default output directory of LTTng traces in local and snapshot
115           modes.
116
117           Override this path with the --output option of the lttng-create(1)
118           command.
119
120       $LTTNG_HOME/.lttng
121           Unix user’s LTTng runtime and configuration directory.
122
123       $LTTNG_HOME/.lttng/sessions
124           Default directory containing the Unix user’s saved recording
125           session configurations (see lttng-save(1) and lttng-load(1)).
126
127       /usr/local/etc/lttng/sessions
128           Directory containing the system-wide saved recording session
129           configurations (see lttng-save(1) and lttng-load(1)).
130
131       Note
132           $LTTNG_HOME defaults to the value of the HOME environment variable.
133

EXAMPLES

135       Example 1. Disable one Linux kernel channel of the current recording
136       session.
137
138               $ lttng disable-channel --kernel my-channel
139
140       Example 2. Disable two user space channels of a specific recording
141       session.
142
143           See the --session option.
144
145               $ lttng disable-channel --kernel --session=my-session \
146                                       little,box
147

RESOURCES

149       •   LTTng project website <https://lttng.org>
150
151       •   LTTng documentation <https://lttng.org/docs>
152
153       •   LTTng bug tracker <https://bugs.lttng.org>
154
155       •   Git repositories <https://git.lttng.org>
156
157       •   GitHub organization <https://github.com/lttng>
158
159       •   Continuous integration <https://ci.lttng.org/>
160
161       •   Mailing list <https://lists.lttng.org/> for support and
162           development: lttng-dev@lists.lttng.org
163
164       •   IRC channel <irc://irc.oftc.net/lttng>: #lttng on irc.oftc.net
165

COPYRIGHT

167       This program is part of the LTTng-tools project.
168
169       LTTng-tools is distributed under the GNU General Public License
170       version 2 <http://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html>.
171       See the LICENSE <https://github.com/lttng/lttng-
172       tools/blob/master/LICENSE> file for details.
173

THANKS

175       Special thanks to Michel Dagenais and the DORSAL laboratory
176       <http://www.dorsal.polymtl.ca/> at École Polytechnique de Montréal for
177       the LTTng journey.
178
179       Also thanks to the Ericsson teams working on tracing which helped us
180       greatly with detailed bug reports and unusual test cases.
181