SYNOPSIS
--------
-Normal mode:
+Local mode:
[verse]
-*lttng* ['GENERAL OPTIONS'] *create* [option:--output='PATH' | option:--no-output]
- [option:--shm-path='PATH'] ['SESSION']
+*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *create* [option:--shm-path='PATH']
+ [option:--no-output | option:--output='PATH' | option:--set-url=file://'PATH'] ['SESSION']
+
+Network streaming mode:
+
+[verse]
+*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *create* [option:--shm-path='PATH']
+ (option:--set-url='URL' | option:--ctrl-url='URL' option:--data-url='URL') ['SESSION']
Snapshot mode:
[verse]
-*lttng* ['GENERAL OPTIONS'] *create* option:--snapshot
- [option:--set-url='URL' | option:--ctrl-url='URL' option:--data-url='URL']
- [option:--shm-path='PATH'] ['SESSION']
+*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *create* option:--snapshot [option:--shm-path='PATH']
+ [option:--set-url='URL' | option:--ctrl-url='URL' option:--data-url='URL'] ['SESSION']
Live mode:
[verse]
-*lttng* ['GENERAL OPTIONS'] *create* option:--live[='DELAYUS']
- [option:--set-url='URL' | option:--ctrl-url='URL' option:--data-url='URL']
- [option:--shm-path='PATH'] ['SESSION']
+*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *create* option:--live[='DELAYUS'] [option:--shm-path='PATH']
+ [option:--set-url='URL' | option:--ctrl-url='URL' option:--data-url='URL'] ['SESSION']
DESCRIPTION
user's home directory. This file contains the name of the current tracing
session. When creating a new tracing session with `lttng create`, the
current tracing session is set to this new tracing session. The
-linklttng:lttng-set-session(1) command can be used to set the current
+man:lttng-set-session(1) command can be used to set the current
tracing session without manually editing the `.lttngrc` file.
If 'SESSION' is omitted, a session name is automatically created having
NVRAM file system makes it possible to retrieve the latest recorded
trace data when the system reboots after a crash. To view the events
of ring buffer files after a system crash, use the
-linklttng:lttng-crash(1) utility.
+man:lttng-crash(1) utility.
-Tracing sessions are destroyed using the linklttng:lttng-destroy(1)
+Tracing sessions are destroyed using the man:lttng-destroy(1)
command.
Creation modes
~~~~~~~~~~~~~~
-There are three tracing session modes:
+There are four tracing session modes:
-Normal mode::
+Local mode::
Traces the local system and writes the trace to the local
file system. The option:--output option specifies the trace path.
- If omitted, the trace is written in the `$LTTNG_HOME/lttng-traces`
- directory (`$LTTNG_HOME` defaults to `$HOME`). The file system
- output can be disabled using the option:--no-output option.
+ Using option:--set-url=file://'PATH' is the equivalent of using
+ option:--output='PATH'. The file system output can be disabled using
+ the option:--no-output option.
++
+If none of the options mentioned above are used, then the trace is
+written locally in the `$LTTNG_HOME/lttng-traces` directory
+(`$LTTNG_HOME` defaults to `$HOME`).
+
+Network streaming mode::
+ Traces the local system and sends the trace over the network to
+ a listening relay daemon (see man:lttng-relayd(8)).
+ The option:--set-url, or option:--ctrl-url and option:--data-url
+ options set the trace output destination (see the
+ <<url-format,URL format>> section below).
Snapshot mode::
Traces the local system without writing the trace to the local file
system (implicit option:--no-output option). Channels are automatically
configured to be snapshot-ready on creation (see
- linklttng:lttng-enable-channel(1)). The linklttng:lttng-snapshot(1)
+ man:lttng-enable-channel(1)). The man:lttng-snapshot(1)
command is used to take snapshots of the current ring buffers.
The option:--set-url, or option:--ctrl-url and option:--data-url
options set the default snapshot output destination.
Live mode::
Traces the local system, sending trace data to an LTTng relay daemon
- over the network (see linklttng:lttng-relayd(8)). The
+ over the network (see man:lttng-relayd(8)). The
option:--set-url, or option:--ctrl-url and option:--data-url options
set the trace output destination. The live output URLs cannot use
- the `file://` protocol (see URL format below).
+ the `file://` protocol (see the <<url-format,URL format>>
+ section below).
[[url-format]]
URL format
~~~~~~~~~~
-The option:--set-url, option:--ctrl-url, and option:--data-url options
-specify URLs.
+The option:--set-url, option:--ctrl-url, and option:--data-url options'
+arguments are URLs.
The format of those URLs is one of:
file://'TRACEPATH'
'NETPROTO'://('HOST' | 'IPADDR')[:__CTRLPORT__[:__DATAPORT__]][/'TRACEPATH']
-The `file://` protocol targets the *local file system*.
+The `file://` protocol targets the *local file system* and can only
+be used as the option:--set-url option's argument in _local mode_.
'TRACEPATH'::
Absolute path to trace files on the local file system.
-The other version is used for *network streaming*.
+The other version is used for the _network streaming mode_.
'NETPROTO'::
Network protocol, amongst:
'TRACEPATH'::
Path of trace files on the remote file system. This path is relative
to the base output directory set on the relay daemon side;
- see linklttng:lttng-relayd(8).
+ see man:lttng-relayd(8).
include::common-cmd-options-head.txt[]
-Mode
-~~~~
+Mode selection
+~~~~~~~~~~~~~~
option:--live[='DELAYUS']::
Create the session in live mode. The optional 'DELAYUS' parameter,
given in microseconds, is the maximum time the user can wait for
the data to be flushed. This mode can be set with a network URL
(options option:--set-url, or option:--ctrl-url and option:--data-url)
- and must have a relay daemon listening (see linklttng:lttng-relayd(8)).
+ and must have a relay daemon listening (see man:lttng-relayd(8)).
+
-By default, 'DELAYUS' is 1000000 and the network URL is set to
-`net://127.0.0.1`.
+By default, 'DELAYUS' is {default_lttng_live_timer} and the network URL
+is set to `net://127.0.0.1`.
option:--snapshot::
Create the session in snapshot mode. This is the equivalent of using
SEE ALSO
--------
-linklttng:lttng-destroy(1),
-linklttng:lttng-set-session(1),
-linklttng:lttng(1)
+man:lttng-destroy(1),
+man:lttng-set-session(1),
+man:lttng(1)
projects / lttng-tools.git / blobdiff