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 | ||
233 | \-U, \-\-set-uri=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 | ||
b883c01b DG |
300 | To enable event, you must first enable a channel which contains event(s). |
301 | ||
c9e32613 | 302 | If \fB\-s, \-\-session\fP is omitted, the session name is taken from the .lttngrc |
6991b181 DG |
303 | file. |
304 | .fi | |
305 | ||
306 | .B OPTIONS: | |
307 | ||
308 | .nf | |
c9e32613 | 309 | \-h, \-\-help |
6991b181 | 310 | Show this help |
c9e32613 | 311 | \-\-list-options |
6991b181 | 312 | Simple listing of options |
391b9c72 | 313 | \-s, \-\-session NAME |
6991b181 | 314 | Apply on session name |
c9e32613 | 315 | \-k, \-\-kernel |
6991b181 | 316 | Apply to the kernel tracer |
c9e32613 | 317 | \-u, \-\-userspace |
6991b181 DG |
318 | Apply to the user-space tracer |
319 | ||
c9e32613 | 320 | \-\-discard |
6991b181 | 321 | Discard event when subbuffers are full (default) |
c9e32613 | 322 | \-\-overwrite |
6991b181 | 323 | Flight recorder mode : overwrites events when subbuffers are full |
391b9c72 | 324 | \-\-subbuf-size SIZE |
6991b181 | 325 | Subbuffer size in bytes (default: 4096, kernel default: 262144) |
391b9c72 | 326 | \-\-num-subbuf NUM |
d829b38c | 327 | Number of subbuffers (default: 4) |
93e6c8a0 | 328 | Needs to be a power of 2 for kernel and ust tracers |
391b9c72 | 329 | \-\-switch-timer USEC |
6991b181 | 330 | Switch subbuffer timer interval in usec (default: 0) |
93e6c8a0 | 331 | Needs to be a power of 2 for kernel and ust tracers |
391b9c72 | 332 | \-\-read-timer USEC |
6991b181 | 333 | Read timer interval in usec (default: 200) |
391b9c72 DG |
334 | \-\-output TYPE |
335 | Channel output type. Possible values: mmap, splice | |
6991b181 DG |
336 | .fi |
337 | ||
338 | .IP | |
339 | ||
340 | .IP "\fBenable-event\fP NAME[,NAME2,...] [-k|-u] [OPTIONS]" | |
341 | .nf | |
342 | Enable tracing event | |
343 | ||
c9e32613 | 344 | A tracing event is always assigned to a channel. If \fB\-c, \-\-channel\fP is |
6991b181 | 345 | omitted, a default channel named '\fBchannel0\fP' is created and the event is |
c9e32613 | 346 | added to it. For the user-space tracer, using \fB\-a, \-\-all\fP is the same as |
6991b181 DG |
347 | using the wildcard "*". |
348 | ||
c9e32613 | 349 | If \fB\-s, \-\-session\fP is omitted, the session name is taken from the .lttngrc |
6991b181 DG |
350 | file. |
351 | .fi | |
352 | ||
353 | .B OPTIONS: | |
354 | ||
355 | .nf | |
c9e32613 | 356 | \-h, \-\-help |
6991b181 | 357 | Show summary of possible options and commands. |
c9e32613 | 358 | \-\-list-options |
6991b181 | 359 | Simple listing of options |
391b9c72 | 360 | \-s, \-\-session NAME |
6991b181 | 361 | Apply on session name |
391b9c72 | 362 | \-c, \-\-channel NAME |
6991b181 | 363 | Apply on channel name |
c9e32613 | 364 | \-a, \-\-all |
c5650942 DG |
365 | Enable all tracepoints and syscalls. This actually enable a single |
366 | wildcard event "*". | |
c9e32613 | 367 | \-k, \-\-kernel |
6991b181 | 368 | Apply for the kernel tracer |
c9e32613 | 369 | \-u, \-\-userspace |
6991b181 DG |
370 | Apply for the user-space tracer |
371 | ||
c9e32613 | 372 | \-\-tracepoint |
6991b181 DG |
373 | Tracepoint event (default) |
374 | - userspace tracer supports wildcards at end of string. Don't forget to | |
375 | quote to deal with bash expansion. | |
376 | e.g.: | |
377 | "*" | |
378 | "app_component:na*" | |
391b9c72 DG |
379 | \-\-loglevel NAME |
380 | Tracepoint loglevel range from 0 to loglevel. Listed in the help (\-h). | |
381 | \-\-loglevel-only NAME | |
382 | Tracepoint loglevel (only this loglevel). | |
383 | ||
384 | The loglevel or loglevel-only options should be combined with a | |
385 | tracepoint name or tracepoint wildcard. | |
c9e32613 | 386 | \-\-probe [addr | symbol | symbol+offset] |
6991b181 DG |
387 | Dynamic probe. Addr and offset can be octal (0NNN...), decimal (NNN...) |
388 | or hexadecimal (0xNNN...) | |
c9e32613 | 389 | \-\-function [addr | symbol | symbol+offset] |
6991b181 DG |
390 | Dynamic function entry/return probe. Addr and offset can be octal |
391 | (0NNN...), decimal (NNN...) or hexadecimal (0xNNN...) | |
c9e32613 | 392 | \-\-syscall |
6b8f2e64 DG |
393 | System call event. Enabling syscalls tracing (kernel tracer), you will |
394 | not be able to disable them with disable-event. This is a known | |
395 | limitation. You can disable the entire channel to do the trick. | |
9bd578f5 | 396 | |
919e300c | 397 | \-\-filter 'expression' |
6b8f2e64 DG |
398 | Set a filter on a newly enabled event. Filter expression on event |
399 | fields, event recording depends on evaluation. Only specify on first | |
400 | activation of a given event within a session. Filter only allowed when | |
401 | enabling events within a session before tracing is started. If the | |
402 | filter fails to link with the event within the traced domain, the event | |
403 | will be discarded. Currently, filter is only implemented for the | |
404 | user-space tracer. | |
405 | ||
406 | Expression examples: | |
407 | ||
408 | 'intfield > 500 && intfield < 503' | |
409 | '(stringfield == "test" || intfield != 10) && intfield > 33' | |
410 | 'doublefield > 1.1 && intfield < 5.3' | |
411 | ||
412 | Wildcards are allowed at the end of strings: | |
413 | 'seqfield1 == "te*"' | |
414 | In string literals, the escape character is a '\\'. Use '\\*' for | |
415 | the '*' character, and '\\\\' for the '\\' character. | |
6991b181 DG |
416 | .fi |
417 | ||
c9e32613 | 418 | .IP "\fBdisable-channel\fP NAME[,NAME2,...] [\-k|\-u] [OPTIONS]" |
6991b181 DG |
419 | .nf |
420 | Disable tracing channel | |
421 | ||
422 | Disabling a channel makes all event(s) in that channel to stop tracing. You can | |
423 | enable it back by calling \fBlttng enable-channel NAME\fP again. | |
424 | ||
c9e32613 | 425 | If \fB\-s, \-\-session\fP is omitted, the session name is taken from the .lttngrc |
6991b181 DG |
426 | file. |
427 | .fi | |
428 | ||
429 | .B OPTIONS: | |
430 | ||
6b8f2e64 DG |
431 | .nf |
432 | \-h, \-\-help | |
433 | Show summary of possible options and commands. | |
434 | \-\-list-options | |
435 | Simple listing of options | |
436 | \-s, \-\-session NAME | |
6991b181 | 437 | Apply on session name |
c9e32613 | 438 | \-k, \-\-kernel |
6991b181 | 439 | Apply for the kernel tracer |
c9e32613 | 440 | \-u, \-\-userspace |
6991b181 DG |
441 | Apply for the user-space tracer |
442 | .fi | |
443 | ||
c9e32613 | 444 | .IP "\fBdisable-event\fP NAME[,NAME2,...] [\-k|\-u] [OPTIONS]" |
6991b181 DG |
445 | .nf |
446 | Disable tracing event | |
447 | ||
448 | The event, once disabled, can be re-enabled by calling \fBlttng enable-event | |
449 | NAME\fP again. | |
450 | ||
c9e32613 | 451 | If \fB\-s, \-\-session\fP is omitted, the session name is taken from the .lttngrc |
6991b181 DG |
452 | file. |
453 | .fi | |
454 | ||
455 | .B OPTIONS: | |
456 | ||
457 | .nf | |
c9e32613 | 458 | \-h, \-\-help |
6991b181 | 459 | Show summary of possible options and commands. |
c9e32613 | 460 | \-\-list-options |
6991b181 | 461 | Simple listing of options |
391b9c72 | 462 | \-s, \-\-session NAME |
6991b181 | 463 | Apply on session name |
c5650942 DG |
464 | \-a, \-\-all-events |
465 | Disable all events. This does NOT disable "*" but rather | |
466 | every known events of the session. | |
c9e32613 | 467 | \-k, \-\-kernel |
6991b181 | 468 | Apply for the kernel tracer |
c9e32613 | 469 | \-u, \-\-userspace |
6991b181 DG |
470 | Apply for the user-space tracer |
471 | .fi | |
472 | ||
c9e32613 | 473 | .IP "\fBlist\fP [\-k|\-u] [SESSION [SESSION_OPTIONS]]" |
6991b181 | 474 | .nf |
c9e32613 | 475 | List tracing session information. |
6991b181 DG |
476 | |
477 | With no arguments, it will list available tracing session(s). | |
478 | ||
fa072eae YB |
479 | With the session name, it will display the details of the session including |
480 | the trace file path, the associated channels and their state (activated | |
d829b38c | 481 | and deactivated), the activated events and more. |
fa072eae | 482 | |
c9e32613 | 483 | With \-k alone, it will list all available kernel events (except the system |
6991b181 | 484 | calls events). |
c9e32613 DG |
485 | With \-u alone, it will list all available user-space events from registered |
486 | applications. Here is an example of 'lttng list \-u': | |
6991b181 DG |
487 | |
488 | PID: 7448 - Name: /tmp/lttng-ust/tests/hello/.libs/lt-hello | |
489 | ust_tests_hello:tptest_sighandler (type: tracepoint) | |
490 | ust_tests_hello:tptest (type: tracepoint) | |
491 | ||
492 | You can now enable any event listed by using the name : | |
493 | \fBust_tests_hello:tptest\fP. | |
494 | .fi | |
495 | ||
496 | .B OPTIONS: | |
497 | ||
498 | .nf | |
c9e32613 | 499 | \-h, \-\-help |
6991b181 | 500 | Show summary of possible options and commands. |
c9e32613 | 501 | \-\-list-options |
6991b181 | 502 | Simple listing of options |
c9e32613 | 503 | \-k, \-\-kernel |
d829b38c | 504 | Select kernel domain |
c9e32613 | 505 | \-u, \-\-userspace |
6991b181 DG |
506 | Select user-space domain. |
507 | ||
6b8f2e64 DG |
508 | .B SESSION OPTIONS: |
509 | ||
c9e32613 | 510 | \-c, \-\-channel NAME |
6991b181 | 511 | List details of a channel |
c9e32613 | 512 | \-d, \-\-domain |
6991b181 DG |
513 | List available domain(s) |
514 | .fi | |
515 | ||
516 | .IP "\fBset-session\fP NAME" | |
517 | .nf | |
518 | Set current session name | |
519 | ||
520 | Will change the session name in the .lttngrc file. | |
521 | .fi | |
522 | ||
523 | .B OPTIONS: | |
524 | ||
525 | .nf | |
c9e32613 | 526 | \-h, \-\-help |
6991b181 | 527 | Show summary of possible options and commands. |
c9e32613 | 528 | \-\-list-options |
6991b181 DG |
529 | Simple listing of options |
530 | .fi | |
531 | ||
532 | .IP | |
533 | ||
6b8f2e64 | 534 | .IP "\fBstart\fP [NAME] [OPTIONS]" |
6991b181 DG |
535 | .nf |
536 | Start tracing | |
537 | ||
538 | It will start tracing for all tracers for a specific tracing session. | |
539 | ||
540 | If NAME is omitted, the session name is taken from the .lttngrc file. | |
541 | .fi | |
542 | ||
543 | .B OPTIONS: | |
544 | ||
545 | .nf | |
c9e32613 | 546 | \-h, \-\-help |
6991b181 | 547 | Show summary of possible options and commands. |
c9e32613 | 548 | \-\-list-options |
6991b181 DG |
549 | Simple listing of options |
550 | .fi | |
551 | ||
552 | .IP | |
553 | ||
6b8f2e64 | 554 | .IP "\fBstop\fP [NAME] [OPTIONS]" |
6991b181 DG |
555 | .nf |
556 | Stop tracing | |
557 | ||
391b9c72 DG |
558 | It will stop tracing for all tracers for a specific tracing session. Before |
559 | returning, the command checks for data availability meaning that it will wait | |
560 | until the trace is readable for the session. Use \-\-no-wait to avoid this | |
561 | behavior. | |
6991b181 DG |
562 | |
563 | If NAME is omitted, the session name is taken from the .lttngrc file. | |
564 | .fi | |
565 | ||
566 | .B OPTIONS: | |
567 | ||
568 | .nf | |
c9e32613 | 569 | \-h, \-\-help |
6991b181 | 570 | Show summary of possible options and commands. |
c9e32613 | 571 | \-\-list-options |
6991b181 | 572 | Simple listing of options |
391b9c72 DG |
573 | \-\-no-wait |
574 | Don't wait for data availability. | |
6991b181 DG |
575 | .fi |
576 | ||
577 | .IP | |
578 | ||
579 | .IP "\fBversion\fP" | |
580 | .nf | |
581 | Show version information | |
582 | .fi | |
583 | ||
584 | .B OPTIONS: | |
585 | ||
586 | .nf | |
c9e32613 | 587 | \-h, \-\-help |
6991b181 | 588 | Show summary of possible options and commands. |
c9e32613 | 589 | \-\-list-options |
6991b181 DG |
590 | Simple listing of options |
591 | .fi | |
592 | ||
593 | .IP | |
594 | ||
595 | .IP "\fBview\fP [SESSION_NAME] [OPTIONS]" | |
596 | .nf | |
597 | View traces of a tracing session | |
598 | ||
599 | By default, the babeltrace viewer will be used for text viewing. | |
600 | ||
fa072eae YB |
601 | If SESSION_NAME is omitted, the session name is taken from the .lttngrc file. |
602 | ||
6991b181 DG |
603 | .fi |
604 | ||
605 | .B OPTIONS: | |
606 | ||
607 | .nf | |
c9e32613 | 608 | \-h, \-\-help |
6991b181 | 609 | Show this help |
c9e32613 | 610 | \-\-list-options |
6991b181 | 611 | Simple listing of options |
c9e32613 | 612 | \-t, \-\-trace-path PATH |
6991b181 | 613 | Trace directory path for the viewer |
c9e32613 | 614 | \-e, \-\-viewer CMD |
6991b181 DG |
615 | Specify viewer and/or options to use |
616 | This will completely override the default viewers so | |
617 | please make sure to specify the full command. The trace | |
618 | directory path of the session will be appended at the end | |
619 | to the arguments | |
620 | .fi | |
621 | ||
c206d957 | 622 | .SH "EXIT VALUES" |
6b8f2e64 DG |
623 | On success 0 is returned and a positive value on error. Value of 1 means a command |
624 | error, 2 an undefined command, 3 a fatal error and 4 a command warning meaning that | |
625 | something went wrong during the command. | |
c206d957 | 626 | |
6b8f2e64 DG |
627 | Any other value above 10, please refer to |
628 | .BR <lttng/lttng-error.h> | |
629 | for a detailed list or use lttng_strerror() to get a human readable string of | |
630 | the error code. | |
c206d957 | 631 | |
c206d957 | 632 | .PP |
6991b181 DG |
633 | .SH "ENVIRONMENT VARIABLES" |
634 | ||
635 | .PP | |
636 | Note that all command line options override environment variables. | |
637 | .PP | |
638 | ||
639 | .PP | |
05833633 | 640 | .IP "LTTNG_SESSIOND_PATH" |
c9e32613 DG |
641 | Allows one to specify the full session daemon binary path to lttng command line |
642 | tool. You can also use \-\-sessiond-path option having the same effect. | |
6991b181 | 643 | .SH "SEE ALSO" |
6b8f2e64 DG |
644 | .BR babeltrace(1), |
645 | .BR lttng-ust(3), | |
646 | .BR lttng-sessiond(8), | |
647 | .BR lttng-relayd(8), | |
648 | .BR lttng-health-check(3) | |
6991b181 DG |
649 | .SH "BUGS" |
650 | ||
6991b181 | 651 | If you encounter any issues or usability problem, please report it on our |
6b8f2e64 DG |
652 | mailing list <lttng-dev@lists.lttng.org> to help improve this project or |
653 | at https://bugs.lttng.org which is a bugtracker. | |
6991b181 DG |
654 | .SH "CREDITS" |
655 | ||
656 | .PP | |
c9e32613 | 657 | lttng is distributed under the GNU General Public License version 2. See the file |
6991b181 DG |
658 | COPYING for details. |
659 | .PP | |
660 | A Web site is available at http://lttng.org for more information on the LTTng | |
661 | project. | |
662 | .PP | |
663 | You can also find our git tree at http://git.lttng.org. | |
664 | .PP | |
665 | Mailing lists for support and development: <lttng-dev@lists.lttng.org>. | |
666 | .PP | |
667 | You can find us on IRC server irc.oftc.net (OFTC) in #lttng. | |
668 | .PP | |
669 | .SH "THANKS" | |
670 | ||
671 | .PP | |
672 | Thanks to Yannick Brosseau without whom this project would never have been so | |
673 | lean and mean! Also thanks to the Ericsson teams working on tracing which | |
fa072eae | 674 | helped us greatly with detailed bug reports and unusual test cases. |
6991b181 DG |
675 | |
676 | Thanks to our beloved packager Alexandre Montplaisir-Goncalves (Ubuntu and PPA | |
677 | maintainer) and Jon Bernard for our Debian packages. | |
678 | ||
679 | Special thanks to Michel Dagenais and the DORSAL laboratory at Polytechnique de | |
680 | Montreal for the LTTng journey. | |
c9e32613 | 681 | .PP |
6991b181 DG |
682 | .SH "AUTHORS" |
683 | ||
684 | .PP | |
685 | lttng-tools was originally written by Mathieu Desnoyers, Julien Desfossez and | |
686 | David Goulet. More people have since contributed to it. It is currently | |
687 | maintained by David Goulet <dgoulet@efficios.com>. | |
688 | .PP |