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