1LTTNG-LIST(1) LTTng Manual LTTNG-LIST(1)
2
6 lttng-list - List LTTng tracing sessions, domains, channels, and events
7
9 List existing tracing sessions:
10 lttng [GENERAL OPTIONS] list
12 List available event sources:
14 lttng [GENERAL OPTIONS] list [--fields]
16 [--kernel [--syscall]] [--userspace] [--jul] [--log4j] [--python]
17 List tracing session’s domains:
19 lttng [GENERAL OPTIONS] list --domain SESSION
21 List tracing session’s channels and event rules:
23 lttng [GENERAL OPTIONS] list [--channel=CHANNEL] SESSION
25
27 The lttng list command lists tracing sessions, tracing domains,
28 channels, and events.
29 Without arguments, lttng list lists the existing tracing sessions and
31 shows if they are active or not.
32 With one or more of the --kernel, --userspace, --jul, --log4j, and
34 --python domain options, the command lists the available event sources
35 of the selected domain on the system. The JUL, log4j, and Python
36 domains list the names of their available loggers. The --syscall option
37 can be used alongside the --kernel option to get a list of traceable
38 Linux system calls. The --fields option can be used to show the fields
39 of the listed event sources.
40 Providing a tracing session name SESSION targets a specific tracing
42 session. If the --domain option is used, domains containing at least
43 one channel in the selected tracing session are listed. Otherwise, all
44 the domains, channels, and event rules of the selected tracing session
45 are listed along with its details (trace path, for example), except
46 when the --channel option is used to isolate a specific channel by
47 name.
48
50 General options are described in lttng(1).
51 Domain
53 -j, --jul
54 List event sources in the java.util.logging (JUL) domain.
55 -k, --kernel
57 List event sources in the Linux kernel domain.
58 -l, --log4j
60 List event sources in the Apache log4j domain.
61 -p, --python
63 List event sources in the Python domain.
64 -u, --userspace
66 List event sources in the user space domain.
67 Target
69 -c CHANNEL, --channel=CHANNEL
70 Only list the details of the channel named CHANNEL.
71 Listing
73 -d, --domain
74 Show the domains of the target tracing session in which at least
75 one channel exists.
76 -f, --fields
78 When listing the event sources with one of the domain options, also
79 show their fields.
80 --syscall
82 When listing the event sources of the Linux kernel domain, list the
83 traceable system calls instead of the kernel tracepoints.
84 Program information
86 -h, --help
87 Show command help.
88 This option, like lttng-help(1), attempts to launch /usr/bin/man to
90 view the command’s man page. The path to the man pager can be
91 overridden by the LTTNG_MAN_BIN_PATH environment variable.
92 --list-options
94 List available command options.
95
97 LTTNG_ABORT_ON_ERROR
98 Set to 1 to abort the process after the first error is encountered.
99 LTTNG_HOME
101 Overrides the $HOME environment variable. Useful when the user
102 running the commands has a non-writable home directory.
103 LTTNG_MAN_BIN_PATH
105 Absolute path to the man pager to use for viewing help information
106 about LTTng commands (using lttng-help(1) or lttng COMMAND --help).
107 LTTNG_SESSION_CONFIG_XSD_PATH
109 Path in which the session.xsd session configuration XML schema may
110 be found.
111 LTTNG_SESSIOND_PATH
113 Full session daemon binary path.
114 The --sessiond-path option has precedence over this environment
116 variable.
117 Note that the lttng-create(1) command can spawn an LTTng session daemon
119 automatically if none is running. See lttng-sessiond(8) for the
120 environment variables influencing the execution of the session daemon.
121
123 $LTTNG_HOME/.lttngrc
124 User LTTng runtime configuration.
125 This is where the per-user current tracing session is stored
127 between executions of lttng(1). The current tracing session can be
128 set with lttng-set-session(1). See lttng-create(1) for more
129 information about tracing sessions.
130 $LTTNG_HOME/lttng-traces
132 Default output directory of LTTng traces. This can be overridden
133 with the --output option of the lttng-create(1) command.
134 $LTTNG_HOME/.lttng
136 User LTTng runtime and configuration directory.
137 $LTTNG_HOME/.lttng/sessions
139 Default location of saved user tracing sessions (see lttng-save(1)
140 and lttng-load(1)).
141 /usr/local/etc/lttng/sessions
143 System-wide location of saved tracing sessions (see lttng-save(1)
144 and lttng-load(1)).
145 Note
147 $LTTNG_HOME defaults to $HOME when not explicitly set.
148
150 0
151 Success
152 1
154 Command error
155 2
157 Undefined command
158 3
160 Fatal error
161 4
163 Command warning (something went wrong during the command)
164
166 If you encounter any issue or usability problem, please report it on
167 the LTTng bug tracker <https://bugs.lttng.org/projects/lttng-tools>.
168
170 · LTTng project website <https://lttng.org>
171 · LTTng documentation <https://lttng.org/docs>
173 · Git repositories <http://git.lttng.org>
175 · GitHub organization <http://github.com/lttng>
177 · Continuous integration <http://ci.lttng.org/>
179 · Mailing list <http://lists.lttng.org> for support and development:
181 lttng-dev@lists.lttng.org
182 · IRC channel <irc://irc.oftc.net/lttng>: #lttng on irc.oftc.net
184
186 This program is part of the LTTng-tools project.
187 LTTng-tools is distributed under the GNU General Public License version
189 2 <http://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html>. See the
190 LICENSE <https://github.com/lttng/lttng-tools/blob/master/LICENSE> file
191 for details.
192
194 Special thanks to Michel Dagenais and the DORSAL laboratory
195 <http://www.dorsal.polymtl.ca/> at École Polytechnique de Montréal for
196 the LTTng journey.
197 Also thanks to the Ericsson teams working on tracing which helped us
199 greatly with detailed bug reports and unusual test cases.
200
202 lttng(1)
203LTTng 2.12.2 28 November 2016 LTTNG-LIST(1)