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