$
lttng list
lttng-list — List LTTng recording sessions and instrumentation points
List the recording sessions:
lttng [GENERAL OPTIONS] list
List the tracing domains of a recording session with at least one channel:
lttng [GENERAL OPTIONS] list--domain
SESSION
List the channels and recording event rules of a recording session:
lttng [GENERAL OPTIONS] list [--channel
=CHANNEL
]SESSION
[--kernel
] [--userspace
] [--jul
] [--log4j
] [--log4j2
] [--python
]
List the available LTTng tracepoints, Linux system calls, and/or Java/Python loggers:
lttng [GENERAL OPTIONS] list [--fields
] [--kernel
[--syscall
]] [--userspace
] [--jul
] [--log4j
] [--log4j2
] [--python
]
The lttng list
command lists:
The recording sessions of your Unix user, or of all users
if your Unix user is root
, within the connected session daemon.
See the “Session daemon connection” section of lttng(1) to learn how a user application connects to a session daemon.
The command shows recording session properties such as their output directories/URLs and whether or not they’re active.
SESSION
argument
--domain
option
The tracing domains (with at least one channel) of the recording
session named SESSION
.
--domain
option
--channel
=CHANNEL
option
The recording event rules of the channel CHANNEL
of the
recording session named SESSION
.
--channel
option
The channels of the recording session named SESSION
and
their recording event rules.
Use the dedicated tracing domain options (--kernel
,
--userspace
, --jul
, --log4j
, --log4j2
, and
--python
) to only show specific channels.
SESSION
argument and with at least one dedicated tracing domain option
--kernel
option
--userspace
option
The available LTTng user space tracepoints.
--jul
, --log4j
, --log4j2
, and/or --python
options
The available java.util.logging
, Apache Log4j 1.x, Apache Log4j 2 and/or Python
logger names.
Also list the available instrumentation point fields with the
--fields
option.
See lttng-concepts(7) to learn more about recording sessions, tracing domains, channels, recording event rules, and instrumentation points.
See the “EXAMPLES” section below for usage examples.
List the channels and recording event rules of the current recording session (see lttng-concepts(7) to learn more) with the lttng-status(1) command.
See lttng(1) for GENERAL OPTIONS.
-j
, --jul
SESSION
argument
List the java.util.logging
logger names.
SESSION
argument
Only list the java.util.logging
channels and their recording
event rules.
-k
, --kernel
SESSION
argument
List the LTTng kernel instrumentation points.
SESSION
argument
Only list the Linux kernel channels and their recording event rules.
-l
, --log4j
SESSION
argument
List the Apache Log4j 1.x logger names.
SESSION
argument
Only list the Apache Log4j 1.x channels and their recording event rules.
--log4j2
SESSION
argument
List the Apache Log4j 2 logger names.
SESSION
argument
Only list the Apache Log4j 2 channels and their recording event rules.
-p
, --python
SESSION
argument
List the Python logger names.
SESSION
argument
Only list the Python channels and their recording event rules.
-u
, --userspace
SESSION
argument
List the LTTng user space tracepoints.
SESSION
argument
Only list the user space channels and their recording event rules.
-c
CHANNEL
, --channel
=CHANNEL
Only list the properties and recording event rules of the channel
named CHANNEL
.
Only available with the SESSION
argument.
-d
, --domain
Show the tracing domains with at least one channel of the recording
session named SESSION
.
-f
, --fields
When listing instrumentation points, also show their fields if they’re available.
--syscall
When listing LTTng kernel instrumentation points, only list Linux system calls.
-h
, --help
Show help.
This option attempts to launch /usr/bin/man
to view this manual page.
Override the manual pager path with the LTTNG_MAN_BIN_PATH
environment
variable.
--list-options
List available command options and quit.
Success
Command error
Undefined command
Fatal error
Command warning (something went wrong during the command)
LTTNG_ABORT_ON_ERROR
Set to 1
to abort the process after the first error is
encountered.
LTTNG_HOME
Path to the LTTng home directory.
Defaults to $HOME
.
Useful when the Unix user running the commands has a non-writable home directory.
LTTNG_MAN_BIN_PATH
Absolute path to the manual pager to use to read the LTTng
command-line help (with lttng-help(1) or with the
--help
option) instead of /usr/bin/man
.
LTTNG_SESSION_CONFIG_XSD_PATH
Path to the directory containing the session.xsd
recording session
configuration XML schema.
LTTNG_SESSIOND_PATH
Absolute path to the LTTng session daemon binary (see lttng-sessiond(8)) to spawn from the lttng-create(1) command.
The --sessiond-path
general option overrides this environment
variable.
$LTTNG_HOME/.lttngrc
Unix user’s LTTng runtime configuration.
This is where LTTng stores the name of the Unix user’s current recording session between executions of lttng(1). lttng-create(1) and lttng-set-session(1) set the current recording session.
$LTTNG_HOME/lttng-traces
Default output directory of LTTng traces in local and snapshot modes.
Override this path with the --output
option of the
lttng-create(1) command.
$LTTNG_HOME/.lttng
Unix user’s LTTng runtime and configuration directory.
$LTTNG_HOME/.lttng/sessions
Default directory containing the Unix user’s saved recording session configurations (see lttng-save(1) and lttng-load(1)).
/etc/lttng/sessions
Directory containing the system-wide saved recording session configurations (see lttng-save(1) and lttng-load(1)).
Note:$LTTNG_HOME
defaults to the value of the HOME
environment
variable.
Example:List the recording sessions.
$
lttng list
Example:Show the details of a specific recording session.
$
lttng list my-session
Example:List the available Linux kernel system call instrumentation points.
$
lttng list --kernel --syscall
Example:List the available user space tracepoints with their fields.
See the --fields
option.
$
lttng list --userspace --fields
Example:List the tracing domains of a specific recording session having at least one channel.
See the --domain
option.
$
lttng list --domain my-session
Example:Show the details of a specific channel in a specific recording session.
See the --channel
option.
$
lttng list my-session --channel=channel0
Mailing list for support and
development: lttng-dev@lists.lttng.org
IRC channel: #lttng
on irc.oftc.net
This program is part of the LTTng-tools project.
LTTng-tools is distributed under the
GNU General
Public License version 2. See the
LICENSE
file
for details.
Special thanks to Michel Dagenais and the DORSAL laboratory at École Polytechnique de Montréal for the LTTng journey.
Also thanks to the Ericsson teams working on tracing which helped us greatly with detailed bug reports and unusual test cases.