Commit | Line | Data |
---|---|---|
391b9c72 | 1 | .TH "LTTNG" "1" "December 3rd, 2012" "" "" |
6991b181 DG |
2 | |
3 | .SH "NAME" | |
391b9c72 | 4 | lttng \(em LTTng 2.1.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 | ||
85 | .TP | |
86 | \fBadd-context\fP | |
87 | .nf | |
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 | ||
c9e32613 | 99 | # lttng add-context \-k \-t prio \-t perf:branch-misses \-t perf:cache-misses |
6991b181 | 100 | |
c9e32613 | 101 | Please take a look at the help (\-h/\-\-help) for a detailed list of available |
6991b181 DG |
102 | contexts. |
103 | ||
391b9c72 DG |
104 | If no channel is given (\-c), the context is added to all channels. Otherwise |
105 | the context will be added only to the given channel (\-c). | |
6991b181 | 106 | |
c9e32613 | 107 | If \fB\-s, \-\-session\fP is omitted, the session name is taken from the .lttngrc |
6991b181 DG |
108 | file. |
109 | .fi | |
110 | ||
111 | .B OPTIONS: | |
112 | ||
113 | .nf | |
c9e32613 | 114 | \-h, \-\-help |
6991b181 | 115 | Show summary of possible options and commands. |
c9e32613 | 116 | \-s, \-\-session NAME |
6991b181 | 117 | Apply on session name. |
c9e32613 | 118 | \-c, \-\-channel NAME |
6991b181 | 119 | Apply on channel name. |
c9e32613 | 120 | \-k, \-\-kernel |
6991b181 | 121 | Apply for the kernel tracer |
c9e32613 | 122 | \-u, \-\-userspace |
6991b181 | 123 | Apply for the user-space tracer |
c9e32613 | 124 | \-t, \-\-type TYPE |
6991b181 | 125 | Context type. You can repeat this option on the command line. Please |
c9e32613 | 126 | use "lttng add-context \-h" to list all available types. |
6991b181 DG |
127 | .fi |
128 | ||
129 | .IP | |
130 | ||
131 | .IP "\fBcalibrate\fP" | |
132 | .nf | |
133 | Quantify LTTng overhead | |
134 | ||
135 | The LTTng calibrate command can be used to find out the combined average | |
136 | overhead of the LTTng tracer and the instrumentation mechanisms used. This | |
137 | overhead can be calibrated in terms of time or using any of the PMU performance | |
138 | counter available on the system. | |
139 | ||
140 | For now, the only calibration implemented is that of the kernel function | |
141 | instrumentation (kretprobes). | |
142 | ||
143 | * Calibrate kernel function instrumentation | |
144 | ||
145 | Let's use an example to show this calibration. We use an i7 processor with 4 | |
146 | general-purpose PMU registers. This information is available by issuing dmesg, | |
147 | looking for "generic registers". | |
148 | ||
149 | This sequence of commands will gather a trace executing a kretprobe hooked on | |
150 | an empty function, gathering PMU counters LLC (Last Level Cache) misses | |
c9e32613 | 151 | information (see lttng add-context \-\-help to see the list of available PMU |
6991b181 DG |
152 | counters). |
153 | ||
154 | # lttng create calibrate-function | |
c9e32613 DG |
155 | # lttng enable-event calibrate \-\-kernel \-\-function lttng_calibrate_kretprobe |
156 | # lttng add-context \-\-kernel \-t perf:LLC-load-misses \-t perf:LLC-store-misses \\ | |
157 | \-t perf:LLC-prefetch-misses | |
6991b181 DG |
158 | # lttng start |
159 | # for a in $(seq 1 10); do \\ | |
c9e32613 | 160 | lttng calibrate \-\-kernel \-\-function; |
6991b181 DG |
161 | done |
162 | # lttng destroy | |
c9e32613 | 163 | # babeltrace $(ls \-1drt ~/lttng-traces/calibrate-function-* | tail \-n 1) |
6991b181 DG |
164 | |
165 | The output from babeltrace can be saved to a text file and opened in a | |
166 | spreadsheet (e.g. oocalc) to focus on the per-PMU counter delta between | |
167 | consecutive "calibrate_entry" and "calibrate_return" events. Note that these | |
168 | counters are per-CPU, so scheduling events would need to be present to account | |
169 | for migration between CPU. Therefore, for calibration purposes, only events | |
170 | staying on the same CPU must be considered. | |
171 | ||
172 | The average result, for the i7, on 10 samples: | |
173 | ||
174 | Average Std.Dev. | |
175 | perf_LLC_load_misses: 5.0 0.577 | |
176 | perf_LLC_store_misses: 1.6 0.516 | |
177 | perf_LLC_prefetch_misses: 9.0 14.742 | |
178 | ||
179 | As we can notice, the load and store misses are relatively stable across runs | |
180 | (their standard deviation is relatively low) compared to the prefetch misses. | |
181 | We can conclude from this information that LLC load and store misses can be | |
182 | accounted for quite precisely, but prefetches within a function seems to behave | |
183 | too erratically (not much causality link between the code executed and the CPU | |
184 | prefetch activity) to be accounted for. | |
185 | .fi | |
186 | ||
187 | .B OPTIONS: | |
188 | ||
189 | .nf | |
c9e32613 | 190 | \-h, \-\-help |
6991b181 | 191 | Show summary of possible options and commands. |
c9e32613 | 192 | \-k, \-\-kernel |
6991b181 | 193 | Apply for the kernel tracer |
c9e32613 | 194 | \-u, \-\-userspace |
6991b181 | 195 | Apply for the user-space tracer |
c9e32613 | 196 | \-\-function |
6991b181 DG |
197 | Dynamic function entry/return probe (default) |
198 | .fi | |
199 | ||
200 | .IP | |
201 | ||
6b8f2e64 | 202 | .IP "\fBcreate\fP [NAME] [OPTIONS] |
6991b181 DG |
203 | .nf |
204 | Create tracing session. | |
205 | ||
206 | A tracing session contains channel(s) which contains event(s). It is domain | |
207 | agnostic meaning that you can enable channels and events for either the | |
208 | user-space tracer and/or the kernel tracer. It acts like a container | |
209 | aggregating multiple tracing sources. | |
210 | ||
211 | On creation, a \fB.lttngrc\fP file is created in your $HOME directory | |
212 | containing the current session name. If NAME is omitted, a session name is | |
fa072eae | 213 | automatically created having this form: 'auto-yyyymmdd-hhmmss'. |
6991b181 | 214 | |
c9e32613 | 215 | If no \fB\-o, \-\-output\fP is specified, the traces will be written in |
6991b181 DG |
216 | $HOME/lttng-traces. |
217 | .fi | |
218 | ||
219 | .B OPTIONS: | |
220 | ||
221 | .nf | |
c9e32613 | 222 | \-h, \-\-help |
6991b181 | 223 | Show summary of possible options and commands. |
c9e32613 | 224 | \-\-list-options |
6991b181 | 225 | Simple listing of options |
c9e32613 | 226 | \-o, \-\-output PATH |
6991b181 | 227 | Specify output path for traces |
6b8f2e64 DG |
228 | |
229 | Using these options, each API call can be controlled individually. For | |
230 | instance, \-C does not enable the consumer automatically. You'll need the \-e | |
231 | option for that. | |
232 | ||
23d14dff | 233 | \-U, \-\-set-url=URL |
785d2d0d | 234 | Set URL for the consumer output destination. It is persistent for the |
6b8f2e64 DG |
235 | session lifetime. Redo the command to change it. This will set both |
236 | data and control URL for network. | |
237 | \-C, \-\-ctrl-url=URL | |
238 | Set control path URL. (Must use -D also) | |
239 | \-D, \-\-data-url=URL | |
240 | Set data path URL. (Must use -C also) | |
6b8f2e64 | 241 | |
785d2d0d DG |
242 | .B URL FORMAT: |
243 | ||
244 | proto://[HOST|IP][:PORT1[:PORT2]][/TRACE_PATH] | |
245 | ||
246 | Supported protocols are (proto): | |
247 | > file://... | |
248 | Local filesystem full path. | |
249 | ||
250 | > net://... | |
251 | This will use the default network transport layer which is TCP for both | |
252 | control (PORT1) and data port (PORT2). The default ports are | |
253 | respectively 5342 and 5343. Note that net[6]:// is not yet supported. | |
254 | ||
255 | > tcp[6]://... | |
256 | Can only be used with -C and -D together | |
257 | ||
258 | NOTE: IPv6 address MUST be enclosed in brackets '[]' (rfc2732) | |
6b8f2e64 DG |
259 | |
260 | .B EXAMPLES: | |
261 | ||
262 | # lttng create -U net://192.168.1.42 | |
263 | Uses TCP and default ports for the given destination. | |
264 | ||
265 | # lttng create -U net6://[fe80::f66d:4ff:fe53:d220] | |
266 | Uses TCP, default ports and IPv6. | |
267 | ||
268 | # lttng create s1 -U net://myhost.com:3229 | |
269 | Create session s1 and set its consumer to myhost.com on port 3229 for control. | |
6991b181 DG |
270 | .fi |
271 | ||
272 | .IP | |
273 | ||
274 | .IP "\fBdestroy\fP [OPTIONS] [NAME]" | |
275 | .nf | |
276 | Teardown tracing session | |
277 | ||
278 | Free memory on the session daemon and tracer side. It's gone! | |
279 | ||
280 | If NAME is omitted, the session name is taken from the .lttngrc file. | |
281 | .fi | |
282 | ||
283 | .B OPTIONS: | |
284 | ||
285 | .nf | |
c9e32613 | 286 | \-h, \-\-help |
6991b181 | 287 | Show summary of possible options and commands. |
a3c5b534 FG |
288 | \-a, \-\-all |
289 | Destroy all sessions | |
c9e32613 | 290 | \-\-list-options |
6991b181 DG |
291 | Simple listing of options |
292 | .fi | |
293 | ||
294 | .IP | |
295 | ||
296 | .IP "\fBenable-channel\fP NAME[,NAME2,...] [-k|-u] [OPTIONS]" | |
297 | .nf | |
298 | Enable tracing channel | |
299 | ||
004f3466 DG |
300 | To enable an event, you must enable both the event and the channel that |
301 | contains it. | |
b883c01b | 302 | |
c9e32613 | 303 | If \fB\-s, \-\-session\fP is omitted, the session name is taken from the .lttngrc |
6991b181 | 304 | file. |
7972aab2 DG |
305 | |
306 | It is important to note that if a certain type of buffers is used, the session | |
307 | will be set with that type and all other subsequent channel need to have the | |
308 | same type. | |
6991b181 DG |
309 | .fi |
310 | ||
311 | .B OPTIONS: | |
312 | ||
313 | .nf | |
c9e32613 | 314 | \-h, \-\-help |
6991b181 | 315 | Show this help |
c9e32613 | 316 | \-\-list-options |
6991b181 | 317 | Simple listing of options |
391b9c72 | 318 | \-s, \-\-session NAME |
6991b181 | 319 | Apply on session name |
c9e32613 | 320 | \-k, \-\-kernel |
6991b181 | 321 | Apply to the kernel tracer |
c9e32613 | 322 | \-u, \-\-userspace |
6991b181 DG |
323 | Apply to the user-space tracer |
324 | ||
c9e32613 | 325 | \-\-discard |
6991b181 | 326 | Discard event when subbuffers are full (default) |
c9e32613 | 327 | \-\-overwrite |
6991b181 | 328 | Flight recorder mode : overwrites events when subbuffers are full |
391b9c72 | 329 | \-\-subbuf-size SIZE |
6991b181 | 330 | Subbuffer size in bytes (default: 4096, kernel default: 262144) |
004f3466 | 331 | Needs to be a power of 2 for both tracers |
391b9c72 | 332 | \-\-num-subbuf NUM |
d829b38c | 333 | Number of subbuffers (default: 4) |
004f3466 | 334 | Needs to be a power of 2 for both tracers |
391b9c72 | 335 | \-\-switch-timer USEC |
004f3466 | 336 | Switch subbuffer timer interval in µsec (default: 0) |
391b9c72 | 337 | \-\-read-timer USEC |
004f3466 | 338 | Read timer interval in µsec (default: 200) |
391b9c72 DG |
339 | \-\-output TYPE |
340 | Channel output type. Possible values: mmap, splice | |
7972aab2 DG |
341 | \-\-buffers-uid |
342 | Use per UID buffer (\-u only). Buffers are shared between applications | |
343 | that have the same UID. | |
344 | \-\-buffers-pid | |
345 | Use per PID buffer (\-u only). Each application has its own buffers. | |
346 | \-\-buffers-global | |
347 | Use shared buffer for the whole system (\-k only) | |
6991b181 DG |
348 | .fi |
349 | ||
350 | .IP | |
351 | ||
352 | .IP "\fBenable-event\fP NAME[,NAME2,...] [-k|-u] [OPTIONS]" | |
353 | .nf | |
354 | Enable tracing event | |
355 | ||
c9e32613 | 356 | A tracing event is always assigned to a channel. If \fB\-c, \-\-channel\fP is |
6991b181 | 357 | omitted, a default channel named '\fBchannel0\fP' is created and the event is |
c9e32613 | 358 | added to it. For the user-space tracer, using \fB\-a, \-\-all\fP is the same as |
6991b181 DG |
359 | using the wildcard "*". |
360 | ||
c9e32613 | 361 | If \fB\-s, \-\-session\fP is omitted, the session name is taken from the .lttngrc |
6991b181 DG |
362 | file. |
363 | .fi | |
364 | ||
365 | .B OPTIONS: | |
366 | ||
367 | .nf | |
c9e32613 | 368 | \-h, \-\-help |
6991b181 | 369 | Show summary of possible options and commands. |
c9e32613 | 370 | \-\-list-options |
6991b181 | 371 | Simple listing of options |
391b9c72 | 372 | \-s, \-\-session NAME |
6991b181 | 373 | Apply on session name |
391b9c72 | 374 | \-c, \-\-channel NAME |
6991b181 | 375 | Apply on channel name |
c9e32613 | 376 | \-a, \-\-all |
c5650942 DG |
377 | Enable all tracepoints and syscalls. This actually enable a single |
378 | wildcard event "*". | |
c9e32613 | 379 | \-k, \-\-kernel |
6991b181 | 380 | Apply for the kernel tracer |
c9e32613 | 381 | \-u, \-\-userspace |
6991b181 DG |
382 | Apply for the user-space tracer |
383 | ||
c9e32613 | 384 | \-\-tracepoint |
6991b181 DG |
385 | Tracepoint event (default) |
386 | - userspace tracer supports wildcards at end of string. Don't forget to | |
387 | quote to deal with bash expansion. | |
388 | e.g.: | |
389 | "*" | |
390 | "app_component:na*" | |
391b9c72 DG |
391 | \-\-loglevel NAME |
392 | Tracepoint loglevel range from 0 to loglevel. Listed in the help (\-h). | |
393 | \-\-loglevel-only NAME | |
394 | Tracepoint loglevel (only this loglevel). | |
395 | ||
396 | The loglevel or loglevel-only options should be combined with a | |
397 | tracepoint name or tracepoint wildcard. | |
c9e32613 | 398 | \-\-probe [addr | symbol | symbol+offset] |
6991b181 DG |
399 | Dynamic probe. Addr and offset can be octal (0NNN...), decimal (NNN...) |
400 | or hexadecimal (0xNNN...) | |
c9e32613 | 401 | \-\-function [addr | symbol | symbol+offset] |
6991b181 DG |
402 | Dynamic function entry/return probe. Addr and offset can be octal |
403 | (0NNN...), decimal (NNN...) or hexadecimal (0xNNN...) | |
c9e32613 | 404 | \-\-syscall |
6b8f2e64 DG |
405 | System call event. Enabling syscalls tracing (kernel tracer), you will |
406 | not be able to disable them with disable-event. This is a known | |
407 | limitation. You can disable the entire channel to do the trick. | |
9bd578f5 | 408 | |
919e300c | 409 | \-\-filter 'expression' |
6b8f2e64 | 410 | Set a filter on a newly enabled event. Filter expression on event |
ee8ccafa MD |
411 | fields and context. Event recording depends on evaluation. Only |
412 | specify on first activation of a given event within a session. | |
413 | Filter only allowed when enabling events within a session before | |
414 | tracing is started. If the filter fails to link with the event | |
415 | within the traced domain, the event will be discarded. | |
416 | Currently, filter is only implemented for the user-space tracer. | |
6b8f2e64 DG |
417 | |
418 | Expression examples: | |
419 | ||
420 | 'intfield > 500 && intfield < 503' | |
421 | '(stringfield == "test" || intfield != 10) && intfield > 33' | |
422 | 'doublefield > 1.1 && intfield < 5.3' | |
423 | ||
424 | Wildcards are allowed at the end of strings: | |
425 | 'seqfield1 == "te*"' | |
426 | In string literals, the escape character is a '\\'. Use '\\*' for | |
ee8ccafa MD |
427 | the '*' character, and '\\\\' for the '\\' character. Wildcard |
428 | match any sequence of characters, including an empty sub-string | |
429 | (match 0 or more characters). | |
430 | ||
431 | Context information can be used for filtering. The examples | |
432 | below show usage of context filtering on process name (with a | |
433 | wildcard), process ID range, and unique thread ID for filtering. | |
434 | The process and thread ID of running applications can be found | |
435 | under columns "PID" and "LWP" of the "ps -eLf" command. | |
436 | ||
437 | '$ctx.procname == "demo*"' | |
438 | '$ctx.vpid >= 4433 && $ctx.vpid < 4455' | |
439 | '$ctx.vtid == 1234' | |
6991b181 DG |
440 | .fi |
441 | ||
c9e32613 | 442 | .IP "\fBdisable-channel\fP NAME[,NAME2,...] [\-k|\-u] [OPTIONS]" |
6991b181 DG |
443 | .nf |
444 | Disable tracing channel | |
445 | ||
446 | Disabling a channel makes all event(s) in that channel to stop tracing. You can | |
447 | enable it back by calling \fBlttng enable-channel NAME\fP again. | |
448 | ||
c9e32613 | 449 | If \fB\-s, \-\-session\fP is omitted, the session name is taken from the .lttngrc |
6991b181 DG |
450 | file. |
451 | .fi | |
452 | ||
453 | .B OPTIONS: | |
454 | ||
6b8f2e64 DG |
455 | .nf |
456 | \-h, \-\-help | |
457 | Show summary of possible options and commands. | |
458 | \-\-list-options | |
459 | Simple listing of options | |
460 | \-s, \-\-session NAME | |
6991b181 | 461 | Apply on session name |
c9e32613 | 462 | \-k, \-\-kernel |
6991b181 | 463 | Apply for the kernel tracer |
c9e32613 | 464 | \-u, \-\-userspace |
6991b181 DG |
465 | Apply for the user-space tracer |
466 | .fi | |
467 | ||
c9e32613 | 468 | .IP "\fBdisable-event\fP NAME[,NAME2,...] [\-k|\-u] [OPTIONS]" |
6991b181 DG |
469 | .nf |
470 | Disable tracing event | |
471 | ||
472 | The event, once disabled, can be re-enabled by calling \fBlttng enable-event | |
473 | NAME\fP again. | |
474 | ||
c9e32613 | 475 | If \fB\-s, \-\-session\fP is omitted, the session name is taken from the .lttngrc |
6991b181 DG |
476 | file. |
477 | .fi | |
478 | ||
479 | .B OPTIONS: | |
480 | ||
481 | .nf | |
c9e32613 | 482 | \-h, \-\-help |
6991b181 | 483 | Show summary of possible options and commands. |
c9e32613 | 484 | \-\-list-options |
6991b181 | 485 | Simple listing of options |
391b9c72 | 486 | \-s, \-\-session NAME |
6991b181 | 487 | Apply on session name |
c5650942 DG |
488 | \-a, \-\-all-events |
489 | Disable all events. This does NOT disable "*" but rather | |
490 | every known events of the session. | |
c9e32613 | 491 | \-k, \-\-kernel |
6991b181 | 492 | Apply for the kernel tracer |
c9e32613 | 493 | \-u, \-\-userspace |
6991b181 DG |
494 | Apply for the user-space tracer |
495 | .fi | |
496 | ||
c9e32613 | 497 | .IP "\fBlist\fP [\-k|\-u] [SESSION [SESSION_OPTIONS]]" |
6991b181 | 498 | .nf |
c9e32613 | 499 | List tracing session information. |
6991b181 DG |
500 | |
501 | With no arguments, it will list available tracing session(s). | |
502 | ||
fa072eae YB |
503 | With the session name, it will display the details of the session including |
504 | the trace file path, the associated channels and their state (activated | |
d829b38c | 505 | and deactivated), the activated events and more. |
fa072eae | 506 | |
c9e32613 | 507 | With \-k alone, it will list all available kernel events (except the system |
6991b181 | 508 | calls events). |
c9e32613 DG |
509 | With \-u alone, it will list all available user-space events from registered |
510 | applications. Here is an example of 'lttng list \-u': | |
6991b181 DG |
511 | |
512 | PID: 7448 - Name: /tmp/lttng-ust/tests/hello/.libs/lt-hello | |
513 | ust_tests_hello:tptest_sighandler (type: tracepoint) | |
514 | ust_tests_hello:tptest (type: tracepoint) | |
515 | ||
516 | You can now enable any event listed by using the name : | |
517 | \fBust_tests_hello:tptest\fP. | |
518 | .fi | |
519 | ||
520 | .B OPTIONS: | |
521 | ||
522 | .nf | |
c9e32613 | 523 | \-h, \-\-help |
6991b181 | 524 | Show summary of possible options and commands. |
c9e32613 | 525 | \-\-list-options |
6991b181 | 526 | Simple listing of options |
c9e32613 | 527 | \-k, \-\-kernel |
d829b38c | 528 | Select kernel domain |
c9e32613 | 529 | \-u, \-\-userspace |
6991b181 DG |
530 | Select user-space domain. |
531 | ||
6b8f2e64 DG |
532 | .B SESSION OPTIONS: |
533 | ||
c9e32613 | 534 | \-c, \-\-channel NAME |
6991b181 | 535 | List details of a channel |
c9e32613 | 536 | \-d, \-\-domain |
6991b181 DG |
537 | List available domain(s) |
538 | .fi | |
539 | ||
540 | .IP "\fBset-session\fP NAME" | |
541 | .nf | |
542 | Set current session name | |
543 | ||
544 | Will change the session name in the .lttngrc file. | |
545 | .fi | |
546 | ||
547 | .B OPTIONS: | |
548 | ||
549 | .nf | |
c9e32613 | 550 | \-h, \-\-help |
6991b181 | 551 | Show summary of possible options and commands. |
c9e32613 | 552 | \-\-list-options |
6991b181 DG |
553 | Simple listing of options |
554 | .fi | |
555 | ||
556 | .IP | |
557 | ||
6b8f2e64 | 558 | .IP "\fBstart\fP [NAME] [OPTIONS]" |
6991b181 DG |
559 | .nf |
560 | Start tracing | |
561 | ||
562 | It will start tracing for all tracers for a specific tracing session. | |
563 | ||
564 | If NAME is omitted, the session name is taken from the .lttngrc file. | |
565 | .fi | |
566 | ||
567 | .B OPTIONS: | |
568 | ||
569 | .nf | |
c9e32613 | 570 | \-h, \-\-help |
6991b181 | 571 | Show summary of possible options and commands. |
c9e32613 | 572 | \-\-list-options |
6991b181 DG |
573 | Simple listing of options |
574 | .fi | |
575 | ||
576 | .IP | |
577 | ||
6b8f2e64 | 578 | .IP "\fBstop\fP [NAME] [OPTIONS]" |
6991b181 DG |
579 | .nf |
580 | Stop tracing | |
581 | ||
391b9c72 DG |
582 | It will stop tracing for all tracers for a specific tracing session. Before |
583 | returning, the command checks for data availability meaning that it will wait | |
584 | until the trace is readable for the session. Use \-\-no-wait to avoid this | |
585 | behavior. | |
6991b181 DG |
586 | |
587 | If NAME is omitted, the session name is taken from the .lttngrc file. | |
588 | .fi | |
589 | ||
590 | .B OPTIONS: | |
591 | ||
592 | .nf | |
c9e32613 | 593 | \-h, \-\-help |
6991b181 | 594 | Show summary of possible options and commands. |
c9e32613 | 595 | \-\-list-options |
6991b181 | 596 | Simple listing of options |
391b9c72 DG |
597 | \-\-no-wait |
598 | Don't wait for data availability. | |
6991b181 DG |
599 | .fi |
600 | ||
601 | .IP | |
602 | ||
603 | .IP "\fBversion\fP" | |
604 | .nf | |
605 | Show version information | |
606 | .fi | |
607 | ||
608 | .B OPTIONS: | |
609 | ||
610 | .nf | |
c9e32613 | 611 | \-h, \-\-help |
6991b181 | 612 | Show summary of possible options and commands. |
c9e32613 | 613 | \-\-list-options |
6991b181 DG |
614 | Simple listing of options |
615 | .fi | |
616 | ||
617 | .IP | |
618 | ||
619 | .IP "\fBview\fP [SESSION_NAME] [OPTIONS]" | |
620 | .nf | |
621 | View traces of a tracing session | |
622 | ||
623 | By default, the babeltrace viewer will be used for text viewing. | |
624 | ||
fa072eae YB |
625 | If SESSION_NAME is omitted, the session name is taken from the .lttngrc file. |
626 | ||
6991b181 DG |
627 | .fi |
628 | ||
629 | .B OPTIONS: | |
630 | ||
631 | .nf | |
c9e32613 | 632 | \-h, \-\-help |
6991b181 | 633 | Show this help |
c9e32613 | 634 | \-\-list-options |
6991b181 | 635 | Simple listing of options |
c9e32613 | 636 | \-t, \-\-trace-path PATH |
6991b181 | 637 | Trace directory path for the viewer |
c9e32613 | 638 | \-e, \-\-viewer CMD |
6991b181 DG |
639 | Specify viewer and/or options to use |
640 | This will completely override the default viewers so | |
641 | please make sure to specify the full command. The trace | |
642 | directory path of the session will be appended at the end | |
643 | to the arguments | |
644 | .fi | |
645 | ||
c206d957 | 646 | .SH "EXIT VALUES" |
6b8f2e64 DG |
647 | On success 0 is returned and a positive value on error. Value of 1 means a command |
648 | error, 2 an undefined command, 3 a fatal error and 4 a command warning meaning that | |
649 | something went wrong during the command. | |
c206d957 | 650 | |
6b8f2e64 DG |
651 | Any other value above 10, please refer to |
652 | .BR <lttng/lttng-error.h> | |
653 | for a detailed list or use lttng_strerror() to get a human readable string of | |
654 | the error code. | |
c206d957 | 655 | |
c206d957 | 656 | .PP |
6991b181 DG |
657 | .SH "ENVIRONMENT VARIABLES" |
658 | ||
659 | .PP | |
660 | Note that all command line options override environment variables. | |
661 | .PP | |
662 | ||
663 | .PP | |
05833633 | 664 | .IP "LTTNG_SESSIOND_PATH" |
c9e32613 DG |
665 | Allows one to specify the full session daemon binary path to lttng command line |
666 | tool. You can also use \-\-sessiond-path option having the same effect. | |
6991b181 | 667 | .SH "SEE ALSO" |
6b8f2e64 DG |
668 | .BR babeltrace(1), |
669 | .BR lttng-ust(3), | |
670 | .BR lttng-sessiond(8), | |
671 | .BR lttng-relayd(8), | |
672 | .BR lttng-health-check(3) | |
6991b181 DG |
673 | .SH "BUGS" |
674 | ||
6991b181 | 675 | If you encounter any issues or usability problem, please report it on our |
6b8f2e64 DG |
676 | mailing list <lttng-dev@lists.lttng.org> to help improve this project or |
677 | at https://bugs.lttng.org which is a bugtracker. | |
6991b181 DG |
678 | .SH "CREDITS" |
679 | ||
680 | .PP | |
c9e32613 | 681 | lttng is distributed under the GNU General Public License version 2. See the file |
6991b181 DG |
682 | COPYING for details. |
683 | .PP | |
684 | A Web site is available at http://lttng.org for more information on the LTTng | |
685 | project. | |
686 | .PP | |
687 | You can also find our git tree at http://git.lttng.org. | |
688 | .PP | |
689 | Mailing lists for support and development: <lttng-dev@lists.lttng.org>. | |
690 | .PP | |
691 | You can find us on IRC server irc.oftc.net (OFTC) in #lttng. | |
692 | .PP | |
693 | .SH "THANKS" | |
694 | ||
695 | .PP | |
696 | Thanks to Yannick Brosseau without whom this project would never have been so | |
697 | lean and mean! Also thanks to the Ericsson teams working on tracing which | |
fa072eae | 698 | helped us greatly with detailed bug reports and unusual test cases. |
6991b181 DG |
699 | |
700 | Thanks to our beloved packager Alexandre Montplaisir-Goncalves (Ubuntu and PPA | |
701 | maintainer) and Jon Bernard for our Debian packages. | |
702 | ||
703 | Special thanks to Michel Dagenais and the DORSAL laboratory at Polytechnique de | |
704 | Montreal for the LTTng journey. | |
c9e32613 | 705 | .PP |
6991b181 DG |
706 | .SH "AUTHORS" |
707 | ||
708 | .PP | |
709 | lttng-tools was originally written by Mathieu Desnoyers, Julien Desfossez and | |
710 | David Goulet. More people have since contributed to it. It is currently | |
711 | maintained by David Goulet <dgoulet@efficios.com>. | |
712 | .PP |