--------
[verse]
*lttng* [option:--group='GROUP'] [option:--mi='TYPE'] [option:--no-sessiond | option:--sessiond-path='PATH']
- [option:--quiet | option:-v | option:-vv | option:-vvv] 'COMMAND' ['COMMAND OPTIONS']
+ [option:--quiet | option:-v | option:-vv | option:-vvv] '<<commands,COMMAND>>' ['COMMAND OPTIONS']
DESCRIPTION
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
domains. For some commands, the domain needs to be specified with a
command-line option. The domain options are:
-option:-j, option:--jul::
+nloption:-j, nloption:--jul::
Apply command to the `java.util.logging` (JUL) domain.
-option:-k, option:--kernel::
+nloption:-k, nloption:--kernel::
Apply command to the Linux kernel domain.
-option:-l, option:--log4j::
- Apply command to the Apache log4j 1.2 (Java) domain.
+nloption:-l, nloption:--log4j::
+ Apply command to the https://logging.apache.org/log4j/1.2/[Apache log4j 1.2]
+ (Java) domain.
-option:-p, option:--python::
- Apply command to the Python domain.
+nloption:-p, nloption:--python::
+ Apply command to the https://www.python.org/[Python] domain.
-option:-u, option:--userspace::
- Apply command to the user space domain.
+nloption:-u, nloption:--userspace::
+ Apply command to the user space domain (application using
+ 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.
Show version.
+[[commands]]
COMMANDS
--------
-The following commands also have their own option:--help option.
+The following commands also have their own nloption:--help option.
Tracing sessions
~~~~~~~~~~~~~~~~
-linklttng:lttng-create(1)::
- Create a tracing session.
+man:lttng-create(1)::
+ {cmd_descr_create}.
-linklttng:lttng-destroy(1)::
- Tear down tracing sessions.
+man:lttng-destroy(1)::
+ {cmd_descr_destroy}.
-linklttng:lttng-metadata(1)::
- Manage an LTTng tracing session's metadata generation.
+man:lttng-load(1)::
+ {cmd_descr_load}.
-linklttng:lttng-save(1)::
- Save tracing session configurations.
+man:lttng-regenerate(1)::
+ {cmd_descr_regenerate}.
-linklttng:lttng-set-session(1)::
- Set current tracing session.
+man:lttng-save(1)::
+ {cmd_descr_save}.
-linklttng:lttng-load(1)::
- Load tracing session configurations.
+man:lttng-set-session(1)::
+ {cmd_descr_set_session}.
Channels
~~~~~~~~
-linklttng:lttng-enable-channel(1)::
- Create or enable tracing channels.
+man:lttng-add-context(1)::
+ {cmd_descr_add_context}.
-linklttng:lttng-disable-channel(1)::
- Disable tracing channels.
+man:lttng-disable-channel(1)::
+ {cmd_descr_disable_channel}.
-linklttng:lttng-add-context(1)::
- Add context fields to a channel.
+man:lttng-enable-channel(1)::
+ {cmd_descr_enable_channel}.
Event rules
~~~~~~~~~~~
-linklttng:lttng-enable-event(1)::
- Create or enable event rules.
+man:lttng-disable-event(1)::
+ {cmd_descr_disable_event}.
-linklttng:lttng-disable-event(1)::
- Disable event rules.
+man:lttng-enable-event(1)::
+ {cmd_descr_enable_event}.
Status
~~~~~~
-linklttng:lttng-list(1)::
- List tracing sessions, domains, channels, and events.
+man:lttng-list(1)::
+ {cmd_descr_list}.
-linklttng:lttng-status(1)::
- Get the status of the current tracing session.
+man:lttng-status(1)::
+ {cmd_descr_status}.
Control
~~~~~~~
-linklttng:lttng-snapshot(1)::
- Snapshot buffers of current tracing session.
+man:lttng-snapshot(1)::
+ {cmd_descr_snapshot}.
-linklttng:lttng-start(1)::
- Start tracing.
+man:lttng-start(1)::
+ {cmd_descr_start}.
-linklttng:lttng-stop(1)::
- Stop tracing.
+man:lttng-stop(1)::
+ {cmd_descr_stop}.
Resource tracking
~~~~~~~~~~~~~~~~~
-linklttng:lttng-track(1)::
- Track specific system resources.
+man:lttng-track(1)::
+ {cmd_descr_track}.
-linklttng:lttng-untrack(1)::
- Untrack specific system resources.
+man:lttng-untrack(1)::
+ {cmd_descr_untrack}.
Miscellaneous
~~~~~~~~~~~~~
-linklttng:lttng-calibrate(1)::
- Quantify LTTng overhead.
+man:lttng-help(1)::
+ {cmd_descr_help}.
-linklttng:lttng-help(1)::
- Display help information about a command.
+man:lttng-version(1)::
+ {cmd_descr_version}.
-linklttng:lttng-version(1)::
- Show version information.
-
-linklttng:lttng-view(1)::
- Start trace viewer.
+man:lttng-view(1)::
+ {cmd_descr_view}.
include::common-cmd-footer.txt[]
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 / blobdiff