lttng-set-session(1)

1LTTNG-SET-SESSION(1)             LTTng Manual             LTTNG-SET-SESSION(1)
2
3
4

NAME

6       lttng-set-session - Set the current LTTng recording session
7

SYNOPSIS

9       lttng [GENERAL OPTIONS] set-session SESSION
10

DESCRIPTION

12       The lttng set-session command sets the current recording session of
13       your Unix user to the recording session named SESSION.
14
15       See lttng-concepts(7) to learn more about the current recording
16       session.
17
18       The set-session command effectively updates the $LTTNG_HOME/.lttngrc
19       file.
20
21       List the recording sessions of your Unix user, or of all users if your
22       Unix user is root, within the connected session daemon with the lttng-
23       list(1) command.
24

OPTIONS

26       See lttng(1) for GENERAL OPTIONS.
27
28   Program information
29       -h, --help
30           Show help.
31
32           This option attempts to launch /usr/bin/man to view this manual
33           page. Override the manual pager path with the LTTNG_MAN_BIN_PATH
34           environment variable.
35
36       --list-options
37           List available command options and quit.
38

EXIT STATUS

40       0
41           Success
42
43       1
44           Command error
45
46       2
47           Undefined command
48
49       3
50           Fatal error
51
52       4
53           Command warning (something went wrong during the command)
54

ENVIRONMENT

56       LTTNG_ABORT_ON_ERROR
57           Set to 1 to abort the process after the first error is encountered.
58
59       LTTNG_HOME
60           Path to the LTTng home directory.
61
62           Defaults to $HOME.
63
64           Useful when the Unix user running the commands has a non-writable
65           home directory.
66
67       LTTNG_MAN_BIN_PATH
68           Absolute path to the manual pager to use to read the LTTng
69           command-line help (with lttng-help(1) or with the --help option)
70           instead of /usr/bin/man.
71
72       LTTNG_SESSION_CONFIG_XSD_PATH
73           Path to the directory containing the session.xsd recording session
74           configuration XML schema.
75
76       LTTNG_SESSIOND_PATH
77           Absolute path to the LTTng session daemon binary (see lttng-
78           sessiond(8)) to spawn from the lttng-create(1) command.
79
80           The --sessiond-path general option overrides this environment
81           variable.
82

FILES

84       $LTTNG_HOME/.lttngrc
85           Unix user’s LTTng runtime configuration.
86
87           This is where LTTng stores the name of the Unix user’s current
88           recording session between executions of lttng(1).  lttng-create(1)
89           and lttng-set-session(1) set the current recording session.
90
91       $LTTNG_HOME/lttng-traces
92           Default output directory of LTTng traces in local and snapshot
93           modes.
94
95           Override this path with the --output option of the lttng-create(1)
96           command.
97
98       $LTTNG_HOME/.lttng
99           Unix user’s LTTng runtime and configuration directory.
100
101       $LTTNG_HOME/.lttng/sessions
102           Default directory containing the Unix user’s saved recording
103           session configurations (see lttng-save(1) and lttng-load(1)).
104
105       /usr/local/etc/lttng/sessions
106           Directory containing the system-wide saved recording session
107           configurations (see lttng-save(1) and lttng-load(1)).
108
109       Note
110           $LTTNG_HOME defaults to the value of the HOME environment variable.
111

RESOURCES

113       •   LTTng project website <https://lttng.org>
114
115       •   LTTng documentation <https://lttng.org/docs>
116
117       •   LTTng bug tracker <https://bugs.lttng.org>
118
119       •   Git repositories <https://git.lttng.org>
120
121       •   GitHub organization <https://github.com/lttng>
122
123       •   Continuous integration <https://ci.lttng.org/>
124
125       •   Mailing list <https://lists.lttng.org/> for support and
126           development: lttng-dev@lists.lttng.org
127
128       •   IRC channel <irc://irc.oftc.net/lttng>: #lttng on irc.oftc.net
129

COPYRIGHT

131       This program is part of the LTTng-tools project.
132
133       LTTng-tools is distributed under the GNU General Public License
134       version 2 <http://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html>.
135       See the LICENSE <https://github.com/lttng/lttng-
136       tools/blob/master/LICENSE> file for details.
137

THANKS

139       Special thanks to Michel Dagenais and the DORSAL laboratory
140       <http://www.dorsal.polymtl.ca/> at École Polytechnique de Montréal for
141       the LTTng journey.
142
143       Also thanks to the Ericsson teams working on tracing which helped us
144       greatly with detailed bug reports and unusual test cases.
145