doc/man/lttng-list.1.txt

   1 lttng-list(1)
   2 =============
   3 :revdate: 3 May 2021
   4
   5
   6 NAME
   7 ----
   8 lttng-list - List LTTng tracing sessions and instrumentation points
   9
  10
  11 SYNOPSIS
  12 --------
  13 List the tracing sessions:
  14
  15 [verse]
  16 *lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *list*
  17
  18 List the tracing domains with at least one channel of a tracing session:
  19
  20 [verse]
  21 *lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *list* option:--domain 'SESSION'
  22
  23 List the channels and recording event rules of a tracing session:
  24
  25 [verse]
  26 *lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *list* [option:--channel='CHANNEL'] 'SESSION'
  27       [option:--kernel] [option:--userspace] [option:--jul] [option:--log4j] [option:--python]
  28
  29 List the available LTTng tracepoints, Linux system calls, and/or
  30 Java/Python loggers:
  31
  32 [verse]
  33 *lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *list* [option:--fields]
  34       [option:--kernel [option:--syscall]] [option:--userspace] [option:--jul] [option:--log4j] [option:--python]
  35
  36
  37 DESCRIPTION
  38 -----------
  39 The `lttng list` command lists:
  40
  41 Without arguments::
  42     The tracing sessions of your Unix user, or of all users
  43     if your Unix user is `root`, within the connected session daemon.
  44 +
  45 See the ``Session daemon connection'' section of man:lttng(1) to learn
  46 how a user application connects to a session daemon.
  47 +
  48 The command shows tracing session properties such as their output
  49 directories/URLs and whether or not they're active.
  50
  51 With the 'SESSION' argument::
  52     With the option:--domain option:::
  53         The tracing domains (with at least one channel) of the tracing
  54         session named 'SESSION'.
  55
  56     Without the option:--domain option:::
  57         With the option:--channel='CHANNEL' option::::
  58             The recording event rules of the channel 'CHANNEL' of the
  59             tracing session named 'SESSION'.
  60
  61         Without the option:--channel option::::
  62             The channels of the tracing session named 'SESSION' and
  63             their recording event rules.
  64 +
  65 Use the dedicated tracing domain options (option:--kernel,
  66 option:--userspace, option:--jul, option:--log4j, and option:--python)
  67 to only show specific channels.
  68
  69 Without the 'SESSION' argument and with at least one dedicated tracing domain option::
  70 +
  71 --
  72 With the option:--kernel option::
  73     Without the option:--syscall option:::
  74         The available LTTng kernel tracepoints.
  75     With the option:--syscall option:::
  76         The available, instrumented Linux system calls.
  77 With the option:--userspace option::
  78     The available LTTng user space tracepoints.
  79 With the option:--jul, option:--log4j, and/or option:--python options::
  80     The available `java.util.logging`, Apache log4j, and/or Python
  81     logger names.
  82 --
  83 +
  84 Also list the available instrumentation point fields with the
  85 option:--fields option.
  86
  87 See man:lttng-concept(7) to learn more about tracing sessions, tracing
  88 domains, channels, recording event rules, and instrumentation points.
  89
  90 List the channels and recording event rules of the current tracing
  91 session (see man:lttng-concept(7) to learn more) with the
  92 man:lttng-status(1) command.
  93
  94
  95 include::common-lttng-cmd-options-head.txt[]
  96
  97
  98 Tracing domain
  99 ~~~~~~~~~~~~~~
 100 option:-j, option:--jul::
 101     Without the 'SESSION' argument:::
 102         List the `java.util.logging` logger names.
 103     With the 'SESSION' argument:::
 104         Only list the `java.util.logging` channels and their recording
 105         event rules.
 106
 107 option:-k, option:--kernel::
 108     Without the 'SESSION' argument:::
 109         List the LTTng kernel instrumentation points.
 110     With the 'SESSION' argument:::
 111         Only list the Linux kernel channels and their recording event
 112         rules.
 113
 114 option:-l, option:--log4j::
 115     Without the 'SESSION' argument:::
 116         List the Apache log4j logger names.
 117     With the 'SESSION' argument:::
 118         Only list the Apache log4j channels and their recording event
 119         rules.
 120
 121 option:-p, option:--python::
 122     Without the 'SESSION' argument:::
 123         List the Python logger names.
 124     With the 'SESSION' argument:::
 125         Only list the Python channels and their recording event rules.
 126
 127 option:-u, option:--userspace::
 128     Without the 'SESSION' argument:::
 129         List the LTTng user space tracepoints.
 130     With the 'SESSION' argument:::
 131         Only list the user space channels and their recording event
 132         rules.
 133
 134
 135 Filtering
 136 ~~~~~~~~~
 137 option:-c 'CHANNEL', option:--channel='CHANNEL'::
 138     Only list the properties and recording event rules of the channel
 139     named 'CHANNEL'.
 140 +
 141 Only available with the 'SESSION' argument.
 142
 143 option:-d, option:--domain::
 144     Show the tracing domains with at least one channel of the tracing
 145     session named 'SESSION'.
 146
 147 option:-f, option:--fields::
 148     When listing instrumentation points, also show their fields if
 149     they're available.
 150
 151 option:--syscall::
 152     When listing LTTng kernel instrumentation points, only list Linux
 153     system calls.
 154
 155
 156 include::common-lttng-cmd-help-options.txt[]
 157
 158
 159 include::common-lttng-cmd-after-options.txt[]
 160
 161
 162 include::common-footer.txt[]
 163
 164
 165 SEE ALSO
 166 --------
 167 man:lttng(1),
 168 man:lttng-concepts(7)