lttng-list - Man Page

List LTTng recording sessions and instrumentation points

Synopsis

List the recording sessions:

lttng [GENERAL OPTIONS] list

List the tracing domains of a recording session:

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]
      [--style=(compact | breathe)] [--no-truncate]
      [--mem-usage=(total | compact | full)]

List the available LTTng tracepoints, Linux system calls, and/or Java/Python loggers:

lttng [GENERAL OPTIONS] list
      [--kernel [--syscall]] [--userspace [--fields]]
      [--jul] [--log4j] [--log4j2] [--python]

Description

The lttng list command lists:

Without arguments

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.

The name of the current recording session is underlined.

With the SESSION argument

With the --domain option

The tracing domains of the recording session named SESSION.

Without the --domain option

With the --channel=CHANNEL option

The recording event rules of the channel(s) CHANNEL of the recording session named SESSION.

Without the --channel option

The channels of the recording session named SESSION and their recording event rules.

By default, the command shows the total memory usage of each channel. Control the memory usage display mode with the --mem-usage option.

Use the dedicated tracing domain options (--kernel, --userspace, --jul, --log4j, --log4j2, and --python) to only show specific channels.

Without the SESSION argument and with at least one dedicated tracing domain option

With the --kernel option

Without the --syscall option

The available LTTng kernel tracepoints.

With the --syscall option

The available instrumented Linux system calls.

With the --userspace option

The available LTTng user space tracepoints.

Also list the available instrumentation point fields with the --fields option.

With the --jul, --log4j, --log4j2, and/or --python options

The available java.util.logging, Apache log4j 1.x, Apache Log4j 2 and/or Python logger names.

See lttng-concepts(7) to learn more about recording sessions, tracing domains, channels, recording event rules, and instrumentation points.

By default, the command adds empty lines between blocks of related information. Remove those empty lines with the --style=compact option.

This command shows colored text when the terminal supports it. Override the terminal coloring behaviour with the LTTNG_TERM_COLOR and NO_COLOR environment variables.

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.

The lttng list command uses a structured visual language designed to make complex tracing configurations easier to read and scan. It combines terminal colors, Unicode symbols, and indentation to express hierarchy, state, and metadata.

Color semantics:

Color	Meaning
Green	Enabled, active, or valid items.
Red	Disabled, inactive, or invalid items.
Cyan	Important object nodes: recording sessions, tracing domains, channels, and event rules. Those nodes act as section headers.
Yellow	Metadata such as counts and timestamps.
Magenta	Warning information.

Symbolic conventions:

Symbol	Meaning
· and ◼	Active/inactive recording session.
✓ and ×	Enabled/disabled channel or event rule.
🞂	Attribute or attribute group.
┆	Vertical continuation.