Commit | Line | Data |
---|---|---|
278eefc8 | 1 | .TH "LTTNG" "1" "February 05th, 2014" "" "" |
6991b181 DG |
2 | |
3 | .SH "NAME" | |
c5db699c | 4 | lttng \(em LTTng 2.x tracer control command line tool |
6991b181 DG |
5 | |
6 | .SH "SYNOPSIS" | |
7 | ||
8 | .PP | |
6991b181 | 9 | lttng [OPTIONS] <COMMAND> |
6991b181 DG |
10 | .SH "DESCRIPTION" |
11 | ||
12 | .PP | |
13 | The LTTng project aims at providing highly efficient tracing tools for Linux. | |
e256d661 | 14 | Its tracers help track down performance issues and debug problems |
6991b181 DG |
15 | involving multiple concurrent processes and threads. Tracing across multiple |
16 | systems is also possible. | |
17 | ||
fa072eae | 18 | The \fBlttng\fP command line tool from the lttng-tools package is used to control |
e256d661 JG |
19 | both kernel and user-space tracing. Every interaction with the tracer should |
20 | be done by this tool or by the liblttng-ctl library provided by the lttng-tools | |
6991b181 DG |
21 | package. |
22 | ||
23 | LTTng uses a session daemon (lttng-sessiond(8)), acting as a tracing registry, | |
50a3b92a | 24 | which allows you to interact with multiple tracers (kernel and user-space) |
6991b181 DG |
25 | inside the same container, a tracing session. Traces can be gathered from the |
26 | kernel and/or instrumented applications (lttng-ust(3)). Aggregating and reading | |
27 | those traces is done using the babeltrace(1) text viewer. | |
28 | ||
50a3b92a | 29 | We introduce the notion of \fBtracing domains\fP which is essentially a type of |
278eefc8 DG |
30 | tracer (kernel, user space or JUL for now). In the future, we could see more |
31 | tracer like for instance an hypervisor. For some commands, you'll need to | |
32 | specify on which domain the command operates (\-u, \-k or \-j). For instance, | |
33 | the kernel domain must be specified when enabling a kernel event. | |
50a3b92a | 34 | |
6991b181 DG |
35 | In order to trace the kernel, the session daemon needs to be running as root. |
36 | LTTng provides the use of a \fBtracing group\fP (default: tracing). Whomever is | |
37 | in that group can interact with the root session daemon and thus trace the | |
e256d661 | 38 | kernel. Session daemons can co-exist, meaning that you can have a session daemon |
fa072eae | 39 | running as Alice that can be used to trace her applications along side with a |
e256d661 | 40 | root daemon or even a Bob daemon. We highly recommend starting the session |
6991b181 DG |
41 | daemon at boot time for stable and long term tracing. |
42 | ||
faf3c371 DG |
43 | Each user-space application instrumented with lttng-ust(3) will automatically |
44 | register with the root session daemon and its user session daemon. This allows | |
45 | each daemon to list the available traceable applications and tracepoints at any | |
46 | given moment (See the \fBlist\fP command). | |
6991b181 DG |
47 | .SH "OPTIONS" |
48 | ||
49 | .PP | |
50 | This program follow the usual GNU command line syntax with long options starting with | |
51 | two dashes. Below is a summary of the available options. | |
52 | .PP | |
53 | ||
54 | .TP | |
c9e32613 | 55 | .BR "\-h, \-\-help" |
6991b181 DG |
56 | Show summary of possible options and commands. |
57 | .TP | |
c9e32613 | 58 | .BR "\-v, \-\-verbose" |
6991b181 | 59 | Increase verbosity. |
d829b38c | 60 | Three levels of verbosity are available which are triggered by putting additional v to |
fa072eae | 61 | the option (\-vv or \-vvv) |
6991b181 | 62 | .TP |
c9e32613 | 63 | .BR "\-q, \-\-quiet" |
6991b181 DG |
64 | Suppress all messages (even errors). |
65 | .TP | |
c9e32613 | 66 | .BR "\-g, \-\-group NAME" |
6991b181 DG |
67 | Set unix tracing group name. (default: tracing) |
68 | .TP | |
c9e32613 | 69 | .BR "\-n, \-\-no-sessiond" |
6991b181 DG |
70 | Don't automatically spawn a session daemon. |
71 | .TP | |
391b9c72 | 72 | .BR "\-\-sessiond\-path PATH" |
6991b181 DG |
73 | Set session daemon full binary path. |
74 | .TP | |
c9e32613 | 75 | .BR "\-\-list\-options" |
6991b181 DG |
76 | Simple listing of lttng options. |
77 | .TP | |
c9e32613 | 78 | .BR "\-\-list\-commands" |
6991b181 DG |
79 | Simple listing of lttng commands. |
80 | .SH "COMMANDS" | |
81 | ||
812a5eb7 | 82 | .PP |
ee2758e5 | 83 | \fBadd-context\fP [OPTIONS] |
812a5eb7 | 84 | .RS |
6991b181 DG |
85 | Add context to event(s) and/or channel(s). |
86 | ||
391b9c72 DG |
87 | A context is basically extra information appended to a channel. For instance, |
88 | you could ask the tracer to add the PID information for all events in a | |
89 | channel. You can also add performance monitoring unit counters (perf PMU) using | |
90 | the perf kernel API). | |
6991b181 DG |
91 | |
92 | For example, this command will add the context information 'prio' and two perf | |
93 | counters (hardware branch misses and cache misses), to all events in the trace | |
94 | data output: | |
95 | ||
812a5eb7 MD |
96 | .nf |
97 | # lttng add-context \-k \-t prio \-t perf:branch-misses \\ | |
98 | \-t perf:cache-misses | |
99 | .fi | |
6991b181 | 100 | |
c9e32613 | 101 | Please take a look at the help (\-h/\-\-help) for a detailed list of available |
6991b181 DG |
102 | contexts. |
103 | ||
bd337b98 DG |
104 | If no channel is given (\-c), the context is added to all channels that were |
105 | already enabled. If the session has no channel, a default channel is created. | |
31ea4846 | 106 | Otherwise the context will be added only to the given channel (\-c). |
6991b181 | 107 | |
c9e32613 | 108 | If \fB\-s, \-\-session\fP is omitted, the session name is taken from the .lttngrc |
6991b181 | 109 | file. |
6991b181 DG |
110 | |
111 | .B OPTIONS: | |
112 | ||
812a5eb7 MD |
113 | .TP |
114 | .BR "\-h, \-\-help" | |
115 | Show summary of possible options and commands. | |
116 | .TP | |
117 | .BR "\-s, \-\-session NAME" | |
118 | Apply on session name. | |
119 | .TP | |
120 | .BR "\-c, \-\-channel NAME" | |
121 | Apply on channel name. | |
122 | .TP | |
123 | .BR "\-k, \-\-kernel" | |
124 | Apply for the kernel tracer | |
125 | .TP | |
126 | .BR "\-u, \-\-userspace" | |
127 | Apply for the user-space tracer | |
128 | .TP | |
129 | .BR "\-t, \-\-type TYPE" | |
130 | Context type. You can repeat this option on the command line. Please | |
131 | use "lttng add-context \-h" to list all available types. | |
132 | .RE | |
133 | .PP | |
6991b181 | 134 | |
22019883 MD |
135 | .PP |
136 | \fBcalibrate\fP [OPTIONS] | |
137 | .RS | |
6991b181 DG |
138 | Quantify LTTng overhead |
139 | ||
140 | The LTTng calibrate command can be used to find out the combined average | |
141 | overhead of the LTTng tracer and the instrumentation mechanisms used. This | |
142 | overhead can be calibrated in terms of time or using any of the PMU performance | |
143 | counter available on the system. | |
144 | ||
145 | For now, the only calibration implemented is that of the kernel function | |
146 | instrumentation (kretprobes). | |
147 | ||
148 | * Calibrate kernel function instrumentation | |
149 | ||
150 | Let's use an example to show this calibration. We use an i7 processor with 4 | |
151 | general-purpose PMU registers. This information is available by issuing dmesg, | |
152 | looking for "generic registers". | |
153 | ||
154 | This sequence of commands will gather a trace executing a kretprobe hooked on | |
155 | an empty function, gathering PMU counters LLC (Last Level Cache) misses | |
c9e32613 | 156 | information (see lttng add-context \-\-help to see the list of available PMU |
6991b181 DG |
157 | counters). |
158 | ||
22019883 | 159 | .nf |
6991b181 | 160 | # lttng create calibrate-function |
22019883 MD |
161 | # lttng enable-event calibrate \-\-kernel \\ |
162 | \-\-function lttng_calibrate_kretprobe | |
163 | # lttng add-context \-\-kernel \-t perf:LLC-load-misses \\ | |
164 | \-t perf:LLC-store-misses \\ | |
165 | \-t perf:LLC-prefetch-misses | |
6991b181 DG |
166 | # lttng start |
167 | # for a in $(seq 1 10); do \\ | |
c9e32613 | 168 | lttng calibrate \-\-kernel \-\-function; |
6991b181 DG |
169 | done |
170 | # lttng destroy | |
22019883 MD |
171 | # babeltrace $(ls \-1drt ~/lttng-traces/calibrate-function-* \\ |
172 | | tail \-n 1) | |
173 | .fi | |
6991b181 DG |
174 | |
175 | The output from babeltrace can be saved to a text file and opened in a | |
176 | spreadsheet (e.g. oocalc) to focus on the per-PMU counter delta between | |
177 | consecutive "calibrate_entry" and "calibrate_return" events. Note that these | |
178 | counters are per-CPU, so scheduling events would need to be present to account | |
179 | for migration between CPU. Therefore, for calibration purposes, only events | |
180 | staying on the same CPU must be considered. | |
181 | ||
182 | The average result, for the i7, on 10 samples: | |
183 | ||
22019883 | 184 | .nf |
6991b181 DG |
185 | Average Std.Dev. |
186 | perf_LLC_load_misses: 5.0 0.577 | |
187 | perf_LLC_store_misses: 1.6 0.516 | |
188 | perf_LLC_prefetch_misses: 9.0 14.742 | |
22019883 | 189 | .fi |
6991b181 DG |
190 | |
191 | As we can notice, the load and store misses are relatively stable across runs | |
192 | (their standard deviation is relatively low) compared to the prefetch misses. | |
193 | We can conclude from this information that LLC load and store misses can be | |
194 | accounted for quite precisely, but prefetches within a function seems to behave | |
195 | too erratically (not much causality link between the code executed and the CPU | |
196 | prefetch activity) to be accounted for. | |
6991b181 DG |
197 | |
198 | .B OPTIONS: | |
199 | ||
22019883 MD |
200 | .TP |
201 | .BR "\-h, \-\-help" | |
202 | Show summary of possible options and commands. | |
203 | .TP | |
204 | .BR "\-k, \-\-kernel" | |
205 | Apply for the kernel tracer | |
206 | .TP | |
207 | .BR "\-u, \-\-userspace" | |
208 | Apply for the user-space tracer | |
209 | .TP | |
210 | .BR "\-\-function" | |
211 | Dynamic function entry/return probe (default) | |
212 | .RE | |
213 | .PP | |
6991b181 | 214 | |
ee2758e5 | 215 | .PP |
feb3ca56 | 216 | \fBcreate\fP [NAME] [OPTIONS] |
ee2758e5 | 217 | .RS |
6991b181 DG |
218 | Create tracing session. |
219 | ||
220 | A tracing session contains channel(s) which contains event(s). It is domain | |
e256d661 | 221 | agnostic, meaning that channels and events can be enabled for the |
6991b181 DG |
222 | user-space tracer and/or the kernel tracer. It acts like a container |
223 | aggregating multiple tracing sources. | |
224 | ||
225 | On creation, a \fB.lttngrc\fP file is created in your $HOME directory | |
226 | containing the current session name. If NAME is omitted, a session name is | |
fa072eae | 227 | automatically created having this form: 'auto-yyyymmdd-hhmmss'. |
6991b181 | 228 | |
c9e32613 | 229 | If no \fB\-o, \-\-output\fP is specified, the traces will be written in |
6991b181 | 230 | $HOME/lttng-traces. |
feb0f3e5 AM |
231 | |
232 | The $HOME environment variable can be overridden by defining the environment | |
233 | variable LTTNG_HOME. This is useful when the user running the commands has | |
234 | a non-writeable home directory. | |
6991b181 | 235 | |
0841762c DG |
236 | The session name MUST NOT contain the character '/'. |
237 | ||
6991b181 DG |
238 | .B OPTIONS: |
239 | ||
ee2758e5 MD |
240 | .TP |
241 | .BR "\-h, \-\-help" | |
242 | Show summary of possible options and commands. | |
243 | .TP | |
244 | .BR "\-\-list-options" | |
245 | Simple listing of options | |
246 | .TP | |
247 | .BR "\-o, \-\-output PATH" | |
248 | Specify output path for traces | |
249 | .TP | |
250 | .BR "\-\-no-output" | |
e256d661 | 251 | Traces will not be output |
ee2758e5 MD |
252 | .TP |
253 | .BR "\-\-snapshot" | |
254 | Set the session in snapshot mode. Created in no-output mode and uses the | |
e256d661 | 255 | URL, if one is specified, as the default snapshot output. Every channel will be set |
ee2758e5 | 256 | in overwrite mode and with mmap output (splice not supported). |
0794f51b | 257 | .TP |
05287bd3 | 258 | .BR "\-\-live [USEC]" |
0794f51b DG |
259 | Set the session exclusively in live mode. The paremeter is the delay in micro |
260 | seconds before the data is flushed and streamed. The live mode allows you to | |
261 | stream the trace and view it while it's being recorded by any tracer. For that, | |
262 | you need a lttng-relayd and this session requires a network URL (\-U or | |
05287bd3 DG |
263 | \-C/\-D). If no USEC nor URL is provided, the default is to use a timer value |
264 | set to 1000000 and the network URL set to net://127.0.0.1. | |
0794f51b DG |
265 | |
266 | To read a live session, you can use babeltrace(1) or the live streaming | |
267 | protocol in doc/live-reading-protocol.txt. Here is an example: | |
268 | ||
269 | .nf | |
270 | $ lttng-relayd -o /tmp/lttng | |
271 | $ lttng create --live 200000 -U net://localhost | |
272 | $ lttng enable-event -a --userspace | |
273 | $ lttng start | |
274 | .fi | |
275 | ||
276 | After the start, you'll be able to read the events while they are being | |
277 | recorded in /tmp/lttng. | |
6b8f2e64 | 278 | |
ee2758e5 MD |
279 | .TP |
280 | .BR "\-U, \-\-set-url=URL" | |
281 | Set URL for the consumer output destination. It is persistent for the | |
282 | session lifetime. Redo the command to change it. This will set both data | |
283 | and control URL for network. | |
284 | .TP | |
285 | .BR "\-C, \-\-ctrl-url=URL" | |
286 | Set control path URL. (Must use -D also) | |
287 | .TP | |
288 | .BR "\-D, \-\-data-url=URL" | |
289 | Set data path URL. (Must use -C also) | |
290 | .PP | |
6b8f2e64 DG |
291 | Using these options, each API call can be controlled individually. For |
292 | instance, \-C does not enable the consumer automatically. You'll need the \-e | |
293 | option for that. | |
294 | ||
785d2d0d DG |
295 | .B URL FORMAT: |
296 | ||
297 | proto://[HOST|IP][:PORT1[:PORT2]][/TRACE_PATH] | |
298 | ||
299 | Supported protocols are (proto): | |
ee2758e5 MD |
300 | .TP |
301 | .BR "file://..." | |
302 | Local filesystem full path. | |
785d2d0d | 303 | |
ee2758e5 MD |
304 | .TP |
305 | .BR "net://..." | |
306 | This will use the default network transport layer which is TCP for both | |
307 | control (PORT1) and data port (PORT2). The default ports are | |
308 | respectively 5342 and 5343. Note that net[6]:// is not yet supported. | |
785d2d0d | 309 | |
ee2758e5 MD |
310 | .TP |
311 | .BR "tcp[6]://..." | |
312 | Can only be used with -C and -D together | |
785d2d0d DG |
313 | |
314 | NOTE: IPv6 address MUST be enclosed in brackets '[]' (rfc2732) | |
6b8f2e64 DG |
315 | |
316 | .B EXAMPLES: | |
317 | ||
ee2758e5 | 318 | .nf |
6b8f2e64 | 319 | # lttng create -U net://192.168.1.42 |
ee2758e5 | 320 | .fi |
6b8f2e64 DG |
321 | Uses TCP and default ports for the given destination. |
322 | ||
ee2758e5 | 323 | .nf |
6b8f2e64 | 324 | # lttng create -U net6://[fe80::f66d:4ff:fe53:d220] |
ee2758e5 | 325 | .fi |
6b8f2e64 DG |
326 | Uses TCP, default ports and IPv6. |
327 | ||
ee2758e5 | 328 | .nf |
6b8f2e64 | 329 | # lttng create s1 -U net://myhost.com:3229 |
6991b181 | 330 | .fi |
ee2758e5 MD |
331 | Create session s1 and set its consumer to myhost.com on port 3229 for control. |
332 | .RE | |
333 | .PP | |
6991b181 | 334 | |
f2b14ef1 MD |
335 | .PP |
336 | \fBdestroy\fP [NAME] [OPTIONS] | |
337 | .RS | |
6991b181 DG |
338 | Teardown tracing session |
339 | ||
340 | Free memory on the session daemon and tracer side. It's gone! | |
341 | ||
342 | If NAME is omitted, the session name is taken from the .lttngrc file. | |
6991b181 DG |
343 | |
344 | .B OPTIONS: | |
345 | ||
f2b14ef1 MD |
346 | .TP |
347 | .BR "\-h, \-\-help" | |
348 | Show summary of possible options and commands. | |
349 | .TP | |
350 | .BR "\-a, \-\-all" | |
351 | Destroy all sessions | |
352 | .TP | |
353 | .BR "\-\-list-options" | |
354 | Simple listing of options | |
355 | .RE | |
356 | .PP | |
6991b181 | 357 | |
05be3802 MD |
358 | .PP |
359 | \fBenable-channel\fP NAME[,NAME2,...] (\-k | \-u) [OPTIONS] | |
360 | .RS | |
6991b181 DG |
361 | Enable tracing channel |
362 | ||
004f3466 DG |
363 | To enable an event, you must enable both the event and the channel that |
364 | contains it. | |
b883c01b | 365 | |
c9e32613 | 366 | If \fB\-s, \-\-session\fP is omitted, the session name is taken from the .lttngrc |
6991b181 | 367 | file. |
7972aab2 | 368 | |
05be3802 MD |
369 | Exactly one of \-k or -u must be specified. |
370 | ||
7972aab2 | 371 | It is important to note that if a certain type of buffers is used, the session |
bd337b98 | 372 | will be set with that type and all other subsequent channel needs to have the |
7972aab2 | 373 | same type. |
bd337b98 | 374 | |
d2f11c4a DG |
375 | Note that once the session has been started and enabled on the tracer side, |
376 | it's not possible anymore to enable a new channel for that session. | |
6991b181 DG |
377 | |
378 | .B OPTIONS: | |
379 | ||
05be3802 MD |
380 | .TP |
381 | .BR "\-h, \-\-help" | |
382 | Show this help | |
383 | .TP | |
384 | .BR "\-\-list-options" | |
385 | Simple listing of options | |
386 | .TP | |
387 | .BR "\-s, \-\-session NAME" | |
388 | Apply on session name | |
389 | .TP | |
390 | .BR "\-k, \-\-kernel" | |
391 | Apply to the kernel tracer | |
392 | .TP | |
393 | .BR "\-u, \-\-userspace" | |
394 | Apply to the user-space tracer | |
395 | .TP | |
396 | .BR "\-\-discard" | |
397 | Discard event when subbuffers are full (default) | |
398 | .TP | |
399 | .BR "\-\-overwrite" | |
400 | Flight recorder mode : overwrites events when subbuffers are full | |
401 | .TP | |
402 | .BR "\-\-subbuf-size SIZE" | |
403 | Subbuffer size in bytes {+k,+M,+G}. | |
404 | (default UST uid: 131072, UST pid: 4096, kernel: 262144, metadata: 4096) | |
405 | Rounded up to the next power of 2. | |
406 | ||
407 | The minimum subbuffer size, for each tracer, is the max value between | |
408 | the default above and the system page size. You can issue this command | |
409 | to get the current page size on your system: \fB$ getconf PAGE_SIZE\fP | |
410 | .TP | |
411 | .BR "\-\-num-subbuf NUM" | |
412 | Number of subbuffers. (default UST uid: 4, UST pid: 4, kernel: 4, | |
413 | metadata: 2) Rounded up to the next power of 2. | |
414 | .TP | |
415 | .BR "\-\-switch-timer USEC" | |
416 | Switch subbuffer timer interval in µsec. | |
417 | (default UST uid: 0, UST pid: 0, kernel: 0, metadata: 0) | |
418 | .TP | |
419 | .BR "\-\-read-timer USEC" | |
420 | Read timer interval in µsec. | |
421 | (default UST uid: 0, UST pid: 0, kernel: 200000, metadata: 0) | |
422 | .TP | |
423 | .BR "\-\-output TYPE" | |
424 | Channel output type. Possible values: mmap, splice | |
425 | (default UST uid: mmap, UST pid: mmap, kernel: splice, metadata: mmap) | |
426 | .TP | |
427 | .BR "\-\-buffers-uid" | |
428 | Use per UID buffer (\-u only). Buffers are shared between applications | |
429 | that have the same UID. | |
430 | .TP | |
431 | .BR "\-\-buffers-pid" | |
432 | Use per PID buffer (\-u only). Each application has its own buffers. | |
433 | .TP | |
434 | .BR "\-\-buffers-global" | |
435 | Use shared buffer for the whole system (\-k only) | |
436 | .TP | |
437 | .BR "\-C, \-\-tracefile-size SIZE" | |
438 | Maximum size of each tracefile within a stream (in bytes). | |
439 | 0 means unlimited. (default: 0) | |
440 | .TP | |
441 | .BR "\-W, \-\-tracefile-count COUNT" | |
442 | Used in conjunction with \-C option, this will limit the number of files | |
443 | created to the specified count. 0 means unlimited. (default: 0) | |
1624d5b7 JD |
444 | |
445 | .B EXAMPLES: | |
446 | ||
05be3802 MD |
447 | .nf |
448 | $ lttng enable-channel -k -C 4096 -W 32 chan1 | |
449 | .fi | |
e256d661 | 450 | For each stream, the maximum size of each trace file will be 4096 bytes and |
cea28771 | 451 | there will be a maximum of 32 different files. The file count is appended after |
1624d5b7 JD |
452 | the stream number as seen in the following example. The last trace file is |
453 | smaller than 4096 since it was not completely filled. | |
454 | ||
05be3802 | 455 | .nf |
1624d5b7 JD |
456 | ~/lttng-traces/[...]/chan1_0_0 (4096) |
457 | ~/lttng-traces/[...]/chan1_0_1 (4096) | |
458 | ~/lttng-traces/[...]/chan1_0_2 (3245) | |
459 | ~/lttng-traces/[...]/chan1_1_0 (4096) | |
460 | ... | |
05be3802 | 461 | .fi |
1624d5b7 | 462 | |
05be3802 MD |
463 | .nf |
464 | $ lttng enable-channel -k -C 4096 | |
465 | .fi | |
1624d5b7 JD |
466 | This will create trace files of 4096 bytes and will create new ones as long as |
467 | there is data available. | |
05be3802 MD |
468 | .RE |
469 | .PP | |
6991b181 | 470 | |
6a240cd9 MD |
471 | .PP |
472 | \fBenable-event\fP NAME[,NAME2,...] [-k|-u] [OPTIONS] | |
473 | .RS | |
6991b181 DG |
474 | Enable tracing event |
475 | ||
c9e32613 | 476 | A tracing event is always assigned to a channel. If \fB\-c, \-\-channel\fP is |
6991b181 | 477 | omitted, a default channel named '\fBchannel0\fP' is created and the event is |
85076754 MD |
478 | added to it. If \fB\-c, \-\-channel\fP is omitted, but a non-default |
479 | channel already exists within the session, an error is returned. For the | |
480 | user-space tracer, using \fB\-a, \-\-all\fP is the same as using the | |
481 | wildcard "*". | |
6991b181 | 482 | |
c9e32613 | 483 | If \fB\-s, \-\-session\fP is omitted, the session name is taken from the .lttngrc |
6991b181 | 484 | file. |
6991b181 DG |
485 | |
486 | .B OPTIONS: | |
487 | ||
6a240cd9 MD |
488 | .TP |
489 | .BR "\-h, \-\-help" | |
490 | Show summary of possible options and commands. | |
491 | .TP | |
492 | .BR "\-\-list-options" | |
493 | Simple listing of options | |
494 | .TP | |
495 | .BR "\-s, \-\-session NAME" | |
496 | Apply on session name | |
497 | .TP | |
498 | .BR "\-c, \-\-channel NAME" | |
499 | Apply on channel name | |
500 | .TP | |
501 | .BR "\-a, \-\-all" | |
e256d661 | 502 | Enable all tracepoints and syscalls. This actually enables a single |
6a240cd9 MD |
503 | wildcard event "*". |
504 | .TP | |
505 | .BR "\-k, \-\-kernel" | |
506 | Apply for the kernel tracer | |
507 | .TP | |
508 | .BR "\-u, \-\-userspace" | |
509 | Apply for the user-space tracer | |
510 | .TP | |
bed69e7d DG |
511 | .BR "\-j, \-\-jul" |
512 | Apply for Java application using Java Util Logging interface (JUL) | |
513 | .TP | |
6a240cd9 | 514 | .BR "\-\-tracepoint" |
e256d661 | 515 | Tracepoint event (default). Userspace tracer supports wildcards at the end |
6a240cd9 MD |
516 | of string. Don't forget to quote to deal with bash expansion. |
517 | e.g.: | |
6991b181 | 518 | .nf |
6991b181 DG |
519 | "*" |
520 | "app_component:na*" | |
6991b181 | 521 | .fi |
6a240cd9 MD |
522 | .TP |
523 | .BR "\-\-loglevel NAME" | |
524 | Tracepoint loglevel range from 0 to loglevel. Listed in the help (\-h). | |
bc358d3e DG |
525 | For the JUL domain, the loglevel ranges are detailed with the \-\-help |
526 | option thus starting from SEVERE to FINEST. | |
6a240cd9 MD |
527 | .TP |
528 | .BR "\-\-loglevel-only NAME" | |
529 | Tracepoint loglevel (only this loglevel). | |
530 | The loglevel or loglevel-only options should be combined with a | |
531 | tracepoint name or tracepoint wildcard. | |
532 | .TP | |
533 | .BR "\-\-probe (addr | symbol | symbol+offset)" | |
534 | Dynamic probe. Addr and offset can be octal (0NNN...), decimal (NNN...) | |
535 | or hexadecimal (0xNNN...) | |
536 | .TP | |
537 | .BR "\-\-function (addr | symbol | symbol+offset)" | |
538 | Dynamic function entry/return probe. Addr and offset can be octal | |
539 | (0NNN...), decimal (NNN...) or hexadecimal (0xNNN...) | |
540 | .TP | |
541 | .BR "\-\-syscall" | |
542 | System call event. Enabling syscalls tracing (kernel tracer), you will | |
543 | not be able to disable them with disable-event. This is a known | |
544 | limitation. You can disable the entire channel to do the trick. | |
545 | .TP | |
546 | .BR "\-\-filter 'expression'" | |
547 | Set a filter on a newly enabled event. Filter expression on event | |
e256d661 JG |
548 | fields and context. The event will be recorded if the filter's |
549 | expression evaluates to TRUE. Only specify on first activation of a | |
550 | given event within a session. | |
551 | Specifying a filter is only allowed when enabling events within a session before | |
6a240cd9 MD |
552 | tracing is started. If the filter fails to link with the event |
553 | within the traced domain, the event will be discarded. | |
e256d661 | 554 | Filtering is currently only implemented for the user-space tracer. |
6a240cd9 MD |
555 | |
556 | Expression examples: | |
557 | ||
558 | .nf | |
559 | 'intfield > 500 && intfield < 503' | |
560 | '(strfield == "test" || intfield != 10) && intfield > 33' | |
561 | 'doublefield > 1.1 && intfield < 5.3' | |
562 | .fi | |
563 | ||
564 | Wildcards are allowed at the end of strings: | |
565 | 'seqfield1 == "te*"' | |
566 | In string literals, the escape character is a '\\'. Use '\\*' for | |
e256d661 JG |
567 | the '*' character, and '\\\\' for the '\\' character sequence. Wildcard |
568 | matches any sequence of characters, including an empty sub-string | |
569 | (matches 0 or more characters). | |
6a240cd9 | 570 | |
e256d661 JG |
571 | Context information can be used for filtering. The examples below shows |
572 | usage of context filtering on the process name (using a wildcard), process ID | |
573 | range, and unique thread ID. The process and thread IDs of | |
6a240cd9 MD |
574 | running applications can be found under columns "PID" and "LWP" of the |
575 | "ps -eLf" command. | |
576 | ||
577 | .nf | |
578 | '$ctx.procname == "demo*"' | |
579 | '$ctx.vpid >= 4433 && $ctx.vpid < 4455' | |
580 | '$ctx.vtid == 1234' | |
581 | .fi | |
582 | ||
2ff2da66 DG |
583 | Context information is available to all filters whether or not the add-context |
584 | command has been used to add it to the event's channel, as long as the context | |
585 | field exists for that domain. For example, the filter examples given above will | |
586 | never fail to link: no add-context is required for the event's channel. | |
587 | ||
bccd20a3 JI |
588 | .TP |
589 | .BR "\-x, \-\-exclude LIST" | |
590 | Add exclusions to UST tracepoints: | |
591 | Events that match any of the items in the comma-separated LIST are not | |
592 | enabled, even if they match a wildcard definition of the event. | |
593 | ||
594 | This option is also applicable with the \fB\-a, \-\-all\fP option, | |
595 | in which case all UST tracepoints are enabled except the ones whose | |
596 | names match any of the items in LIST. | |
6a240cd9 MD |
597 | .RE |
598 | .PP | |
6991b181 | 599 | |
272c6a17 MD |
600 | .PP |
601 | \fBdisable-channel\fP NAME[,NAME2,...] (\-k | \-u) [OPTIONS] | |
602 | .RS | |
6991b181 DG |
603 | Disable tracing channel |
604 | ||
e256d661 JG |
605 | Disabling a channel disables the tracing of all of the channel's events. A channel |
606 | can be reenabled by calling \fBlttng enable-channel NAME\fP again. | |
6991b181 | 607 | |
c9e32613 | 608 | If \fB\-s, \-\-session\fP is omitted, the session name is taken from the .lttngrc |
6991b181 | 609 | file. |
6991b181 DG |
610 | |
611 | .B OPTIONS: | |
612 | ||
272c6a17 MD |
613 | .TP |
614 | .BR "\-h, \-\-help" | |
615 | Show summary of possible options and commands. | |
616 | .TP | |
617 | .BR "\-\-list-options" | |
618 | Simple listing of options | |
619 | .TP | |
620 | .BR "\-s, \-\-session NAME" | |
621 | Apply on session name | |
622 | .TP | |
623 | .BR "\-k, \-\-kernel" | |
624 | Apply for the kernel tracer | |
625 | .TP | |
626 | .BR "\-u, \-\-userspace" | |
627 | Apply for the user-space tracer | |
628 | .RE | |
629 | .PP | |
6991b181 | 630 | |
c138a39b MD |
631 | .PP |
632 | \fBdisable-event\fP NAME[,NAME2,...] (\-k | \-u) [OPTIONS] | |
633 | .RS | |
6991b181 DG |
634 | Disable tracing event |
635 | ||
636 | The event, once disabled, can be re-enabled by calling \fBlttng enable-event | |
637 | NAME\fP again. | |
638 | ||
c9e32613 | 639 | If \fB\-s, \-\-session\fP is omitted, the session name is taken from the .lttngrc |
6991b181 | 640 | file. |
6991b181 | 641 | |
85076754 MD |
642 | If \fB\-c, \-\-channel\fP is omitted, the default channel name is used. |
643 | If \fB\-c, \-\-channel\fP is omitted, but a non-default channel already | |
644 | exists within the session, an error is returned. | |
645 | ||
6991b181 DG |
646 | .B OPTIONS: |
647 | ||
c138a39b MD |
648 | .TP |
649 | .BR "\-h, \-\-help" | |
650 | Show summary of possible options and commands. | |
651 | .TP | |
652 | .BR "\-\-list-options" | |
653 | Simple listing of options | |
654 | .TP | |
655 | .BR "\-s, \-\-session NAME" | |
656 | Apply on session name | |
657 | .TP | |
85076754 MD |
658 | .BR "\-c, \-\-channel NAME" |
659 | Apply on channel name | |
660 | .TP | |
c138a39b MD |
661 | .BR "\-a, \-\-all-events" |
662 | Disable all events. This does NOT disable "*" but rather every known | |
663 | events of the session. | |
664 | .TP | |
665 | .BR "\-k, \-\-kernel" | |
666 | Apply for the kernel tracer | |
667 | .TP | |
668 | .BR "\-u, \-\-userspace" | |
669 | Apply for the user-space tracer | |
bed69e7d DG |
670 | .TP |
671 | .BR "\-j, \-\-jul" | |
672 | Apply for Java application using Java Util Logging interface (JUL) | |
c138a39b MD |
673 | .RE |
674 | .PP | |
6991b181 | 675 | |
747361fe MD |
676 | .PP |
677 | \fBlist\fP [OPTIONS] [SESSION [SESSION OPTIONS]] | |
678 | .RS | |
c9e32613 | 679 | List tracing session information. |
6991b181 DG |
680 | |
681 | With no arguments, it will list available tracing session(s). | |
682 | ||
fa072eae YB |
683 | With the session name, it will display the details of the session including |
684 | the trace file path, the associated channels and their state (activated | |
d829b38c | 685 | and deactivated), the activated events and more. |
fa072eae | 686 | |
c9e32613 | 687 | With \-k alone, it will list all available kernel events (except the system |
6991b181 | 688 | calls events). |
bed69e7d DG |
689 | With \-j alone, the available JUL event from registered application will be |
690 | list. The event corresponds to the Logger name in the Java JUL application. | |
c9e32613 DG |
691 | With \-u alone, it will list all available user-space events from registered |
692 | applications. Here is an example of 'lttng list \-u': | |
6991b181 | 693 | |
747361fe | 694 | .nf |
6991b181 DG |
695 | PID: 7448 - Name: /tmp/lttng-ust/tests/hello/.libs/lt-hello |
696 | ust_tests_hello:tptest_sighandler (type: tracepoint) | |
697 | ust_tests_hello:tptest (type: tracepoint) | |
747361fe | 698 | .fi |
6991b181 DG |
699 | |
700 | You can now enable any event listed by using the name : | |
701 | \fBust_tests_hello:tptest\fP. | |
6991b181 DG |
702 | |
703 | .B OPTIONS: | |
704 | ||
747361fe MD |
705 | .TP |
706 | .BR "\-h, \-\-help" | |
707 | Show summary of possible options and commands. | |
708 | .TP | |
709 | .BR "\-\-list-options" | |
710 | Simple listing of options | |
711 | .TP | |
712 | .BR "\-k, \-\-kernel" | |
713 | Select kernel domain | |
714 | .TP | |
715 | .BR "\-u, \-\-userspace" | |
716 | Select user-space domain. | |
bed69e7d DG |
717 | .TP |
718 | .BR "\-j, \-\-jul" | |
719 | Apply for Java application using JUL | |
720 | .TP | |
721 | .BR "\-f, \-\-fields" | |
722 | List event fields | |
6991b181 | 723 | |
747361fe | 724 | .PP |
6b8f2e64 DG |
725 | .B SESSION OPTIONS: |
726 | ||
747361fe MD |
727 | .TP |
728 | .BR "\-c, \-\-channel NAME" | |
729 | List details of a channel | |
730 | .TP | |
731 | .BR "\-d, \-\-domain" | |
732 | List available domain(s) | |
733 | .RE | |
734 | .PP | |
6991b181 | 735 | |
7c96a096 MD |
736 | .PP |
737 | \fBset-session\fP NAME [OPTIONS] | |
738 | .RS | |
6991b181 DG |
739 | Set current session name |
740 | ||
741 | Will change the session name in the .lttngrc file. | |
6991b181 DG |
742 | |
743 | .B OPTIONS: | |
744 | ||
7c96a096 MD |
745 | .TP |
746 | .BR "\-h, \-\-help" | |
747 | Show summary of possible options and commands. | |
748 | .TP | |
749 | .BR "\-\-list-options" | |
750 | Simple listing of options | |
751 | .RE | |
752 | .PP | |
6991b181 | 753 | |
8df3bfe9 MD |
754 | .PP |
755 | \fBsnapshot\fP [OPTIONS] ACTION | |
756 | .RS | |
b872baea | 757 | Snapshot command for LTTng session. |
b872baea DG |
758 | |
759 | .B OPTIONS: | |
760 | ||
8df3bfe9 MD |
761 | .TP |
762 | .BR "\-h, \-\-help" | |
763 | Show summary of possible options and commands. | |
764 | .TP | |
765 | .BR "\-\-list-options" | |
766 | Simple listing of options | |
b872baea | 767 | |
8df3bfe9 | 768 | .PP |
b872baea DG |
769 | .B ACTION: |
770 | ||
8df3bfe9 | 771 | .TP |
b872baea DG |
772 | \fBadd-output\fP [-m <SIZE>] [-s <NAME>] [-n <NAME>] <URL> | -C <URL> -D <URL> |
773 | ||
774 | Setup and add an snapshot output for a session. Output are the destination | |
775 | where the snapshot will be sent. Only one output is permitted. To change it, | |
776 | you'll need to delete it and add back the new one. | |
777 | ||
8df3bfe9 | 778 | .TP |
b872baea DG |
779 | \fBdel-output\fP ID | NAME [-s <NAME>] |
780 | ||
781 | Delete an output for a session using the ID. You can either specify the | |
782 | output's ID that can be found with list-output or the name. | |
783 | ||
8df3bfe9 | 784 | .TP |
b872baea DG |
785 | \fBlist-output\fP [-s <NAME>] |
786 | ||
787 | List the output of a session. Attributes of the output are printed. | |
788 | ||
8df3bfe9 | 789 | .TP |
b872baea DG |
790 | \fBrecord\fP [-m <SIZE>] [-s <NAME>] [-n <NAME>] [<URL> | -C <URL> -D <URL>] |
791 | ||
792 | Snapshot a session's buffer(s) for all domains. If an URL is specified, it is | |
793 | used instead of a previously added output. Specifying only a name or/and a max | |
794 | size will override the current output values. For instance, you can record a | |
795 | snapshot with a custom maximum size or with a different name. | |
796 | ||
8df3bfe9 | 797 | .nf |
1ac1098f | 798 | $ lttng snapshot add-output -n mysnapshot file:///data/snapshot |
b872baea DG |
799 | [...] |
800 | $ lttng snapshot record -n new_name_snapshot | |
8df3bfe9 | 801 | .fi |
b872baea DG |
802 | |
803 | The above will create a snapshot in /data/snapshot/new_name_snapshot* directory | |
804 | rather then in mysnapshot*/ | |
b872baea | 805 | |
8df3bfe9 MD |
806 | .PP |
807 | .B DETAILED ACTION OPTIONS | |
b872baea | 808 | |
8df3bfe9 MD |
809 | .TP |
810 | .BR "\-s, \-\-session NAME" | |
811 | Apply to session name. | |
812 | .TP | |
813 | .BR "\-n, \-\-name NAME" | |
814 | Name of the snapshot's output. | |
815 | .TP | |
816 | .BR "\-m, \-\-max-size SIZE" | |
a8f307d8 SM |
817 | Maximum size in bytes of the snapshot. The maxium size does not include the |
818 | metadata file. Human readable format is accepted: {+k,+M,+G}. For instance, | |
819 | \-\-max-size 5M | |
8df3bfe9 MD |
820 | .TP |
821 | .BR "\-C, \-\-ctrl-url URL" | |
822 | Set control path URL. (Must use -D also) | |
823 | .TP | |
824 | .BR "\-D, \-\-data-url URL" | |
825 | Set data path URL. (Must use -C also) | |
826 | .RE | |
827 | .PP | |
b872baea | 828 | |
afb8ca1b MD |
829 | .PP |
830 | \fBstart\fP [NAME] [OPTIONS] | |
831 | .RS | |
6991b181 DG |
832 | Start tracing |
833 | ||
834 | It will start tracing for all tracers for a specific tracing session. | |
6991b181 | 835 | If NAME is omitted, the session name is taken from the .lttngrc file. |
6991b181 DG |
836 | |
837 | .B OPTIONS: | |
838 | ||
afb8ca1b MD |
839 | .TP |
840 | .BR "\-h, \-\-help" | |
841 | Show summary of possible options and commands. | |
842 | .TP | |
843 | .BR "\-\-list-options" | |
844 | Simple listing of options | |
845 | .RE | |
846 | .PP | |
6991b181 | 847 | |
6c09bfdb MD |
848 | .PP |
849 | \fBstop\fP [NAME] [OPTIONS] | |
850 | .RS | |
6991b181 DG |
851 | Stop tracing |
852 | ||
391b9c72 DG |
853 | It will stop tracing for all tracers for a specific tracing session. Before |
854 | returning, the command checks for data availability meaning that it will wait | |
855 | until the trace is readable for the session. Use \-\-no-wait to avoid this | |
856 | behavior. | |
6991b181 DG |
857 | |
858 | If NAME is omitted, the session name is taken from the .lttngrc file. | |
6991b181 DG |
859 | |
860 | .B OPTIONS: | |
861 | ||
6c09bfdb MD |
862 | .TP |
863 | .BR "\-h, \-\-help" | |
864 | Show summary of possible options and commands. | |
865 | .TP | |
866 | .BR "\-\-list-options" | |
867 | Simple listing of options | |
c866bd4f MJ |
868 | .TP |
869 | .BR "\-\-no-wait" | |
6c09bfdb MD |
870 | Don't wait for data availability. |
871 | .RE | |
872 | .PP | |
6991b181 | 873 | |
5975c30a MD |
874 | .PP |
875 | \fBversion\fP | |
876 | .RS | |
6991b181 | 877 | Show version information |
6991b181 DG |
878 | |
879 | .B OPTIONS: | |
880 | ||
5975c30a MD |
881 | .TP |
882 | .BR "\-h, \-\-help" | |
883 | Show summary of possible options and commands. | |
884 | .TP | |
885 | .BR "\-\-list-options" | |
886 | Simple listing of options | |
887 | .RE | |
888 | .PP | |
6991b181 | 889 | |
5b4c1410 MD |
890 | .PP |
891 | \fBview\fP [SESSION_NAME] [OPTIONS] | |
892 | .RS | |
893 | View traces of a tracing session. By default, the babeltrace viewer | |
894 | will be used for text viewing. If SESSION_NAME is omitted, the session | |
895 | name is taken from the .lttngrc file. | |
6991b181 DG |
896 | |
897 | .B OPTIONS: | |
898 | ||
5b4c1410 MD |
899 | .TP |
900 | .BR "\-h, \-\-help" | |
901 | Show this help | |
902 | .TP | |
903 | .BR "\-\-list-options" | |
904 | Simple listing of options | |
905 | .TP | |
906 | .BR "\-t, \-\-trace-path PATH" | |
907 | Trace directory path for the viewer | |
908 | .TP | |
909 | .BR "\-e, \-\-viewer CMD" | |
910 | Specify viewer and/or options to use This will completely override the | |
911 | default viewers so please make sure to specify the full command. The | |
912 | trace directory path of the session will be appended at the end to the | |
913 | arguments | |
914 | .RE | |
915 | .PP | |
6991b181 | 916 | |
278eefc8 DG |
917 | .SH "JUL DOMAIN" |
918 | This section explains the JUL domain (\-j, \-\-jul) where JUL stands for Java | |
919 | Util Logging. You can use that feature by using the \fBliblttng-ust-jul.so\fP | |
920 | from the lttng-ust(3) project. | |
921 | ||
922 | The LTTng Java Agent uses JNI to link the UST tracer to the Java application | |
923 | that uses the agent. Thus, it behaves similarly to the UST domain (\-u). When | |
924 | enabling events with the JUL domain, you enable a Logger name that will then be | |
925 | mapped to a default UST tracepoint called \fBlttng_jul:jul_event\fP in the | |
926 | \fBlttng_jul_channel\fP. Using the lttng-ctl API, any JUL events must use the | |
927 | tracepoint event type (same as \-\-tracepoint). | |
928 | ||
929 | Because of the default immutable channel (\fBlttng_jul_channel\fP), the | |
930 | \fBenable-channel\fP command CAN NOT be used with the JUL domain thus not | |
931 | having any \-j option. | |
932 | ||
933 | For JUL event, loglevels are supported with the JUL ABI values. Use \fBlttng | |
934 | enable-event \-h\fP to list them. Wildcards are NOT supported except the "*" | |
935 | meaning all events (same as \-a). | |
936 | ||
937 | Exactly like the UST domain, if the Java application has the same UID as you, | |
938 | you can trace it. Same goes for the tracing group accessing root applications. | |
939 | ||
940 | Finally, you can list every Logger name that are available from JUL registered | |
941 | applications to the session daemon by using \fBlttng list \-j\fP. | |
942 | ||
943 | Here is an example on how to use this domain. | |
944 | ||
945 | .nf | |
946 | $ lttng list -j | |
947 | [...] | |
948 | $ lttng create aSession | |
949 | $ lttng enable-event -s aSession -j MyCustomLoggerName | |
950 | $ lttng start | |
951 | .fi | |
952 | ||
953 | More information can be found in the lttng-ust documentation, see | |
954 | java-util-logging.txt | |
955 | .PP | |
956 | ||
c206d957 | 957 | .SH "EXIT VALUES" |
b107a0b1 | 958 | .PP |
6b8f2e64 DG |
959 | On success 0 is returned and a positive value on error. Value of 1 means a command |
960 | error, 2 an undefined command, 3 a fatal error and 4 a command warning meaning that | |
961 | something went wrong during the command. | |
c206d957 | 962 | |
6b8f2e64 | 963 | Any other value above 10, please refer to |
b107a0b1 | 964 | .BR "<lttng/lttng-error.h>" |
6b8f2e64 DG |
965 | for a detailed list or use lttng_strerror() to get a human readable string of |
966 | the error code. | |
c206d957 | 967 | .PP |
b107a0b1 | 968 | |
6991b181 DG |
969 | .SH "ENVIRONMENT VARIABLES" |
970 | ||
971 | .PP | |
972 | Note that all command line options override environment variables. | |
973 | .PP | |
974 | ||
975 | .PP | |
05833633 | 976 | .IP "LTTNG_SESSIOND_PATH" |
c9e32613 DG |
977 | Allows one to specify the full session daemon binary path to lttng command line |
978 | tool. You can also use \-\-sessiond-path option having the same effect. | |
b107a0b1 MD |
979 | .PP |
980 | ||
6991b181 | 981 | .SH "SEE ALSO" |
6b8f2e64 DG |
982 | .BR babeltrace(1), |
983 | .BR lttng-ust(3), | |
984 | .BR lttng-sessiond(8), | |
985 | .BR lttng-relayd(8), | |
b107a0b1 | 986 | |
6991b181 DG |
987 | .SH "BUGS" |
988 | ||
b107a0b1 | 989 | .PP |
6991b181 | 990 | If you encounter any issues or usability problem, please report it on our |
6b8f2e64 DG |
991 | mailing list <lttng-dev@lists.lttng.org> to help improve this project or |
992 | at https://bugs.lttng.org which is a bugtracker. | |
b107a0b1 MD |
993 | .PP |
994 | ||
6991b181 DG |
995 | .SH "CREDITS" |
996 | ||
997 | .PP | |
c9e32613 | 998 | lttng is distributed under the GNU General Public License version 2. See the file |
6991b181 DG |
999 | COPYING for details. |
1000 | .PP | |
1001 | A Web site is available at http://lttng.org for more information on the LTTng | |
1002 | project. | |
1003 | .PP | |
1004 | You can also find our git tree at http://git.lttng.org. | |
1005 | .PP | |
1006 | Mailing lists for support and development: <lttng-dev@lists.lttng.org>. | |
1007 | .PP | |
1008 | You can find us on IRC server irc.oftc.net (OFTC) in #lttng. | |
1009 | .PP | |
1010 | .SH "THANKS" | |
1011 | ||
1012 | .PP | |
1013 | Thanks to Yannick Brosseau without whom this project would never have been so | |
1014 | lean and mean! Also thanks to the Ericsson teams working on tracing which | |
fa072eae | 1015 | helped us greatly with detailed bug reports and unusual test cases. |
6991b181 DG |
1016 | |
1017 | Thanks to our beloved packager Alexandre Montplaisir-Goncalves (Ubuntu and PPA | |
1018 | maintainer) and Jon Bernard for our Debian packages. | |
1019 | ||
1020 | Special thanks to Michel Dagenais and the DORSAL laboratory at Polytechnique de | |
1021 | Montreal for the LTTng journey. | |
c9e32613 | 1022 | .PP |
6991b181 DG |
1023 | .SH "AUTHORS" |
1024 | ||
1025 | .PP | |
1026 | lttng-tools was originally written by Mathieu Desnoyers, Julien Desfossez and | |
1027 | David Goulet. More people have since contributed to it. It is currently | |
1028 | maintained by David Goulet <dgoulet@efficios.com>. | |
1029 | .PP |