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:--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:--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, and option:--python)
  68 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, and/or option:--python options::
  81     The available `java.util.logging`, Apache log4j, 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 logger names.
 120     With the 'SESSION' argument:::
 121         Only list the Apache log4j channels and their recording event
 122         rules.
 123
 124 option:-p, option:--python::
 125     Without the 'SESSION' argument:::
 126         List the Python logger names.
 127     With the 'SESSION' argument:::
 128         Only list the Python channels and their recording event rules.
 129
 130 option:-u, option:--userspace::
 131     Without the 'SESSION' argument:::
 132         List the LTTng user space tracepoints.
 133     With the 'SESSION' argument:::
 134         Only list the user space channels and their recording event
 135         rules.
 136
 137
 138 Filtering
 139 ~~~~~~~~~
 140 option:-c 'CHANNEL', option:--channel='CHANNEL'::
 141     Only list the properties and recording event rules of the channel
 142     named 'CHANNEL'.
 143 +
 144 Only available with the 'SESSION' argument.
 145
 146 option:-d, option:--domain::
 147     Show the tracing domains with at least one channel of the recording
 148     session named 'SESSION'.
 149
 150 option:-f, option:--fields::
 151     When listing instrumentation points, also show their fields if
 152     they're available.
 153
 154 option:--syscall::
 155     When listing LTTng kernel instrumentation points, only list Linux
 156     system calls.
 157
 158
 159 include::common-lttng-cmd-help-options.txt[]
 160
 161
 162 include::common-lttng-cmd-after-options.txt[]
 163
 164
 165 [[examples]]
 166 EXAMPLES
 167 --------
 168 .List the recording sessions.
 169 ====
 170 [role="term"]
 171 ----
 172 $ lttng list
 173 ----
 174 ====
 175
 176 .Show the details of a specific recording session.
 177 ====
 178 [role="term"]
 179 ----
 180 $ lttng list my-session
 181 ----
 182 ====
 183
 184 .List the available Linux kernel system call instrumentation points.
 185 ====
 186 [role="term"]
 187 ----
 188 $ lttng list --kernel --syscall
 189 ----
 190 ====
 191
 192 .List the available user space tracepoints with their fields.
 193 ====
 194 See the option:--fields option.
 195
 196 [role="term"]
 197 ----
 198 $ lttng list --userspace --fields
 199 ----
 200 ====
 201
 202 .List the tracing domains of a specific recording session having at least one channel.
 203 ====
 204 See the option:--domain option.
 205
 206 [role="term"]
 207 ----
 208 $ lttng list --domain my-session
 209 ----
 210 ====
 211
 212 .Show the details of a specific channel in a specific recording session.
 213 ====
 214 See the option:--channel option.
 215
 216 [role="term"]
 217 ----
 218 $ lttng list my-session --channel=channel0
 219 ----
 220 ====
 221
 222
 223 include::common-footer.txt[]
 224
 225
 226 SEE ALSO
 227 --------
 228 man:lttng(1),
 229 man:lttng-concepts(7)