X-Git-Url: http://git.lttng.org/?a=blobdiff_plain;f=doc%2Fman%2Flttng-list.1.txt;h=0cb19fe4825cd8f0582c3d0110243f6bb2379b88;hb=HEAD;hp=749d66e3f55d1133cd7f080f1b7f322b2017e694;hpb=f5511eeafdb40b9589306519633566c3be48756c;p=lttng-tools.git diff --git a/doc/man/lttng-list.1.txt b/doc/man/lttng-list.1.txt index 749d66e3f..6de96fa4f 100644 --- a/doc/man/lttng-list.1.txt +++ b/doc/man/lttng-list.1.txt @@ -1,37 +1,38 @@ lttng-list(1) ============= -:revdate: 3 May 2021 +:revdate: 14 June 2021 NAME ---- -lttng-list - List LTTng tracing sessions and instrumentation points +lttng-list - List LTTng recording sessions and instrumentation points SYNOPSIS -------- -List the tracing sessions: +List the recording sessions: [verse] *lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *list* -List the tracing domains with at least one channel of a tracing session: +List the tracing domains of a recording session with at least one +channel: [verse] *lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *list* option:--domain 'SESSION' -List the channels and recording event rules of a tracing session: +List the channels and recording event rules of a recording session: [verse] *lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *list* [option:--channel='CHANNEL'] 'SESSION' - [option:--kernel] [option:--userspace] [option:--jul] [option:--log4j] [option:--python] + [option:--kernel] [option:--userspace] [option:--jul] [option:--log4j] [option:--log4j2] [option:--python] List the available LTTng tracepoints, Linux system calls, and/or Java/Python loggers: [verse] *lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *list* [option:--fields] - [option:--kernel [option:--syscall]] [option:--userspace] [option:--jul] [option:--log4j] [option:--python] + [option:--kernel [option:--syscall]] [option:--userspace] [option:--jul] [option:--log4j] [option:--log4j2] [option:--python] DESCRIPTION @@ -39,32 +40,32 @@ DESCRIPTION The `lttng list` command lists: Without arguments:: - The tracing sessions of your Unix user, or of all users + 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 man:lttng(1) to learn how a user application connects to a session daemon. + -The command shows tracing session properties such as their output +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 option:--domain option::: - The tracing domains (with at least one channel) of the tracing + The tracing domains (with at least one channel) of the recording session named 'SESSION'. Without the option:--domain option::: With the option:--channel='CHANNEL' option:::: The recording event rules of the channel 'CHANNEL' of the - tracing session named 'SESSION'. + recording session named 'SESSION'. Without the option:--channel option:::: - The channels of the tracing session named 'SESSION' and + The channels of the recording session named 'SESSION' and their recording event rules. + Use the dedicated tracing domain options (option:--kernel, -option:--userspace, option:--jul, option:--log4j, and option:--python) -to only show specific channels. +option:--userspace, option:--jul, option:--log4j, option:--log4j2, and +option:--python) to only show specific channels. Without the 'SESSION' argument and with at least one dedicated tracing domain option:: + @@ -76,19 +77,21 @@ With the option:--kernel option:: The available, instrumented Linux system calls. With the option:--userspace option:: The available LTTng user space tracepoints. -With the option:--jul, option:--log4j, and/or option:--python options:: - The available `java.util.logging`, Apache log4j, and/or Python +With the option:--jul, option:--log4j, option:--log4j2, and/or option:--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 option:--fields option. -See man:lttng-concept(7) to learn more about tracing sessions, tracing +See man:lttng-concepts(7) to learn more about recording sessions, tracing domains, channels, recording event rules, and instrumentation points. -List the channels and recording event rules of the current tracing -session (see man:lttng-concept(7) to learn more) with the +See the ``<>'' section below for usage examples. + +List the channels and recording event rules of the current recording +session (see man:lttng-concepts(7) to learn more) with the man:lttng-status(1) command. @@ -113,9 +116,16 @@ option:-k, option:--kernel:: option:-l, option:--log4j:: Without the 'SESSION' argument::: - List the Apache log4j logger names. + List the Apache Log4j 1.x logger names. With the 'SESSION' argument::: - Only list the Apache log4j channels and their recording event + Only list the Apache Log4j 1.x channels and their recording event + rules. + +option:--log4j2:: + Without the 'SESSION' argument::: + List the Apache Log4j 2 logger names. + With the 'SESSION' argument::: + Only list the Apache Log4j 2 channels and their recording event rules. option:-p, option:--python:: @@ -141,7 +151,7 @@ option:-c 'CHANNEL', option:--channel='CHANNEL':: Only available with the 'SESSION' argument. option:-d, option:--domain:: - Show the tracing domains with at least one channel of the tracing + Show the tracing domains with at least one channel of the recording session named 'SESSION'. option:-f, option:--fields:: @@ -159,6 +169,64 @@ include::common-lttng-cmd-help-options.txt[] include::common-lttng-cmd-after-options.txt[] +[[examples]] +EXAMPLES +-------- +.List the recording sessions. +==== +[role="term"] +---- +$ lttng list +---- +==== + +.Show the details of a specific recording session. +==== +[role="term"] +---- +$ lttng list my-session +---- +==== + +.List the available Linux kernel system call instrumentation points. +==== +[role="term"] +---- +$ lttng list --kernel --syscall +---- +==== + +.List the available user space tracepoints with their fields. +==== +See the option:--fields option. + +[role="term"] +---- +$ lttng list --userspace --fields +---- +==== + +.List the tracing domains of a specific recording session having at least one channel. +==== +See the option:--domain option. + +[role="term"] +---- +$ lttng list --domain my-session +---- +==== + +.Show the details of a specific channel in a specific recording session. +==== +See the option:--channel option. + +[role="term"] +---- +$ lttng list my-session --channel=channel0 +---- +==== + + include::common-footer.txt[]