lttng-view(1)

1LTTNG-VIEW(1)                    LTTng Manual                    LTTNG-VIEW(1)
2
3
4

NAME

6       lttng-view - View the traces of an LTTng tracing session
7

SYNOPSIS

9       lttng [GENERAL OPTIONS] view [--viewer=CMD] [--trace-path=PATH | SESSION]
10

DESCRIPTION

12       The lttng view command launches an external trace viewer to view the
13       current trace of a tracing session.
14
15       If SESSION is omitted, the viewer is launched for the current tracing
16       session (see lttng-create(1) for more information about the current
17       tracing session). Otherwise, it is launched for the existing tracing
18       session named SESSION. lttng list outputs all the existing tracing
19       sessions (see lttng-list(1)).
20
21       By default, the babeltrace(1) trace viewer is launched. Another trace
22       viewer command can be specified using the --viewer option.
23
24       By default, the trace path of the chosen tracing session is given as
25       the first positional argument to the trace viewer. This path can be
26       overridden using the --trace-path option.
27

OPTIONS

29       General options are described in lttng(1).
30
31       -t PATH, --trace-path=PATH
32           View trace at path PATH instead of using the chosen tracing
33           session’s trace path.
34
35       -e CMD, --viewer=CMD
36           Use CMD as the trace viewer.
37
38   Program information
39       -h, --help
40           Show command help.
41
42           This option, like lttng-help(1), attempts to launch /usr/bin/man to
43           view the command’s man page. The path to the man pager can be
44           overridden by the LTTNG_MAN_BIN_PATH environment variable.
45
46       --list-options
47           List available command options.
48

ENVIRONMENT VARIABLES

50       LTTNG_ABORT_ON_ERROR
51           Set to 1 to abort the process after the first error is encountered.
52
53       LTTNG_HOME
54           Overrides the $HOME environment variable. Useful when the user
55           running the commands has a non-writable home directory.
56
57       LTTNG_MAN_BIN_PATH
58           Absolute path to the man pager to use for viewing help information
59           about LTTng commands (using lttng-help(1) or lttng COMMAND --help).
60
61       LTTNG_SESSION_CONFIG_XSD_PATH
62           Path in which the session.xsd session configuration XML schema may
63           be found.
64
65       LTTNG_SESSIOND_PATH
66           Full session daemon binary path.
67
68           The --sessiond-path option has precedence over this environment
69           variable.
70
71       Note that the lttng-create(1) command can spawn an LTTng session daemon
72       automatically if none is running. See lttng-sessiond(8) for the
73       environment variables influencing the execution of the session daemon.
74

FILES

76       $LTTNG_HOME/.lttngrc
77           User LTTng runtime configuration.
78
79           This is where the per-user current tracing session is stored
80           between executions of lttng(1). The current tracing session can be
81           set with lttng-set-session(1). See lttng-create(1) for more
82           information about tracing sessions.
83
84       $LTTNG_HOME/lttng-traces
85           Default output directory of LTTng traces. This can be overridden
86           with the --output option of the lttng-create(1) command.
87
88       $LTTNG_HOME/.lttng
89           User LTTng runtime and configuration directory.
90
91       $LTTNG_HOME/.lttng/sessions
92           Default location of saved user tracing sessions (see lttng-save(1)
93           and lttng-load(1)).
94
95       /usr/local/etc/lttng/sessions
96           System-wide location of saved tracing sessions (see lttng-save(1)
97           and lttng-load(1)).
98
99           Note
100           $LTTNG_HOME defaults to $HOME when not explicitly set.
101

EXIT STATUS

103       0
104           Success
105
106       1
107           Command error
108
109       2
110           Undefined command
111
112       3
113           Fatal error
114
115       4
116           Command warning (something went wrong during the command)
117

BUGS

119       If you encounter any issue or usability problem, please report it on
120       the LTTng bug tracker <https://bugs.lttng.org/projects/lttng-tools>.
121

RESOURCES

123       ·   LTTng project website <https://lttng.org>
124
125       ·   LTTng documentation <https://lttng.org/docs>
126
127       ·   Git repositories <http://git.lttng.org>
128
129       ·   GitHub organization <http://github.com/lttng>
130
131       ·   Continuous integration <http://ci.lttng.org/>
132
133       ·   Mailing list <http://lists.lttng.org> for support and development:
134           lttng-dev@lists.lttng.org
135
136       ·   IRC channel <irc://irc.oftc.net/lttng>: #lttng on irc.oftc.net
137

COPYRIGHTS

139       This program is part of the LTTng-tools project.
140
141       LTTng-tools is distributed under the GNU General Public License version
142       2 <http://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html>. See the
143       LICENSE <https://github.com/lttng/lttng-tools/blob/master/LICENSE> file
144       for details.
145

THANKS

147       Special thanks to Michel Dagenais and the DORSAL laboratory
148       <http://www.dorsal.polymtl.ca/> at École Polytechnique de Montréal for
149       the LTTng journey.
150
151       Also thanks to the Ericsson teams working on tracing which helped us
152       greatly with detailed bug reports and unusual test cases.
153