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 | |
234 | Set URL for the enable-consumer destination. It is persistent for the | |
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) | |
241 | \-\-no-consumer | |
242 | Don't activate a consumer for this session. | |
243 | \-\-disable-consumer | |
244 | Disable consumer for this session. | |
245 | ||
246 | See \fBenable-consumer\fP command below for the supported URL format. | |
247 | ||
248 | .B EXAMPLES: | |
249 | ||
250 | # lttng create -U net://192.168.1.42 | |
251 | Uses TCP and default ports for the given destination. | |
252 | ||
253 | # lttng create -U net6://[fe80::f66d:4ff:fe53:d220] | |
254 | Uses TCP, default ports and IPv6. | |
255 | ||
256 | # lttng create s1 -U net://myhost.com:3229 | |
257 | Create session s1 and set its consumer to myhost.com on port 3229 for control. | |
6991b181 DG |
258 | .fi |
259 | ||
260 | .IP | |
261 | ||
262 | .IP "\fBdestroy\fP [OPTIONS] [NAME]" | |
263 | .nf | |
264 | Teardown tracing session | |
265 | ||
266 | Free memory on the session daemon and tracer side. It's gone! | |
267 | ||
268 | If NAME is omitted, the session name is taken from the .lttngrc file. | |
269 | .fi | |
270 | ||
271 | .B OPTIONS: | |
272 | ||
273 | .nf | |
c9e32613 | 274 | \-h, \-\-help |
6991b181 | 275 | Show summary of possible options and commands. |
a3c5b534 FG |
276 | \-a, \-\-all |
277 | Destroy all sessions | |
c9e32613 | 278 | \-\-list-options |
6991b181 DG |
279 | Simple listing of options |
280 | .fi | |
281 | ||
282 | .IP | |
283 | ||
284 | .IP "\fBenable-channel\fP NAME[,NAME2,...] [-k|-u] [OPTIONS]" | |
285 | .nf | |
286 | Enable tracing channel | |
287 | ||
b883c01b DG |
288 | To enable event, you must first enable a channel which contains event(s). |
289 | ||
c9e32613 | 290 | If \fB\-s, \-\-session\fP is omitted, the session name is taken from the .lttngrc |
6991b181 DG |
291 | file. |
292 | .fi | |
293 | ||
294 | .B OPTIONS: | |
295 | ||
296 | .nf | |
c9e32613 | 297 | \-h, \-\-help |
6991b181 | 298 | Show this help |
c9e32613 | 299 | \-\-list-options |
6991b181 | 300 | Simple listing of options |
391b9c72 | 301 | \-s, \-\-session NAME |
6991b181 | 302 | Apply on session name |
c9e32613 | 303 | \-k, \-\-kernel |
6991b181 | 304 | Apply to the kernel tracer |
c9e32613 | 305 | \-u, \-\-userspace |
6991b181 DG |
306 | Apply to the user-space tracer |
307 | ||
c9e32613 | 308 | \-\-discard |
6991b181 | 309 | Discard event when subbuffers are full (default) |
c9e32613 | 310 | \-\-overwrite |
6991b181 | 311 | Flight recorder mode : overwrites events when subbuffers are full |
391b9c72 | 312 | \-\-subbuf-size SIZE |
6991b181 | 313 | Subbuffer size in bytes (default: 4096, kernel default: 262144) |
391b9c72 | 314 | \-\-num-subbuf NUM |
d829b38c | 315 | Number of subbuffers (default: 4) |
93e6c8a0 | 316 | Needs to be a power of 2 for kernel and ust tracers |
391b9c72 | 317 | \-\-switch-timer USEC |
6991b181 | 318 | Switch subbuffer timer interval in usec (default: 0) |
93e6c8a0 | 319 | Needs to be a power of 2 for kernel and ust tracers |
391b9c72 | 320 | \-\-read-timer USEC |
6991b181 | 321 | Read timer interval in usec (default: 200) |
391b9c72 DG |
322 | \-\-output TYPE |
323 | Channel output type. Possible values: mmap, splice | |
6991b181 DG |
324 | .fi |
325 | ||
326 | .IP | |
327 | ||
6b8f2e64 DG |
328 | .IP "\fBenable-consumer\fP [-u|-k] [URL] [OPTIONS]" |
329 | .nf | |
330 | Enable a consumer for the tracing session and domain. | |
331 | ||
332 | By default, every tracing session has a consumer attached to it using the local | |
333 | filesystem as output. The trace is written in $HOME/lttng-traces. This command | |
334 | allows the user to specify a specific URL after the session was created for a | |
335 | specific domain. If no domain is specified, the consumer is applied on all | |
336 | domains. | |
337 | ||
338 | Without options, the behavior is to enable a consumer to the current URL. The | |
339 | default URL is the local filesystem at the path of the session mentioned above. | |
340 | ||
341 | The enable-consumer feature supports both local and network transport. You must | |
342 | have a running \fBlttng-relayd(8)\fP for network transmission or any other daemon | |
343 | that can understand the streaming protocol of LTTng. | |
344 | .fi | |
345 | ||
346 | .B OPTIONS: | |
347 | ||
348 | .nf | |
349 | \-h, \-\-help | |
350 | Show summary of possible options and commands. | |
351 | \-\-list-options | |
352 | Simple listing of options | |
391b9c72 | 353 | \-s, \-\-session NAME |
6b8f2e64 DG |
354 | Apply on session name |
355 | \-k, \-\-kernel | |
356 | Apply for the kernel tracer | |
357 | \-u, \-\-userspace | |
358 | Apply for the user-space tracer | |
359 | ||
360 | Using these options, each API call can be controlled individually. For | |
361 | instance, \-C does not enable the consumer automatically. You'll need the \-e | |
362 | option for that. | |
363 | ||
364 | \-U, \-\-set-uri=URL | |
365 | Set URL for the enable-consumer destination. It is persistent for the | |
366 | session lifetime. Redo the command to change it. This will set both | |
367 | data and control URL for network. | |
368 | \-C, \-\-ctrl-url=URL | |
369 | Set control path URL. (Must use -D also) | |
370 | \-D, \-\-data-url=URL | |
371 | Set data path URL. (Must use -C also) | |
372 | \-e, \-\-enable | |
373 | Enable consumer | |
374 | ||
375 | .B URL FORMAT: | |
376 | ||
377 | proto://[HOST|IP][:PORT1[:PORT2]][/TRACE_PATH] | |
378 | ||
379 | Supported protocols are (proto): | |
380 | > file://... | |
381 | Local filesystem full path. | |
382 | ||
391b9c72 | 383 | > net://... |
6b8f2e64 DG |
384 | This will use the default network transport layer which is TCP for both |
385 | control (PORT1) and data port (PORT2). The default ports are | |
391b9c72 | 386 | respectively 5342 and 5343. Note that net[6]:// is not yet supported. |
6b8f2e64 DG |
387 | |
388 | > tcp[6]://... | |
389 | Can only be used with -C and -D together | |
390 | ||
391 | NOTE: IPv6 address MUST be enclosed in brackets '[]' (rfc2732) | |
392 | ||
393 | .B EXAMPLES: | |
394 | ||
395 | $ lttng enable-consumer -u net://192.168.1.42 | |
396 | ||
397 | Uses TCP and default ports for user space tracing (-u) where the IP address | |
398 | above is the destination machine where the traces will be streamed and a | |
399 | \fBlttng-relayd(8)\fP is listening. | |
400 | .fi | |
401 | ||
6991b181 DG |
402 | .IP "\fBenable-event\fP NAME[,NAME2,...] [-k|-u] [OPTIONS]" |
403 | .nf | |
404 | Enable tracing event | |
405 | ||
c9e32613 | 406 | A tracing event is always assigned to a channel. If \fB\-c, \-\-channel\fP is |
6991b181 | 407 | omitted, a default channel named '\fBchannel0\fP' is created and the event is |
c9e32613 | 408 | added to it. For the user-space tracer, using \fB\-a, \-\-all\fP is the same as |
6991b181 DG |
409 | using the wildcard "*". |
410 | ||
c9e32613 | 411 | If \fB\-s, \-\-session\fP is omitted, the session name is taken from the .lttngrc |
6991b181 DG |
412 | file. |
413 | .fi | |
414 | ||
415 | .B OPTIONS: | |
416 | ||
417 | .nf | |
c9e32613 | 418 | \-h, \-\-help |
6991b181 | 419 | Show summary of possible options and commands. |
c9e32613 | 420 | \-\-list-options |
6991b181 | 421 | Simple listing of options |
391b9c72 | 422 | \-s, \-\-session NAME |
6991b181 | 423 | Apply on session name |
391b9c72 | 424 | \-c, \-\-channel NAME |
6991b181 | 425 | Apply on channel name |
c9e32613 | 426 | \-a, \-\-all |
e08bff8d | 427 | Enable all tracepoints and syscalls |
c9e32613 | 428 | \-k, \-\-kernel |
6991b181 | 429 | Apply for the kernel tracer |
c9e32613 | 430 | \-u, \-\-userspace |
6991b181 DG |
431 | Apply for the user-space tracer |
432 | ||
c9e32613 | 433 | \-\-tracepoint |
6991b181 DG |
434 | Tracepoint event (default) |
435 | - userspace tracer supports wildcards at end of string. Don't forget to | |
436 | quote to deal with bash expansion. | |
437 | e.g.: | |
438 | "*" | |
439 | "app_component:na*" | |
391b9c72 DG |
440 | \-\-loglevel NAME |
441 | Tracepoint loglevel range from 0 to loglevel. Listed in the help (\-h). | |
442 | \-\-loglevel-only NAME | |
443 | Tracepoint loglevel (only this loglevel). | |
444 | ||
445 | The loglevel or loglevel-only options should be combined with a | |
446 | tracepoint name or tracepoint wildcard. | |
c9e32613 | 447 | \-\-probe [addr | symbol | symbol+offset] |
6991b181 DG |
448 | Dynamic probe. Addr and offset can be octal (0NNN...), decimal (NNN...) |
449 | or hexadecimal (0xNNN...) | |
c9e32613 | 450 | \-\-function [addr | symbol | symbol+offset] |
6991b181 DG |
451 | Dynamic function entry/return probe. Addr and offset can be octal |
452 | (0NNN...), decimal (NNN...) or hexadecimal (0xNNN...) | |
c9e32613 | 453 | \-\-syscall |
6b8f2e64 DG |
454 | System call event. Enabling syscalls tracing (kernel tracer), you will |
455 | not be able to disable them with disable-event. This is a known | |
456 | limitation. You can disable the entire channel to do the trick. | |
9bd578f5 | 457 | |
919e300c | 458 | \-\-filter 'expression' |
6b8f2e64 DG |
459 | Set a filter on a newly enabled event. Filter expression on event |
460 | fields, event recording depends on evaluation. Only specify on first | |
461 | activation of a given event within a session. Filter only allowed when | |
462 | enabling events within a session before tracing is started. If the | |
463 | filter fails to link with the event within the traced domain, the event | |
464 | will be discarded. Currently, filter is only implemented for the | |
465 | user-space tracer. | |
466 | ||
467 | Expression examples: | |
468 | ||
469 | 'intfield > 500 && intfield < 503' | |
470 | '(stringfield == "test" || intfield != 10) && intfield > 33' | |
471 | 'doublefield > 1.1 && intfield < 5.3' | |
472 | ||
473 | Wildcards are allowed at the end of strings: | |
474 | 'seqfield1 == "te*"' | |
475 | In string literals, the escape character is a '\\'. Use '\\*' for | |
476 | the '*' character, and '\\\\' for the '\\' character. | |
6991b181 DG |
477 | .fi |
478 | ||
c9e32613 | 479 | .IP "\fBdisable-channel\fP NAME[,NAME2,...] [\-k|\-u] [OPTIONS]" |
6991b181 DG |
480 | .nf |
481 | Disable tracing channel | |
482 | ||
483 | Disabling a channel makes all event(s) in that channel to stop tracing. You can | |
484 | enable it back by calling \fBlttng enable-channel NAME\fP again. | |
485 | ||
c9e32613 | 486 | If \fB\-s, \-\-session\fP is omitted, the session name is taken from the .lttngrc |
6991b181 DG |
487 | file. |
488 | .fi | |
489 | ||
490 | .B OPTIONS: | |
491 | ||
492 | .nf | |
c9e32613 | 493 | \-h, \-\-help |
6991b181 | 494 | Show summary of possible options and commands. |
c9e32613 | 495 | \-\-list-options |
6991b181 | 496 | Simple listing of options |
6b8f2e64 DG |
497 | \-s, \-\-session NAME |
498 | Apply on session name | |
499 | \-k, \-\-kernel | |
500 | Apply for the kernel tracer | |
501 | \-u, \-\-userspace | |
502 | Apply for the user-space tracer | |
503 | .fi | |
504 | ||
505 | .IP "\fBdisable-consumer\fP [\-k|\-u] [OPTIONS]" | |
506 | .nf | |
507 | Disable the consumer of a tracing session. | |
508 | ||
509 | This call MUST be done BEFORE tracing has started. | |
510 | .fi | |
511 | ||
512 | .B OPTIONS: | |
513 | ||
514 | .nf | |
515 | \-h, \-\-help | |
516 | Show summary of possible options and commands. | |
517 | \-\-list-options | |
518 | Simple listing of options | |
519 | \-s, \-\-session NAME | |
6991b181 | 520 | Apply on session name |
c9e32613 | 521 | \-k, \-\-kernel |
6991b181 | 522 | Apply for the kernel tracer |
c9e32613 | 523 | \-u, \-\-userspace |
6991b181 DG |
524 | Apply for the user-space tracer |
525 | .fi | |
526 | ||
c9e32613 | 527 | .IP "\fBdisable-event\fP NAME[,NAME2,...] [\-k|\-u] [OPTIONS]" |
6991b181 DG |
528 | .nf |
529 | Disable tracing event | |
530 | ||
531 | The event, once disabled, can be re-enabled by calling \fBlttng enable-event | |
532 | NAME\fP again. | |
533 | ||
c9e32613 | 534 | If \fB\-s, \-\-session\fP is omitted, the session name is taken from the .lttngrc |
6991b181 DG |
535 | file. |
536 | .fi | |
537 | ||
538 | .B OPTIONS: | |
539 | ||
540 | .nf | |
c9e32613 | 541 | \-h, \-\-help |
6991b181 | 542 | Show summary of possible options and commands. |
c9e32613 | 543 | \-\-list-options |
6991b181 | 544 | Simple listing of options |
391b9c72 | 545 | \-s, \-\-session NAME |
6991b181 | 546 | Apply on session name |
c9e32613 | 547 | \-k, \-\-kernel |
6991b181 | 548 | Apply for the kernel tracer |
c9e32613 | 549 | \-u, \-\-userspace |
6991b181 DG |
550 | Apply for the user-space tracer |
551 | .fi | |
552 | ||
c9e32613 | 553 | .IP "\fBlist\fP [\-k|\-u] [SESSION [SESSION_OPTIONS]]" |
6991b181 | 554 | .nf |
c9e32613 | 555 | List tracing session information. |
6991b181 DG |
556 | |
557 | With no arguments, it will list available tracing session(s). | |
558 | ||
fa072eae YB |
559 | With the session name, it will display the details of the session including |
560 | the trace file path, the associated channels and their state (activated | |
d829b38c | 561 | and deactivated), the activated events and more. |
fa072eae | 562 | |
c9e32613 | 563 | With \-k alone, it will list all available kernel events (except the system |
6991b181 | 564 | calls events). |
c9e32613 DG |
565 | With \-u alone, it will list all available user-space events from registered |
566 | applications. Here is an example of 'lttng list \-u': | |
6991b181 DG |
567 | |
568 | PID: 7448 - Name: /tmp/lttng-ust/tests/hello/.libs/lt-hello | |
569 | ust_tests_hello:tptest_sighandler (type: tracepoint) | |
570 | ust_tests_hello:tptest (type: tracepoint) | |
571 | ||
572 | You can now enable any event listed by using the name : | |
573 | \fBust_tests_hello:tptest\fP. | |
574 | .fi | |
575 | ||
576 | .B OPTIONS: | |
577 | ||
578 | .nf | |
c9e32613 | 579 | \-h, \-\-help |
6991b181 | 580 | Show summary of possible options and commands. |
c9e32613 | 581 | \-\-list-options |
6991b181 | 582 | Simple listing of options |
c9e32613 | 583 | \-k, \-\-kernel |
d829b38c | 584 | Select kernel domain |
c9e32613 | 585 | \-u, \-\-userspace |
6991b181 DG |
586 | Select user-space domain. |
587 | ||
6b8f2e64 DG |
588 | .B SESSION OPTIONS: |
589 | ||
c9e32613 | 590 | \-c, \-\-channel NAME |
6991b181 | 591 | List details of a channel |
c9e32613 | 592 | \-d, \-\-domain |
6991b181 DG |
593 | List available domain(s) |
594 | .fi | |
595 | ||
596 | .IP "\fBset-session\fP NAME" | |
597 | .nf | |
598 | Set current session name | |
599 | ||
600 | Will change the session name in the .lttngrc file. | |
601 | .fi | |
602 | ||
603 | .B OPTIONS: | |
604 | ||
605 | .nf | |
c9e32613 | 606 | \-h, \-\-help |
6991b181 | 607 | Show summary of possible options and commands. |
c9e32613 | 608 | \-\-list-options |
6991b181 DG |
609 | Simple listing of options |
610 | .fi | |
611 | ||
612 | .IP | |
613 | ||
6b8f2e64 | 614 | .IP "\fBstart\fP [NAME] [OPTIONS]" |
6991b181 DG |
615 | .nf |
616 | Start tracing | |
617 | ||
618 | It will start tracing for all tracers for a specific tracing session. | |
619 | ||
620 | If NAME is omitted, the session name is taken from the .lttngrc file. | |
621 | .fi | |
622 | ||
623 | .B OPTIONS: | |
624 | ||
625 | .nf | |
c9e32613 | 626 | \-h, \-\-help |
6991b181 | 627 | Show summary of possible options and commands. |
c9e32613 | 628 | \-\-list-options |
6991b181 DG |
629 | Simple listing of options |
630 | .fi | |
631 | ||
632 | .IP | |
633 | ||
6b8f2e64 | 634 | .IP "\fBstop\fP [NAME] [OPTIONS]" |
6991b181 DG |
635 | .nf |
636 | Stop tracing | |
637 | ||
391b9c72 DG |
638 | It will stop tracing for all tracers for a specific tracing session. Before |
639 | returning, the command checks for data availability meaning that it will wait | |
640 | until the trace is readable for the session. Use \-\-no-wait to avoid this | |
641 | behavior. | |
6991b181 DG |
642 | |
643 | If NAME is omitted, the session name is taken from the .lttngrc file. | |
644 | .fi | |
645 | ||
646 | .B OPTIONS: | |
647 | ||
648 | .nf | |
c9e32613 | 649 | \-h, \-\-help |
6991b181 | 650 | Show summary of possible options and commands. |
c9e32613 | 651 | \-\-list-options |
6991b181 | 652 | Simple listing of options |
391b9c72 DG |
653 | \-\-no-wait |
654 | Don't wait for data availability. | |
6991b181 DG |
655 | .fi |
656 | ||
657 | .IP | |
658 | ||
659 | .IP "\fBversion\fP" | |
660 | .nf | |
661 | Show version information | |
662 | .fi | |
663 | ||
664 | .B OPTIONS: | |
665 | ||
666 | .nf | |
c9e32613 | 667 | \-h, \-\-help |
6991b181 | 668 | Show summary of possible options and commands. |
c9e32613 | 669 | \-\-list-options |
6991b181 DG |
670 | Simple listing of options |
671 | .fi | |
672 | ||
673 | .IP | |
674 | ||
675 | .IP "\fBview\fP [SESSION_NAME] [OPTIONS]" | |
676 | .nf | |
677 | View traces of a tracing session | |
678 | ||
679 | By default, the babeltrace viewer will be used for text viewing. | |
680 | ||
fa072eae YB |
681 | If SESSION_NAME is omitted, the session name is taken from the .lttngrc file. |
682 | ||
6991b181 DG |
683 | .fi |
684 | ||
685 | .B OPTIONS: | |
686 | ||
687 | .nf | |
c9e32613 | 688 | \-h, \-\-help |
6991b181 | 689 | Show this help |
c9e32613 | 690 | \-\-list-options |
6991b181 | 691 | Simple listing of options |
c9e32613 | 692 | \-t, \-\-trace-path PATH |
6991b181 | 693 | Trace directory path for the viewer |
c9e32613 | 694 | \-e, \-\-viewer CMD |
6991b181 DG |
695 | Specify viewer and/or options to use |
696 | This will completely override the default viewers so | |
697 | please make sure to specify the full command. The trace | |
698 | directory path of the session will be appended at the end | |
699 | to the arguments | |
700 | .fi | |
701 | ||
c206d957 | 702 | .SH "EXIT VALUES" |
6b8f2e64 DG |
703 | On success 0 is returned and a positive value on error. Value of 1 means a command |
704 | error, 2 an undefined command, 3 a fatal error and 4 a command warning meaning that | |
705 | something went wrong during the command. | |
c206d957 | 706 | |
6b8f2e64 DG |
707 | Any other value above 10, please refer to |
708 | .BR <lttng/lttng-error.h> | |
709 | for a detailed list or use lttng_strerror() to get a human readable string of | |
710 | the error code. | |
c206d957 | 711 | |
c206d957 | 712 | .PP |
6991b181 DG |
713 | .SH "ENVIRONMENT VARIABLES" |
714 | ||
715 | .PP | |
716 | Note that all command line options override environment variables. | |
717 | .PP | |
718 | ||
719 | .PP | |
05833633 | 720 | .IP "LTTNG_SESSIOND_PATH" |
c9e32613 DG |
721 | Allows one to specify the full session daemon binary path to lttng command line |
722 | tool. You can also use \-\-sessiond-path option having the same effect. | |
6991b181 | 723 | .SH "SEE ALSO" |
6b8f2e64 DG |
724 | .BR babeltrace(1), |
725 | .BR lttng-ust(3), | |
726 | .BR lttng-sessiond(8), | |
727 | .BR lttng-relayd(8), | |
728 | .BR lttng-health-check(3) | |
6991b181 DG |
729 | .SH "BUGS" |
730 | ||
6991b181 | 731 | If you encounter any issues or usability problem, please report it on our |
6b8f2e64 DG |
732 | mailing list <lttng-dev@lists.lttng.org> to help improve this project or |
733 | at https://bugs.lttng.org which is a bugtracker. | |
6991b181 DG |
734 | .SH "CREDITS" |
735 | ||
736 | .PP | |
c9e32613 | 737 | lttng is distributed under the GNU General Public License version 2. See the file |
6991b181 DG |
738 | COPYING for details. |
739 | .PP | |
740 | A Web site is available at http://lttng.org for more information on the LTTng | |
741 | project. | |
742 | .PP | |
743 | You can also find our git tree at http://git.lttng.org. | |
744 | .PP | |
745 | Mailing lists for support and development: <lttng-dev@lists.lttng.org>. | |
746 | .PP | |
747 | You can find us on IRC server irc.oftc.net (OFTC) in #lttng. | |
748 | .PP | |
749 | .SH "THANKS" | |
750 | ||
751 | .PP | |
752 | Thanks to Yannick Brosseau without whom this project would never have been so | |
753 | lean and mean! Also thanks to the Ericsson teams working on tracing which | |
fa072eae | 754 | helped us greatly with detailed bug reports and unusual test cases. |
6991b181 DG |
755 | |
756 | Thanks to our beloved packager Alexandre Montplaisir-Goncalves (Ubuntu and PPA | |
757 | maintainer) and Jon Bernard for our Debian packages. | |
758 | ||
759 | Special thanks to Michel Dagenais and the DORSAL laboratory at Polytechnique de | |
760 | Montreal for the LTTng journey. | |
c9e32613 | 761 | .PP |
6991b181 DG |
762 | .SH "AUTHORS" |
763 | ||
764 | .PP | |
765 | lttng-tools was originally written by Mathieu Desnoyers, Julien Desfossez and | |
766 | David Goulet. More people have since contributed to it. It is currently | |
767 | maintained by David Goulet <dgoulet@efficios.com>. | |
768 | .PP |