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 babeltrace2(1) trace viewer is launched. If it is not
22       found on the system, the babeltrace(1) trace viewer is used. Another
23       trace viewer command can be specified using the --viewer option.
24
25       By default, the trace path of the chosen tracing session is given as
26       the first positional argument to the trace viewer. This path can be
27       overridden using the --trace-path option.
28

OPTIONS

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

ENVIRONMENT VARIABLES

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

FILES

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

EXIT STATUS

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

BUGS

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

RESOURCES

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

COPYRIGHTS

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

THANKS

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