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