lttng-create(1): use attributes for default ports
[lttng-tools.git] / doc / man / lttng-create.1.txt
CommitLineData
ba50d967
PP
1lttng-create(1)
2===============
3
4
5NAME
6----
7lttng-create - Create an LTTng tracing session
8
9
10SYNOPSIS
11--------
f87c4756 12Local mode:
ba50d967
PP
13
14[verse]
f87c4756
PP
15*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *create* [option:--shm-path='PATH']
16 [option:--no-output | option:--output='PATH' | option:--set-url=file://'PATH'] ['SESSION']
17
18Network streaming mode:
19
20[verse]
21*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *create* [option:--shm-path='PATH']
22 (option:--set-url='URL' | option:--ctrl-url='URL' option:--data-url='URL') ['SESSION']
ba50d967
PP
23
24Snapshot mode:
25
26[verse]
f87c4756
PP
27*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *create* option:--snapshot [option:--shm-path='PATH']
28 [option:--set-url='URL' | option:--ctrl-url='URL' option:--data-url='URL'] ['SESSION']
ba50d967
PP
29
30Live mode:
31
32[verse]
f87c4756
PP
33*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *create* option:--live[='DELAYUS'] [option:--shm-path='PATH']
34 [option:--set-url='URL' | option:--ctrl-url='URL' option:--data-url='URL'] ['SESSION']
ba50d967
PP
35
36
37DESCRIPTION
38-----------
39The `lttng create` command creates a new tracing session.
40
41A tracing session is a named container of channels, which in turn
42contain event rules. It is domain-agnostic, in that channels and event
43rules can be enabled for the user space tracer and/or the Linux
44kernel tracer.
45
46On execution, an `.lttngrc` file is created, if it does not exist, in the
47user's home directory. This file contains the name of the current tracing
48session. When creating a new tracing session with `lttng create`, the
49current tracing session is set to this new tracing session. The
7c1a4458 50man:lttng-set-session(1) command can be used to set the current
ba50d967
PP
51tracing session without manually editing the `.lttngrc` file.
52
53If 'SESSION' is omitted, a session name is automatically created having
54this form: `auto-YYYYmmdd-HHMMSS`. 'SESSION' *must not* contain the
55character `/`.
56
57The option:--shm-path option can be used to specify the path to the
58shared memory holding the ring buffers. Specifying a location on an
59NVRAM file system makes it possible to retrieve the latest recorded
60trace data when the system reboots after a crash. To view the events
61of ring buffer files after a system crash, use the
7c1a4458 62man:lttng-crash(1) utility.
ba50d967 63
7c1a4458 64Tracing sessions are destroyed using the man:lttng-destroy(1)
ba50d967
PP
65command.
66
67
68Creation modes
69~~~~~~~~~~~~~~
f87c4756 70There are four tracing session modes:
ba50d967 71
948f0a2e 72[[local-mode]]Local mode::
ba50d967
PP
73 Traces the local system and writes the trace to the local
74 file system. The option:--output option specifies the trace path.
f87c4756
PP
75 Using option:--set-url=file://'PATH' is the equivalent of using
76 option:--output='PATH'. The file system output can be disabled using
77 the option:--no-output option.
78+
79If none of the options mentioned above are used, then the trace is
80written locally in the `$LTTNG_HOME/lttng-traces` directory
81(`$LTTNG_HOME` defaults to `$HOME`).
82
948f0a2e 83[[network-streaming-mode]]Network streaming mode::
f87c4756
PP
84 Traces the local system and sends the trace over the network to
85 a listening relay daemon (see man:lttng-relayd(8)).
86 The option:--set-url, or option:--ctrl-url and option:--data-url
87 options set the trace output destination (see the
88 <<url-format,URL format>> section below).
ba50d967 89
948f0a2e 90[[snapshot-mode]]Snapshot mode::
ba50d967
PP
91 Traces the local system without writing the trace to the local file
92 system (implicit option:--no-output option). Channels are automatically
93 configured to be snapshot-ready on creation (see
7c1a4458 94 man:lttng-enable-channel(1)). The man:lttng-snapshot(1)
ba50d967
PP
95 command is used to take snapshots of the current ring buffers.
96 The option:--set-url, or option:--ctrl-url and option:--data-url
97 options set the default snapshot output destination.
98
948f0a2e 99[[live-mode]]Live mode::
ba50d967 100 Traces the local system, sending trace data to an LTTng relay daemon
7c1a4458 101 over the network (see man:lttng-relayd(8)). The
ba50d967
PP
102 option:--set-url, or option:--ctrl-url and option:--data-url options
103 set the trace output destination. The live output URLs cannot use
f87c4756
PP
104 the `file://` protocol (see the <<url-format,URL format>>
105 section below).
ba50d967
PP
106
107
108[[url-format]]
109URL format
110~~~~~~~~~~
f87c4756
PP
111The option:--set-url, option:--ctrl-url, and option:--data-url options'
112arguments are URLs.
ba50d967
PP
113
114The format of those URLs is one of:
115
116[verse]
117file://'TRACEPATH'
118'NETPROTO'://('HOST' | 'IPADDR')[:__CTRLPORT__[:__DATAPORT__]][/'TRACEPATH']
119
f87c4756 120The `file://` protocol targets the *local file system* and can only
948f0a2e
PP
121be used as the option:--set-url option's argument when the session is
122created in <<local-mode,local>> or <<snapshot-mode,snapshot>> mode.
ba50d967
PP
123
124'TRACEPATH'::
125 Absolute path to trace files on the local file system.
126
948f0a2e
PP
127The other version is available when the session is created in
128<<network-streaming-mode,network streaming>>,
129<<snapshot-mode,snapshot>>, or <<live-mode,live>> mode.
ba50d967
PP
130
131'NETPROTO'::
132 Network protocol, amongst:
133+
36574617
PP
134--
135`net`::
1f5cd9d5 136 TCP over IPv4; the default values of 'CTRLPORT' and 'DATAPORT'
84f7f408
PP
137 are respectively {default_network_control_port} and
138 {default_network_data_port}.
36574617
PP
139
140`net6`::
141 TCP over IPv6: same default ports as the `net` protocol.
142
143`tcp`::
144 Same as the `net` protocol; can only be used with the
145 option:--ctrl-url and option:--data-url options together.
146
147`tcp6`::
148 Same as the `net6` protocol; can only be used with the
149 option:--ctrl-url and option:--data-url options together.
150--
ba50d967
PP
151
152('HOST' | 'IPADDR')::
153 Hostname or IP address (IPv6 address *must* be enclosed in brackets
154 (`[` and `]`); see https://www.ietf.org/rfc/rfc2732.txt[RFC 2732]).
155
156'CTRLPORT'::
157 Control port.
158
159'DATAPORT'::
160 Data port.
161
162'TRACEPATH'::
163 Path of trace files on the remote file system. This path is relative
164 to the base output directory set on the relay daemon side;
7c1a4458 165 see man:lttng-relayd(8).
ba50d967
PP
166
167
168include::common-cmd-options-head.txt[]
169
170
f87c4756
PP
171Mode selection
172~~~~~~~~~~~~~~
ba50d967 173option:--live[='DELAYUS']::
948f0a2e
PP
174 Create the session in <<live-mode,live mode>>.
175+
176The optional 'DELAYUS' parameter, given in microseconds, is the
177maximum time the user can wait for the data to be flushed. This mode
178can be set with a network URL (options option:--set-url, or
179option:--ctrl-url and option:--data-url) and must have a relay
180daemon listening (see man:lttng-relayd(8)).
ba50d967 181+
c93eadad
PP
182By default, 'DELAYUS' is {default_lttng_live_timer} and the network URL
183is set to `net://127.0.0.1`.
ba50d967
PP
184
185option:--snapshot::
948f0a2e
PP
186 Create the session in <<snapshot-mode,snapshot mode>>.
187 This is the equivalent of using the option:--no-output option and
188 creating all the channels of this new tracing session in overwrite
189 mode with an `mmap` output type.
ba50d967
PP
190
191
192Output
193~~~~~~
194option:--no-output::
948f0a2e 195 In <<local-mode,local mode>>, do not output any trace data.
ba50d967
PP
196
197option:-o, option:--output='PATH'::
948f0a2e 198 In <<local-mode,local mode>>, set trace output path to 'PATH'.
ba50d967
PP
199
200option:--shm-path='PATH'::
201 Create shared memory holding buffers at 'PATH'.
202
203
204URL
205~~~
206See the <<url-format,URL format>> section above for more information
207about the syntax of the following options' 'URL' argument.
208
209option:-C, option:--ctrl-url='URL'::
210 Set control path URL to 'URL' (must use option:--data-url option
211 also).
212
213option:-D, option:--data-url='URL'::
214 Set data path URL to 'URL' (must use option:--ctrl-url option
215 also).
216
217option:-U, option:--set-url='URL'::
218 Set URL destination of the trace data to 'URL'. It is persistent for
219 the session lifetime. This option sets both data
220 (option:--data-url option) and control (option:--ctrl-url option)
221 URLs at the same time.
948f0a2e
PP
222+
223In <<local-mode,local>> mode, 'URL' must start with `file://` followed
224by the destination path on the local file system.
ba50d967
PP
225
226
227include::common-cmd-help-options.txt[]
228
229
230include::common-cmd-footer.txt[]
231
232
233SEE ALSO
234--------
7c1a4458
PP
235man:lttng-destroy(1),
236man:lttng-set-session(1),
237man:lttng(1)
This page took 0.048231 seconds and 4 git commands to generate.