95025563920993ca64d160c58266cb2346943dac
[lttng-tools.git] / doc / man / lttng-list.1.txt
1 lttng-list(1)
2 =============
3
4
5 NAME
6 ----
7 lttng-list - List LTTng tracing sessions, domains, channels, and events
8
9
10 SYNOPSIS
11 --------
12 List existing tracing sessions:
13
14 [verse]
15 *lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *list*
16
17 List available event sources:
18
19 [verse]
20 *lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *list* [option:--fields]
21 [option:--kernel [option:--syscall]] [option:--userspace] [option:--jul] [option:--log4j] [option:--python]
22
23 List tracing session's domains:
24
25 [verse]
26 *lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *list* option:--domain 'SESSION'
27
28 List tracing session's channels and event rules:
29
30 [verse]
31 *lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *list* [option:--channel='CHANNEL'] 'SESSION'
32
33
34 DESCRIPTION
35 -----------
36 The `lttng list` command lists tracing sessions, tracing domains,
37 channels, and events.
38
39 Without arguments, `lttng list` lists the existing tracing sessions
40 and shows if they are active or not.
41
42 With one or more of the option:--kernel, option:--userspace,
43 option:--jul, option:--log4j, and option:--python domain options, the
44 command lists the available event sources of the selected domain on the
45 system. The JUL, log4j, and Python domains list the names of their
46 available _loggers_. The option:--syscall option can be used alongside
47 the option:--kernel option to get a list of traceable Linux system
48 calls. The option:--fields option can be used to show the fields of the
49 listed event sources.
50
51 Providing a tracing session name 'SESSION' targets a specific tracing
52 session. If the option:--domain option is used, domains containing at
53 least one channel in the selected tracing session are listed. Otherwise,
54 all the domains, channels, and event rules of the selected tracing
55 session are listed along with its details (trace path, for example),
56 except when the option:--channel option is used to isolate a specific
57 channel by name.
58
59
60 include::common-cmd-options-head.txt[]
61
62
63 Domain
64 ~~~~~~
65 option:-j, option:--jul::
66 List event sources in the `java.util.logging` (JUL) domain.
67
68 option:-k, option:--kernel::
69 List event sources in the Linux kernel domain.
70
71 option:-l, option:--log4j::
72 List event sources in the Apache log4j domain.
73
74 option:-p, option:--python::
75 List event sources in the Python domain.
76
77 option:-u, option:--userspace::
78 List event sources in the user space domain.
79
80
81 Target
82 ~~~~~~
83 option:-c 'CHANNEL', option:--channel='CHANNEL'::
84 Only list the details of the channel named 'CHANNEL'.
85
86
87 Listing
88 ~~~~~~~
89 option:-d, option:--domain::
90 Show the domains of the target tracing session in which at least one
91 channel exists.
92
93 option:-f, option:--fields::
94 When listing the event sources with one of the domain options,
95 also show their fields.
96
97 option:--syscall::
98 When listing the event sources of the Linux kernel domain, list
99 the traceable system calls instead of the kernel tracepoints.
100
101
102 include::common-cmd-help-options.txt[]
103
104
105 include::common-cmd-footer.txt[]
106
107
108 SEE ALSO
109 --------
110 man:lttng(1)
This page took 0.04387 seconds and 3 git commands to generate.