--- name: "lttng-list" section: "1" platform: "linux" package: "lttng-tools" version: "2.13.15-2" release: "Debian 13 (Trixie)" platforms: ["linux"] url: "https://new.carta.tech/lttng-list" --- # lttng-list(1) List LTTng recording sessions and instrumentation points ## NAME lttng-list - List LTTng recording sessions and instrumentation points ## SYNOPSIS 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] [--python] ``` List the available LTTng tracepoints, Linux system calls, and/or Java/Python loggers: ``` lttng [GENERAL OPTIONS] list [--fields] [--kernel [--syscall]] [--userspace] [--jul] [--log4j] [--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)](/lttng/1.md) 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. With the *SESSION* argument With the **--domain** option The tracing domains (with at least one channel) of the recording session named *SESSION*. Without the **--domain** option With the **--channel**=*CHANNEL* option The recording event rules of the channel *CHANNEL* of the recording session named *SESSION*. Without the **--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**, 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. With the **--jul**, **--log4j**, and/or **--python** options The available **java.util.logging**, Apache log4j, and/or Python logger names. Also list the available instrumentation point fields with the **--fields** option. See [**lttng-concepts**(7)](/lttng-concepts/7.md) 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)](/lttng-concepts/7.md) to learn more) with the [**lttng-status**(1)](/lttng-status/1.md) command. ## OPTIONS See [**lttng**(1)](/lttng/1.md) for *GENERAL OPTIONS*. ### Tracing domain - **-j**, **--jul** Without the *SESSION* argument List the **java.util.logging** logger names. With the *SESSION* argument Only list the **java.util.logging** channels and their recording event rules. - **-k**, **--kernel** Without the *SESSION* argument List the LTTng kernel instrumentation points. With the *SESSION* argument Only list the Linux kernel channels and their recording event rules. - **-l**, **--log4j** Without the *SESSION* argument List the Apache log4j logger names. With the *SESSION* argument Only list the Apache log4j channels and their recording event rules. - **-p**, **--python** Without the *SESSION* argument List the Python logger names. With the *SESSION* argument Only list the Python channels and their recording event rules. - **-u**, **--userspace** Without the *SESSION* argument List the LTTng user space tracepoints. With the *SESSION* argument Only list the user space channels and their recording event rules. ### Filtering - **-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. ### Program information - **-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. ## EXIT STATUS **0** Success **1** Command error **2** Undefined command **3** Fatal error **4** Command warning (something went wrong during the command) ## ENVIRONMENT **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)](/lttng-help/1.md) 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)](/lttng-sessiond/8.md)) to spawn from the [**lttng-create**(1)](/lttng-create/1.md) command. The **--sessiond-path** general option overrides this environment variable. ## FILES **$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/1.md). [**lttng-create**(1)](/lttng-create/1.md) and [**lttng-set-session**(1)](/lttng-set-session/1.md) 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)](/lttng-create/1.md) 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)](/lttng-save/1.md) and [**lttng-load**(1)](/lttng-load/1.md)). **/etc/lttng/sessions** Directory containing the system-wide saved recording session configurations (see [**lttng-save**(1)](/lttng-save/1.md) and [**lttng-load**(1)](/lttng-load/1.md)). **Note**\ **$LTTNG\_HOME** defaults to the value of the **HOME** environment variable. ## EXAMPLES **Example 1. List the recording sessions.** ``` $ lttng list ``` **Example 2. Show the details of a specific recording session.** ``` $ lttng list my-session ``` **Example 3. List the available Linux kernel system call instrumentation points.** ``` $ lttng list --kernel --syscall ``` **Example 4. List the available user space tracepoints with their fields.** See the **--fields** option. ``` $ lttng list --userspace --fields ``` **Example 5. List the tracing domains of a specific recording session having at least one channel.** See the **--domain** option. ``` $ lttng list --domain my-session ``` **Example 6. Show the details of a specific channel in a specific recording session.** See the **--channel** option. ``` $ lttng list my-session --channel=channel0 ``` ## RESOURCES • LTTng project website \ • LTTng documentation \ • LTTng bug tracker \ • Git repositories \ • GitHub organization \ • Continuous integration \ • Mailing list \ for support and development: **lttng-dev@lists.lttng.org** • IRC channel \: **#lttng** on **irc.oftc.net** ## COPYRIGHT 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. ## THANKS 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. ## SEE ALSO [**lttng**(1)](/lttng/1.md), [**lttng-concepts**(7)](/lttng-concepts/7.md)