1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229
|
lttng-list(1)
=============
:revdate: 14 June 2021
NAME
----
lttng-list - List LTTng recording sessions and instrumentation points
SYNOPSIS
--------
List the recording sessions:
[verse]
*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *list*
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 recording session:
[verse]
*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *list* [option:--channel='CHANNEL'] 'SESSION'
[option:--kernel] [option:--userspace] [option:--jul] [option:--log4j] [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]
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 man: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.
With the 'SESSION' argument::
With the option:--domain option:::
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
recording session named 'SESSION'.
Without the option:--channel option::::
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.
Without the 'SESSION' argument and with at least one dedicated tracing domain option::
+
--
With the option:--kernel option::
Without the option:--syscall option:::
The available LTTng kernel tracepoints.
With the option:--syscall 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
logger names.
--
+
Also list the available instrumentation point fields with the
option:--fields option.
See man:lttng-concepts(7) to learn more about recording sessions, tracing
domains, channels, recording event rules, and instrumentation points.
See the ``<<examples,EXAMPLES>>'' 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.
include::common-lttng-cmd-options-head.txt[]
Tracing domain
~~~~~~~~~~~~~~
option:-j, option:--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.
option:-k, option:--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.
option:-l, option:--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.
option:-p, option:--python::
Without the 'SESSION' argument:::
List the Python logger names.
With the 'SESSION' argument:::
Only list the Python channels and their recording event rules.
option:-u, option:--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
~~~~~~~~~
option:-c 'CHANNEL', option:--channel='CHANNEL'::
Only list the properties and recording event rules of the channel
named 'CHANNEL'.
+
Only available with the 'SESSION' argument.
option:-d, option:--domain::
Show the tracing domains with at least one channel of the recording
session named 'SESSION'.
option:-f, option:--fields::
When listing instrumentation points, also show their fields if
they're available.
option:--syscall::
When listing LTTng kernel instrumentation points, only list Linux
system calls.
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[]
SEE ALSO
--------
man:lttng(1),
man:lttng-concepts(7)
|