doc/man/lttng-list.1.txt

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