Commit | Line | Data |
---|---|---|
882108c6 PP |
1 | lttng-list(1) |
2 | ============= | |
ac1c08bf | 3 | :revdate: 17 May 2021 |
882108c6 PP |
4 | |
5 | ||
6 | NAME | |
7 | ---- | |
26f0c779 | 8 | lttng-list - List LTTng tracing sessions and instrumentation points |
882108c6 PP |
9 | |
10 | ||
11 | SYNOPSIS | |
12 | -------- | |
26f0c779 | 13 | List the tracing sessions: |
882108c6 PP |
14 | |
15 | [verse] | |
ce19b9ed | 16 | *lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *list* |
882108c6 | 17 | |
ac1c08bf | 18 | List the tracing domains of a tracing session with at least one channel: |
882108c6 PP |
19 | |
20 | [verse] | |
26f0c779 | 21 | *lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *list* option:--domain 'SESSION' |
882108c6 | 22 | |
26f0c779 | 23 | List the channels and recording event rules of a tracing session: |
882108c6 PP |
24 | |
25 | [verse] | |
26f0c779 PP |
26 | *lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *list* [option:--channel='CHANNEL'] 'SESSION' |
27 | [option:--kernel] [option:--userspace] [option:--jul] [option:--log4j] [option:--python] | |
882108c6 | 28 | |
26f0c779 PP |
29 | List the available LTTng tracepoints, Linux system calls, and/or |
30 | Java/Python loggers: | |
882108c6 PP |
31 | |
32 | [verse] | |
26f0c779 PP |
33 | *lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *list* [option:--fields] |
34 | [option:--kernel [option:--syscall]] [option:--userspace] [option:--jul] [option:--log4j] [option:--python] | |
882108c6 PP |
35 | |
36 | ||
37 | DESCRIPTION | |
38 | ----------- | |
26f0c779 PP |
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 | ||
da39b67c | 90 | See the ``<<examples,EXAMPLES>>'' section below for usage examples. |
ac1c08bf | 91 | |
26f0c779 PP |
92 | List the channels and recording event rules of the current tracing |
93 | session (see man:lttng-concept(7) to learn more) with the | |
94 | man:lttng-status(1) command. | |
882108c6 PP |
95 | |
96 | ||
f5511eea | 97 | include::common-lttng-cmd-options-head.txt[] |
882108c6 PP |
98 | |
99 | ||
26f0c779 PP |
100 | Tracing domain |
101 | ~~~~~~~~~~~~~~ | |
882108c6 | 102 | option:-j, option:--jul:: |
26f0c779 PP |
103 | Without the 'SESSION' argument::: |
104 | List the `java.util.logging` logger names. | |
105 | With the 'SESSION' argument::: | |
106 | Only list the `java.util.logging` channels and their recording | |
107 | event rules. | |
882108c6 PP |
108 | |
109 | option:-k, option:--kernel:: | |
26f0c779 PP |
110 | Without the 'SESSION' argument::: |
111 | List the LTTng kernel instrumentation points. | |
112 | With the 'SESSION' argument::: | |
113 | Only list the Linux kernel channels and their recording event | |
114 | rules. | |
882108c6 PP |
115 | |
116 | option:-l, option:--log4j:: | |
26f0c779 PP |
117 | Without the 'SESSION' argument::: |
118 | List the Apache log4j logger names. | |
119 | With the 'SESSION' argument::: | |
120 | Only list the Apache log4j channels and their recording event | |
121 | rules. | |
882108c6 PP |
122 | |
123 | option:-p, option:--python:: | |
26f0c779 PP |
124 | Without the 'SESSION' argument::: |
125 | List the Python logger names. | |
126 | With the 'SESSION' argument::: | |
127 | Only list the Python channels and their recording event rules. | |
882108c6 PP |
128 | |
129 | option:-u, option:--userspace:: | |
26f0c779 PP |
130 | Without the 'SESSION' argument::: |
131 | List the LTTng user space tracepoints. | |
132 | With the 'SESSION' argument::: | |
133 | Only list the user space channels and their recording event | |
134 | rules. | |
882108c6 PP |
135 | |
136 | ||
26f0c779 PP |
137 | Filtering |
138 | ~~~~~~~~~ | |
59b19c3c | 139 | option:-c 'CHANNEL', option:--channel='CHANNEL':: |
26f0c779 PP |
140 | Only list the properties and recording event rules of the channel |
141 | named 'CHANNEL'. | |
142 | + | |
143 | Only available with the 'SESSION' argument. | |
882108c6 | 144 | |
882108c6 | 145 | option:-d, option:--domain:: |
26f0c779 PP |
146 | Show the tracing domains with at least one channel of the tracing |
147 | session named 'SESSION'. | |
882108c6 PP |
148 | |
149 | option:-f, option:--fields:: | |
26f0c779 PP |
150 | When listing instrumentation points, also show their fields if |
151 | they're available. | |
882108c6 PP |
152 | |
153 | option:--syscall:: | |
26f0c779 PP |
154 | When listing LTTng kernel instrumentation points, only list Linux |
155 | system calls. | |
882108c6 PP |
156 | |
157 | ||
f5511eea | 158 | include::common-lttng-cmd-help-options.txt[] |
882108c6 PP |
159 | |
160 | ||
f5511eea PP |
161 | include::common-lttng-cmd-after-options.txt[] |
162 | ||
163 | ||
ac1c08bf PP |
164 | [[examples]] |
165 | EXAMPLES | |
166 | -------- | |
167 | .List the tracing sessions. | |
168 | ==== | |
169 | [role="term"] | |
170 | ---- | |
171 | $ lttng list | |
172 | ---- | |
173 | ==== | |
174 | ||
175 | .Show the details of a specific tracing session. | |
176 | ==== | |
177 | [role="term"] | |
178 | ---- | |
179 | $ lttng list my-session | |
180 | ---- | |
181 | ==== | |
182 | ||
183 | .List the available Linux kernel system call instrumentation points. | |
184 | ==== | |
185 | [role="term"] | |
186 | ---- | |
187 | $ lttng list --kernel --syscall | |
188 | ---- | |
189 | ==== | |
190 | ||
191 | .List the available user space tracepoints with their fields. | |
192 | ==== | |
193 | See the option:--fields option. | |
194 | ||
195 | [role="term"] | |
196 | ---- | |
197 | $ lttng list --userspace --fields | |
198 | ---- | |
199 | ==== | |
200 | ||
201 | .List the tracing domains of a specific tracing session having at least one channel. | |
202 | ==== | |
203 | See the option:--domain option. | |
204 | ||
205 | [role="term"] | |
206 | ---- | |
207 | $ lttng list --domain my-session | |
208 | ---- | |
209 | ==== | |
210 | ||
211 | .Show the details of a specific channel in a specific tracing session. | |
212 | ==== | |
213 | See the option:--channel option. | |
214 | ||
215 | [role="term"] | |
216 | ---- | |
217 | $ lttng list my-session --channel=channel0 | |
218 | ---- | |
219 | ==== | |
220 | ||
221 | ||
f5511eea | 222 | include::common-footer.txt[] |
882108c6 PP |
223 | |
224 | ||
225 | SEE ALSO | |
226 | -------- | |
26f0c779 PP |
227 | man:lttng(1), |
228 | man:lttng-concepts(7) |