macro definitions used everywhere in the man page sources.
-### linklttng
+### man
-The linklttng macro is used to link to another LTTng man page. Its
-output is different depending on the back-end. In troff, the man page
-name is rendered in bold, whereas the HTML5 output renders a hyperlink.
+The man macro is used to link to another man page. In troff, the man
+page name is rendered in bold.
-Usage example: `linklttng:lttng-enable-channel(1)`.
+Usage example: `man:lttng-enable-channel(1)`.
### linkgenoptions
[macros]
-# linklttng macro
+# man macro
#
# Inspired by linkgit macro:
# <https://github.com/git/git/blob/master/Documentation/asciidoc.conf>
#
-# Usage: linklttng:command(manpage-section)
-(?su)[\\]?(?P<name>
linklttng):(?P<target>\S*?)\((?P<attrlist>.*?)\)=
+# Usage: man:command(manpage-section)
+(?su)[\\]?(?P<name>
man):(?P<target>\S*?)\((?P<attrlist>.*?)\)=
# linkgenoptions macro
#
# Usage: :escwc:
:escwc:=escwc
-# linklttng macro expansions
+# man macro expansions
ifdef::backend-docbook[]
-[linklttng-inlinemacro]
+[man-inlinemacro]
{0%{target}}
{0#<citerefentry>}
{0#<refentrytitle>{target}</refentrytitle><manvolnum>{0}</manvolnum>}
`LTTNG_MAN_BIN_PATH`::
Absolute path to the man pager to use for viewing help information
- about LTTng commands (using linklttng:lttng-help(1) or
+ about LTTng commands (using man:lttng-help(1) or
`lttng COMMAND --help`).
`LTTNG_SESSION_CONFIG_XSD_PATH`::
The genoption:--sessiond-path option has precedence over this
environment variable.
-Note that the linklttng:lttng-create(1) command can spawn an LTTng
+Note that the man:lttng-create(1) command can spawn an LTTng
session daemon automatically if none is running. See
-linklttng:lttng-sessiond(8) for the environment variables influencing
+man:lttng-sessiond(8) for the environment variables influencing
the execution of the session daemon.
User LTTng runtime configuration.
+
This is where the per-user current tracing session is stored between
-executions of linklttng:lttng(1). The current tracing session can be set
-with linklttng:lttng-set-session(1). See linklttng:lttng-create(1) for
+executions of man:lttng(1). The current tracing session can be set
+with man:lttng-set-session(1). See man:lttng-create(1) for
more information about tracing sessions.
`$LTTNG_HOME/lttng-traces`::
Default output directory of LTTng traces. This can be overridden
- with the nloption:--output option of the linklttng:lttng-create(1)
+ with the nloption:--output option of the man:lttng-create(1)
command.
`$LTTNG_HOME/.lttng`::
`$LTTNG_HOME/.lttng/sessions`::
Default location of saved user tracing sessions (see
- linklttng:lttng-save(1) and linklttng:lttng-load(1)).
+ man:lttng-save(1) and man:lttng-load(1)).
`/etc/lttng/sessions`::
System-wide location of saved tracing sessions
- (see linklttng:lttng-save(1) and linklttng:lttng-load(1)).
+ (see man:lttng-save(1) and man:lttng-load(1)).
NOTE: `$LTTNG_HOME` defaults to `$HOME` when not explicitly set.
option:-h, option:--help::
Show command help.
+
-This option, like linklttng:lttng-help(1), attempts to launch
+This option, like man:lttng-help(1), attempts to launch
`/usr/bin/man` to view the command's man page. The path to the man pager
can be overridden by the `LTTNG_MAN_BIN_PATH` environment variable.
OPTIONS
-------
-linkgenoptions:(General options) are described in linklttng:lttng(1).
+linkgenoptions:(General options) are described in man:lttng(1).
The `lttng add-context` command adds one or more context fields to a
channel.
-Channels are created with the linklttng:lttng-enable-channel(1) command.
+Channels are created with the man:lttng-enable-channel(1) command.
When context fields are added to a channel, all the events emitted
within this channel contain the dynamic values of those context fields.
SEE ALSO
--------
-linklttng:lttng(1)
+man:lttng(1)
babeltrace $(ls -1drt ~/lttng-traces/calibrate-function-* | tail -n 1)
------------------------------------------------------------------------
-The output from linklttng:babeltrace(1) can be saved to a text file and
+The output from man:babeltrace(1) can be saved to a text file and
opened in a spreadsheet (for example, in LibreOffice) to focus on the
per-PMU counter delta between consecutive `calibrate_entry` and
`calibrate_return` events. Note that these counters are per-CPU, so
SEE ALSO
--------
-linklttng:lttng(1)
+man:lttng(1)
SEE ALSO
--------
-linklttng:lttng(1),
-linklttng:lttng-sessiond(8),
-linklttng:lttng-relayd(8),
-linklttng:lttng-ust(3),
-linklttng:babeltrace(1)
+man:lttng(1),
+man:lttng-sessiond(8),
+man:lttng-relayd(8),
+man:lttng-ust(3),
+man:babeltrace(1)
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.
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).
'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[]
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`.
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)
The `lttng destroy` command destroys one or more tracing sessions.
If no options are specified, the current tracing session is destroyed
-(see linklttng:lttng-create(1) for more information about the current
+(see man:lttng-create(1) for more information about the current
tracing session).
If 'SESSION' is specified, the existing tracing session named 'SESSION'
is destroyed. `lttng list` outputs all the existing tracing sessions
-(see linklttng:lttng-list(1)).
+(see man:lttng-list(1)).
If the option:--all option is used, *all* the tracing sessions, as listed
in the output of `lttng list`, are destroyed.
SEE ALSO
--------
-linklttng:lttng-create(1),
-linklttng:lttng-set-session(1),
-linklttng:lttng(1)
+man:lttng-create(1),
+man:lttng-set-session(1),
+man:lttng(1)
DESCRIPTION
-----------
The `lttng disable-channel` command disables one or more channels
-previously enabled by the linklttng:lttng-enable-channel(1) command.
+previously enabled by the man:lttng-enable-channel(1) command.
A channel is always contained in a tracing session
-(see linklttng:lttng-create(1) for creating a tracing session). The
+(see man:lttng-create(1) for creating a tracing session). The
session in which a channel is disabled using `lttng disable-channel` can
be specified using the option:--session option. If the option:--session
option is omitted, the current tracing session is targeted.
SEE ALSO
--------
-linklttng:lttng-disable-channel(1),
-linklttng:lttng(1)
+man:lttng-disable-channel(1),
+man:lttng(1)
DESCRIPTION
-----------
The `lttng disable-event` command disables one or more event rules
-previously enabled by the linklttng:lttng-enable-event(1) command.
+previously enabled by the man:lttng-enable-event(1) command.
Event rules are always assigned to a channel when they are created. If
the option:--channel option is omitted, the default channel named
With the option:--kernel option, the event source type can be specified
using one of the option:--tracepoint, option:--probe,
option:--function, or option:--syscall options. See
-linklttng:lttng-enable-event(1) for more details about event source
+man:lttng-enable-event(1) for more details about event source
types.
Events can be disabled while tracing is active
-(use linklttng:lttng-start(1) to make a tracing session active).
+(use man:lttng-start(1) to make a tracing session active).
include::common-cmd-options-head.txt[]
SEE ALSO
--------
-linklttng:lttng-enable-event(1),
-linklttng:lttng(1)
+man:lttng-enable-event(1),
+man:lttng(1)
one or more existing and disabled ones.
A channel is the owner of sub-buffers holding recorded events. Event,
-rules, when created using linklttng:lttng-enable-event(1), are always
+rules, when created using man:lttng-enable-event(1), are always
assigned to a channel. When creating a new channel, many parameters
related to those sub-buffers can be fine-tuned. They are described in
the subsections below.
'CHANNEL' is created. Otherwise, the disabled channel named 'CHANNEL'
is enabled.
-Note that the linklttng:lttng-enable-event(1) command can automatically
+Note that the man:lttng-enable-event(1) command can automatically
create default channels when no channel exist.
A channel is always contained in a tracing session
-(see linklttng:lttng-create(1) for creating a tracing session). The
+(see man:lttng-create(1) for creating a tracing session). The
session in which a channel is created using `lttng enable-channel` can
be specified using the option:--session option. If the option:--session
option is omitted, the current tracing session is targeted.
Existing enabled channels can be disabled using
-linklttng:lttng-disable-channel(1). Channels of a given session can be
-listed using linklttng:lttng-list(1).
+man:lttng-disable-channel(1). Channels of a given session can be
+listed using man:lttng-list(1).
See the <<limitations,LIMITATIONS>> section below for a list of
limitations of this command to consider.
SEE ALSO
--------
-linklttng:lttng-disable-channel(1),
-linklttng:lttng(1)
+man:lttng-disable-channel(1),
+man:lttng(1)
that must be satisfied in order for an actual event to be emitted by
an LTTng tracer when the execution of an application or the Linux kernel
reaches an event source (tracepoint, system call, dynamic probe).
-Event sources can be listed with the linklttng:lttng-list(1) command.
+Event sources can be listed with the man:lttng-list(1) command.
-The linklttng:lttng-disable-event(1) command can be used to disable
+The man:lttng-disable-event(1) command can be used to disable
existing event rules.
Event rules are always assigned to a channel when they are created. If
from the current tracing session.
Events can be enabled while tracing is active
-(use linklttng:lttng-start(1) to make a tracing session active).
+(use man:lttng-start(1) to make a tracing session active).
Event source types
currently exist for the chosen tracing session, domain, and channel,
a new event rule is created. Otherwise, the existing event rule is
enabled if it is currently disabled
-(see linklttng:lttng-disable-event(1)).
+(see man:lttng-disable-event(1)).
The option:--all option can be used alongside the option:--tracepoint
or option:--syscall options. When this option is used, no 'EVENT'
The dynamic value of a statically-known context field is read by
prefixing its name with `$ctx.`. Statically-known context fields are
context fields added to channels without the `$app.` prefix using the
-linklttng:lttng-add-context(1) command.
+man:lttng-add-context(1) command.
The dynamic value of an application-specific context field is read by
prefixing its name with `$app.` (follows the format used to add such a
-context field with the linklttng:lttng-add-context(1) command).
+context field with the man:lttng-add-context(1) command).
When a comparison includes a non existent event field, the whole filter
expression evaluates to false (the event is discarded).
NOTE: Although it is possible to filter the process ID of an event when
the `pid` context has been added to its channel using, for example,
`$ctx.pid == 2832`, it is recommended to use the PID tracker instead,
-which is much more efficient (see linklttng:lttng-track(1)).
+which is much more efficient (see man:lttng-track(1)).
Examples:
SEE ALSO
--------
-linklttng:lttng-disable-event(1),
-linklttng:lttng(1)
+man:lttng-disable-event(1),
+man:lttng(1)
where `COMMAND` is the name of the command about which to get help. If
'COMMAND' is omitted, `lttng help` shows general help about the
-linklttng:lttng(1) command.
+man:lttng(1) command.
The `lttng help` command attempts to launch `/usr/bin/man` to view
the command's man page. The path to the man pager can be overridden
SEE ALSO
--------
-linklttng:lttng(1)
+man:lttng(1)
SEE ALSO
--------
-linklttng:lttng(1)
+man:lttng(1)
tracing sessions from files.
The `lttng load` command is used in conjunction with the
-linklttng:lttng-save(1) command to save and restore the complete
+man:lttng-save(1) command to save and restore the complete
configurations of tracing sessions. This includes the enabled channels
and event rules, the context added to channels, the tracing activity,
and more.
SEE ALSO
--------
-linklttng:lttng-save(1),
-linklttng:lttng(1)
+man:lttng-save(1),
+man:lttng(1)
user space tracing sessions (using per-user buffering), in non-live
mode.
-See linklttng:lttng-enable-channel(1) for more information about
-buffering schemes and linklttng:lttng-create(1) for more information
+See man:lttng-enable-channel(1) for more information about
+buffering schemes and man:lttng-create(1) for more information
about the different tracing session modes.
SEE ALSO
--------
-linklttng:lttng(1)
+man:lttng(1)
SEE ALSO
--------
-linklttng:lttng(1),
-linklttng:lttng-sessiond(8),
-linklttng:lttng-crash(1),
-linklttng:lttng-ust(3),
-linklttng:babeltrace(1)
+man:lttng(1),
+man:lttng-sessiond(8),
+man:lttng-crash(1),
+man:lttng-ust(3),
+man:babeltrace(1)
tracing sessions to files.
The `lttng save` command is used in conjunction with the
-linklttng:lttng-load(1) command to save and restore the complete
+man:lttng-load(1) command to save and restore the complete
configurations of tracing sessions. This includes the enabled channels
and event rules, the context added to channels, the tracing activity,
and more. `lttng save` does not save tracing data, only the tracing
If 'SESSION' is omitted, all the existing tracing session configurations
are saved (equivalent to using the option:--all option). Otherwise,
'SESSION' is the name of an existing tracing session. `lttng list`
-outputs all the existing tracing sessions (see linklttng:lttng-list(1)).
+outputs all the existing tracing sessions (see man:lttng-list(1)).
The default output directory path is `$LTTNG_HOME/.lttng/sessions`
(`$LTTNG_HOME` defaults to `$HOME`). Each tracing session configuration
SEE ALSO
--------
-linklttng:lttng-load(1),
-linklttng:lttng(1)
+man:lttng-load(1),
+man:lttng(1)
to interact with multiple tracers (kernel and user space) within the
same container, a _tracing session_. Traces can be gathered from the
Linux kernel and/or from instrumented applications (see
-linklttng:lttng-ust(3)). You can aggregate and read the events of LTTng
-traces using linklttng:babeltrace(1).
+man:lttng-ust(3)). You can aggregate and read the events of LTTng
+traces using man:babeltrace(1).
To trace the Linux kernel, the session daemon needs to be running as
`root`. LTTng uses a _tracing group_ to allow specific users to interact
option:-S, option:--sig-parent::
Send `SIGUSR1` to parent process to notify readiness.
+
-NOTE: This is used by linklttng:lttng(1) to get notified when the
+NOTE: This is used by man:lttng(1) to get notified when the
session daemon is ready to accept commands. When building a third party
tool on liblttng-ctl, this option can be very handy to synchronize the
control tool and the session daemon.
`$LTTNG_HOME/lttng-traces`::
Default output directory of LTTng traces. This can be overridden
- with the nloption:--output option of the linklttng:lttng-create(1)
+ with the nloption:--output option of the man:lttng-create(1)
command.
`$LTTNG_HOME/.lttng/sessions`::
Default location of saved user tracing sessions (see
- linklttng:lttng-save(1) and linklttng:lttng-load(1)).
+ man:lttng-save(1) and man:lttng-load(1)).
`/etc/lttng/sessions`::
System-wide location of saved tracing sessions
- (see linklttng:lttng-save(1) and linklttng:lttng-load(1)).
+ (see man:lttng-save(1) and man:lttng-load(1)).
`$LTTNG_HOME/.lttng/lttng.conf`::
Default location of the session daemon configuration file (see the
SEE ALSO
--------
-linklttng:lttng(1),
-linklttng:lttng-relayd(8),
-linklttng:lttng-crash(1),
-linklttng:lttng-ust(3),
-linklttng:babeltrace(1)
+man:lttng(1),
+man:lttng-relayd(8),
+man:lttng-crash(1),
+man:lttng-ust(3),
+man:babeltrace(1)
The `lttng set-session` command sets the current tracing session.
'SESSION' is the name of an existing tracing session. `lttng list`
-outputs all the existing tracing sessions (see linklttng:lttng-list(1)).
+outputs all the existing tracing sessions (see man:lttng-list(1)).
The current tracing session is used by default when a session can be
-specified in other commands. See linklttng:lttng-create(1) for more
+specified in other commands. See man:lttng-create(1) for more
information about the current tracing session.
SEE ALSO
--------
-linklttng:lttng-create(1),
-linklttng:lttng-destroy(1),
-linklttng:lttng(1)
+man:lttng-create(1),
+man:lttng-destroy(1),
+man:lttng(1)
The tracing session should be created in _snapshot mode_ to make sure
taking snapshots is allowed. This is done at tracing session creation
-time using the linklttng:lttng-create(1) command.
+time using the man:lttng-create(1) command.
Note that, when a snapshot is taken, the sub-buffers are not cleared.
This means that different recorded snapshots may contain the same
A snapshot output can be added using the `add-output` action. The
output destination URL is set using either the 'URL' positional
argument, or both the option:--ctrl-url and option:--data-url options.
-See linklttng:lttng-create(1) to learn more about the URL format.
+See man:lttng-create(1) to learn more about the URL format.
A name can be assigned to an output when adding it using the
option:--name option. This name is part of the names of the
NOTE: Before taking a snapshot on a system with a high event throughput,
it is recommended to first run `lttng stop` (see
-linklttng:lttng-stop(1)). Otherwise, the snapshot could contain "holes",
+man:lttng-stop(1)). Otherwise, the snapshot could contain "holes",
the result of the tracers overwriting unconsumed trace packets during
the record operation. After the snapshot is recorded, the tracers can be
-started again with `lttng start` (see linklttng:lttng-start(1)).
+started again with `lttng start` (see man:lttng-start(1)).
include::common-cmd-options-head.txt[]
SEE ALSO
--------
-linklttng:lttng(1)
+man:lttng(1)
events. Whether they are recorded to the local file system, sent over
the network, or not recorded at all depends on the specific
configuration of the tracing session in which tracing is started. See
-linklttng:lttng-create(1) for different session modes.
+man:lttng-create(1) for different session modes.
A tracing session with running tracers is said to be _active_. Active
tracing sessions can return to the inactive state using the
-linklttng:lttng-stop(1) command.
+man:lttng-stop(1) command.
If 'SESSION' is omitted, the LTTng tracers are started for the current
-tracing session (see linklttng:lttng-create(1) for more information
+tracing session (see man:lttng-create(1) for more information
about the current tracing session). Otherwise, they are started for the
existing tracing session named 'SESSION'. `lttng list`
-outputs all the existing tracing sessions (see linklttng:lttng-list(1)).
+outputs all the existing tracing sessions (see man:lttng-list(1)).
include::common-cmd-options-head.txt[]
SEE ALSO
--------
-linklttng:lttng-stop(1),
-linklttng:lttng(1)
+man:lttng-stop(1),
+man:lttng(1)
---------------------
where `CURSESSION` is the name of the current tracing session.
-Use linklttng:lttng-set-session(1) to set the current tracing session.
+Use man:lttng-set-session(1) to set the current tracing session.
include::common-cmd-options-head.txt[]
SEE ALSO
--------
-linklttng:lttng-set-session(1),
-linklttng:lttng(1)
+man:lttng-set-session(1),
+man:lttng(1)
A tracing session with no running tracers is said to be _inactive_.
Inactive tracing sessions can be set active using the
-linklttng:lttng-start(1) command.
+man:lttng-start(1) command.
If 'SESSION' is omitted, the LTTng tracers are stopped for the current
-tracing session (see linklttng:lttng-create(1) for more information
+tracing session (see man:lttng-create(1) for more information
about the current tracing session). Otherwise, they are stopped for the
existing tracing session named 'SESSION'. `lttng list`
-outputs all the existing tracing sessions (see linklttng:lttng-list(1)).
+outputs all the existing tracing sessions (see man:lttng-list(1)).
By default, the `lttng stop` command ensures that the tracing session's
trace data is valid before returning to the prompt. With the
SEE ALSO
--------
-linklttng:lttng-start(1),
-linklttng:lttng(1)
+man:lttng-start(1),
+man:lttng(1)
A resource tracker is a _whitelist_ of resources. Tracked resources are
allowed to emit events, provided those events are targeted by enabled
-event rules (see linklttng:lttng-enable-event(1)).
+event rules (see man:lttng-enable-event(1)).
Tracker entries can be removed from the whitelist with
-linklttng:lttng-untrack(1).
+man:lttng-untrack(1).
As of this version, the only available tracker is the *PID tracker*. The
process ID (PID) tracker follows one or more process IDs; only the
Should a process with a given ID exit and another process be given this
ID, then the latter would also be allowed to emit events.
-See the linklttng:lttng-untrack(1) for more details about removing
+See the man:lttng-untrack(1) for more details about removing
entries.
SEE ALSO
--------
-linklttng:lttng-untrack(1),
-linklttng:lttng(1)
+man:lttng-untrack(1),
+man:lttng(1)
The `lttng untrack` commands removes one or more entries from a
resource tracker.
-See linklttng:lttng-track(1) to learn more about LTTng trackers.
+See man:lttng-track(1) to learn more about LTTng trackers.
The untrack command removes specific resources from a tracker. The
resources to remove must have been precedently added by
-linklttng:lttng-track(1). It is also possible to remove all the
+man:lttng-track(1). It is also possible to remove all the
resources from the whitelist using the option:--all option.
As of this version, the only available tracker is the PID tracker.
Example
~~~~~~~
One common operation is to create a tracing session
-(see linklttng:lttng-create(1)), remove all the entries from the PID
+(see man:lttng-create(1)), remove all the entries from the PID
tracker whitelist, start tracing, and then manually track PIDs
while tracing is active.
SEE ALSO
--------
-linklttng:lttng-track(1),
-linklttng:lttng(1)
+man:lttng-track(1),
+man:lttng(1)
SEE ALSO
--------
-linklttng:lttng(1)
+man:lttng(1)
current trace of a tracing session.
If 'SESSION' is omitted, the viewer is launched for the current tracing
-session (see linklttng:lttng-create(1) for more information
+session (see man:lttng-create(1) for more information
about the current tracing session). Otherwise, it is launched for the
existing tracing session named 'SESSION'. `lttng list`
-outputs all the existing tracing sessions (see linklttng:lttng-list(1)).
+outputs all the existing tracing sessions (see man:lttng-list(1)).
-By default, the linklttng:babeltrace(1) trace viewer is launched.
+By default, the man:babeltrace(1) trace viewer is launched.
Another trace viewer command can be specified using the
option:--viewer option.
SEE ALSO
--------
-linklttng:lttng(1)
+man:lttng(1)
LTTng consists of Linux kernel modules (for Linux kernel tracing) and
dynamically loaded libraries (for user application and library tracing).
-An LTTng _session daemon_, linklttng:lttng-sessiond(8), receives
+An LTTng _session daemon_, man:lttng-sessiond(8), receives
commands from the command-line interface `lttng` to control the LTTng
tracers. All interactions with the LTTng tracers happen through the
`lttng` tool or through the liblttng-ctl library shipped with the
nloption:-u, nloption:--userspace::
Apply command to the user space domain (application using
- liblttng-ust directly; see linklttng:lttng-ust(3)).
+ liblttng-ust directly; see man:lttng-ust(3)).
The LTTng session daemon is a tracing registry which allows the user to
interact with multiple tracers (kernel and user space) within the same
container, a _tracing session_. Traces can be gathered from the Linux
kernel and/or from instrumented applications (see
-linklttng:lttng-ust(3)). You can aggregate and read the events of LTTng
-traces using linklttng:babeltrace(1).
+man:lttng-ust(3)). You can aggregate and read the events of LTTng
+traces using man:babeltrace(1).
To trace the Linux kernel, the session daemon needs to be running as
`root`. LTTng uses a _tracing group_ to allow specific users to interact
User applications instrumented with LTTng automatically register to the
root session daemon and to user session daemons. This allows any session
daemon to list the available traceable applications and event sources
-(see linklttng:lttng-list(1)).
+(see man:lttng-list(1)).
-By default, the linklttng:lttng-create(1) command automatically spawns a
+By default, the man:lttng-create(1) command automatically spawns a
user session daemon if none is currently running. The
option:--no-sessiond general option can be set to avoid this.
Tracing sessions
~~~~~~~~~~~~~~~~
-linklttng:lttng-create(1)::
+man:lttng-create(1)::
Create a tracing session.
-linklttng:lttng-destroy(1)::
+man:lttng-destroy(1)::
Tear down tracing sessions.
-linklttng:lttng-load(1)::
+man:lttng-load(1)::
Load tracing session configurations.
-linklttng:lttng-metadata(1)::
+man:lttng-metadata(1)::
Manage an LTTng tracing session's metadata generation.
-linklttng:lttng-save(1)::
+man:lttng-save(1)::
Save tracing session configurations.
-linklttng:lttng-set-session(1)::
+man:lttng-set-session(1)::
Set current tracing session.
Channels
~~~~~~~~
-linklttng:lttng-add-context(1)::
+man:lttng-add-context(1)::
Add context fields to a channel.
-linklttng:lttng-disable-channel(1)::
+man:lttng-disable-channel(1)::
Disable tracing channels.
-linklttng:lttng-enable-channel(1)::
+man:lttng-enable-channel(1)::
Create or enable tracing channels.
Event rules
~~~~~~~~~~~
-linklttng:lttng-disable-event(1)::
+man:lttng-disable-event(1)::
Disable event rules.
-linklttng:lttng-enable-event(1)::
+man:lttng-enable-event(1)::
Create or enable event rules.
Status
~~~~~~
-linklttng:lttng-list(1)::
+man:lttng-list(1)::
List tracing sessions, domains, channels, and events.
-linklttng:lttng-status(1)::
+man:lttng-status(1)::
Get the status of the current tracing session.
Control
~~~~~~~
-linklttng:lttng-snapshot(1)::
+man:lttng-snapshot(1)::
Snapshot buffers of current tracing session.
-linklttng:lttng-start(1)::
+man:lttng-start(1)::
Start tracing.
-linklttng:lttng-stop(1)::
+man:lttng-stop(1)::
Stop tracing.
Resource tracking
~~~~~~~~~~~~~~~~~
-linklttng:lttng-track(1)::
+man:lttng-track(1)::
Track specific system resources.
-linklttng:lttng-untrack(1)::
+man:lttng-untrack(1)::
Untrack specific system resources.
Miscellaneous
~~~~~~~~~~~~~
-linklttng:lttng-calibrate(1)::
+man:lttng-calibrate(1)::
Quantify LTTng overhead.
-linklttng:lttng-help(1)::
+man:lttng-help(1)::
Display help information about a command.
-linklttng:lttng-version(1)::
+man:lttng-version(1)::
Show version information.
-linklttng:lttng-view(1)::
+man:lttng-view(1)::
Start trace viewer.
SEE ALSO
--------
-linklttng:lttng-sessiond(8),
-linklttng:lttng-relayd(8),
-linklttng:lttng-crash(1),
-linklttng:lttng-ust(3),
-linklttng:babeltrace(1)
+man:lttng-sessiond(8),
+man:lttng-relayd(8),
+man:lttng-crash(1),
+man:lttng-ust(3),
+man:babeltrace(1)
projects / lttng-tools.git / commitdiff
