lttng cli: Accept human readable sizes for --subbuf-size
[lttng-tools.git] / doc / man / lttng.1
CommitLineData
391b9c72 1.TH "LTTNG" "1" "December 3rd, 2012" "" ""
6991b181
DG
2
3.SH "NAME"
391b9c72 4lttng \(em LTTng 2.1.x tracer control command line tool
6991b181
DG
5
6.SH "SYNOPSIS"
7
8.PP
9.nf
10lttng [OPTIONS] <COMMAND>
11.fi
12.SH "DESCRIPTION"
13
14.PP
15The LTTng project aims at providing highly efficient tracing tools for Linux.
16It's tracers help tracking down performance issues and debugging problems
17involving multiple concurrent processes and threads. Tracing across multiple
18systems is also possible.
19
fa072eae 20The \fBlttng\fP command line tool from the lttng-tools package is used to control
6991b181
DG
21both kernel and user-space tracing. Every interactions with the tracer should
22be done by this tool or by the liblttng-ctl provided with the lttng-tools
23package.
24
25LTTng uses a session daemon (lttng-sessiond(8)), acting as a tracing registry,
50a3b92a 26which allows you to interact with multiple tracers (kernel and user-space)
6991b181
DG
27inside the same container, a tracing session. Traces can be gathered from the
28kernel and/or instrumented applications (lttng-ust(3)). Aggregating and reading
29those traces is done using the babeltrace(1) text viewer.
30
50a3b92a
DG
31We introduce the notion of \fBtracing domains\fP which is essentially a type of
32tracer (kernel or user space for now). In the future, we could see a third
33tracer being for instance an hypervisor. For some commands, you'll need to
34specify on which domain the command applies (-u or -k). For instance, enabling
35a kernel event, you must specify the kernel domain to the command so we know
36for which tracer this event is for.
37
6991b181
DG
38In order to trace the kernel, the session daemon needs to be running as root.
39LTTng provides the use of a \fBtracing group\fP (default: tracing). Whomever is
40in that group can interact with the root session daemon and thus trace the
41kernel. Session daemons can co-exist meaning that you can have a session daemon
fa072eae
YB
42running as Alice that can be used to trace her applications along side with a
43root daemon or even a Bob daemon. We highly recommend to start the session
6991b181
DG
44daemon at boot time for stable and long term tracing.
45
46Every user-space applications instrumented with lttng-ust(3), will
47automatically register to the session daemon. This feature gives you the
48ability to list available traceable applications and tracepoints on a per user
49basis. (See \fBlist\fP command).
50.SH "OPTIONS"
51
52.PP
53This program follow the usual GNU command line syntax with long options starting with
54two dashes. Below is a summary of the available options.
55.PP
56
57.TP
c9e32613 58.BR "\-h, \-\-help"
6991b181
DG
59Show summary of possible options and commands.
60.TP
c9e32613 61.BR "\-v, \-\-verbose"
6991b181 62Increase verbosity.
d829b38c 63Three levels of verbosity are available which are triggered by putting additional v to
fa072eae 64the option (\-vv or \-vvv)
6991b181 65.TP
c9e32613 66.BR "\-q, \-\-quiet"
6991b181
DG
67Suppress all messages (even errors).
68.TP
c9e32613 69.BR "\-g, \-\-group NAME"
6991b181
DG
70Set unix tracing group name. (default: tracing)
71.TP
c9e32613 72.BR "\-n, \-\-no-sessiond"
6991b181
DG
73Don't automatically spawn a session daemon.
74.TP
391b9c72 75.BR "\-\-sessiond\-path PATH"
6991b181
DG
76Set session daemon full binary path.
77.TP
c9e32613 78.BR "\-\-list\-options"
6991b181
DG
79Simple listing of lttng options.
80.TP
c9e32613 81.BR "\-\-list\-commands"
6991b181
DG
82Simple listing of lttng commands.
83.SH "COMMANDS"
84
85.TP
86\fBadd-context\fP
87.nf
88Add context to event(s) and/or channel(s).
89
391b9c72
DG
90A context is basically extra information appended to a channel. For instance,
91you could ask the tracer to add the PID information for all events in a
92channel. You can also add performance monitoring unit counters (perf PMU) using
93the perf kernel API).
6991b181
DG
94
95For example, this command will add the context information 'prio' and two perf
96counters (hardware branch misses and cache misses), to all events in the trace
97data output:
98
c9e32613 99# lttng add-context \-k \-t prio \-t perf:branch-misses \-t perf:cache-misses
6991b181 100
c9e32613 101Please take a look at the help (\-h/\-\-help) for a detailed list of available
6991b181
DG
102contexts.
103
391b9c72
DG
104If no channel is given (\-c), the context is added to all channels. Otherwise
105the context will be added only to the given channel (\-c).
6991b181 106
c9e32613 107If \fB\-s, \-\-session\fP is omitted, the session name is taken from the .lttngrc
6991b181
DG
108file.
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
133Quantify LTTng overhead
134
135The LTTng calibrate command can be used to find out the combined average
136overhead of the LTTng tracer and the instrumentation mechanisms used. This
137overhead can be calibrated in terms of time or using any of the PMU performance
138counter available on the system.
139
140For now, the only calibration implemented is that of the kernel function
141instrumentation (kretprobes).
142
143* Calibrate kernel function instrumentation
144
145Let's use an example to show this calibration. We use an i7 processor with 4
146general-purpose PMU registers. This information is available by issuing dmesg,
147looking for "generic registers".
148
149This sequence of commands will gather a trace executing a kretprobe hooked on
150an empty function, gathering PMU counters LLC (Last Level Cache) misses
c9e32613 151information (see lttng add-context \-\-help to see the list of available PMU
6991b181
DG
152counters).
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
165The output from babeltrace can be saved to a text file and opened in a
166spreadsheet (e.g. oocalc) to focus on the per-PMU counter delta between
167consecutive "calibrate_entry" and "calibrate_return" events. Note that these
168counters are per-CPU, so scheduling events would need to be present to account
169for migration between CPU. Therefore, for calibration purposes, only events
170staying on the same CPU must be considered.
171
172The average result, for the i7, on 10 samples:
173
174 Average Std.Dev.
175perf_LLC_load_misses: 5.0 0.577
176perf_LLC_store_misses: 1.6 0.516
177perf_LLC_prefetch_misses: 9.0 14.742
178
179As 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.
181We can conclude from this information that LLC load and store misses can be
182accounted for quite precisely, but prefetches within a function seems to behave
183too erratically (not much causality link between the code executed and the CPU
184prefetch 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
204Create tracing session.
205
206A tracing session contains channel(s) which contains event(s). It is domain
207agnostic meaning that you can enable channels and events for either the
208user-space tracer and/or the kernel tracer. It acts like a container
209aggregating multiple tracing sources.
210
211On creation, a \fB.lttngrc\fP file is created in your $HOME directory
212containing the current session name. If NAME is omitted, a session name is
fa072eae 213automatically created having this form: 'auto-yyyymmdd-hhmmss'.
6991b181 214
c9e32613 215If 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
229Using these options, each API call can be controlled individually. For
230instance, \-C does not enable the consumer automatically. You'll need the \-e
231option 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
244proto://[HOST|IP][:PORT1[:PORT2]][/TRACE_PATH]
245
246Supported 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
258NOTE: IPv6 address MUST be enclosed in brackets '[]' (rfc2732)
6b8f2e64
DG
259
260.B EXAMPLES:
261
262# lttng create -U net://192.168.1.42
263Uses TCP and default ports for the given destination.
264
265# lttng create -U net6://[fe80::f66d:4ff:fe53:d220]
266Uses TCP, default ports and IPv6.
267
268# lttng create s1 -U net://myhost.com:3229
269Create 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
276Teardown tracing session
277
278Free memory on the session daemon and tracer side. It's gone!
279
280If 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
298Enable tracing channel
299
004f3466
DG
300To enable an event, you must enable both the event and the channel that
301contains it.
b883c01b 302
c9e32613 303If \fB\-s, \-\-session\fP is omitted, the session name is taken from the .lttngrc
6991b181 304file.
7972aab2
DG
305
306It is important to note that if a certain type of buffers is used, the session
307will be set with that type and all other subsequent channel need to have the
308same 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
70d0b120 330 Subbuffer size in bytes {+k,+M,+G} (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
db77f3a3 338 Read timer interval in µsec (UST default: 0, kernel default: 200000)
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)
1624d5b7 348\-C, \-\-tracefile-size SIZE
e132a0d4 349 Maximum size of each tracefile within a stream (in bytes).
1624d5b7
JD
350\-W, \-\-tracefile-count COUNT
351 Used in conjunction with \-C option, this will limit the number
352 of files created to the specified count.
353
354.B EXAMPLES:
355
356$ lttng enable-channel -C 4096 -W 32 chan1
357For each stream, the maximum size of a trace file will be 4096 bytes divided
358over a \fBmaximum\fP of 32 different files. The file count is appended after
359the stream number as seen in the following example. The last trace file is
360smaller than 4096 since it was not completely filled.
361
362 ~/lttng-traces/[...]/chan1_0_0 (4096)
363 ~/lttng-traces/[...]/chan1_0_1 (4096)
364 ~/lttng-traces/[...]/chan1_0_2 (3245)
365 ~/lttng-traces/[...]/chan1_1_0 (4096)
366 ...
367
368$ lttng enable-channel -C 4096
369This will create trace files of 4096 bytes and will create new ones as long as
370there is data available.
6991b181
DG
371.fi
372
373.IP
374
375.IP "\fBenable-event\fP NAME[,NAME2,...] [-k|-u] [OPTIONS]"
376.nf
377Enable tracing event
378
c9e32613 379A tracing event is always assigned to a channel. If \fB\-c, \-\-channel\fP is
6991b181 380omitted, a default channel named '\fBchannel0\fP' is created and the event is
c9e32613 381added to it. For the user-space tracer, using \fB\-a, \-\-all\fP is the same as
6991b181
DG
382using the wildcard "*".
383
c9e32613 384If \fB\-s, \-\-session\fP is omitted, the session name is taken from the .lttngrc
6991b181
DG
385file.
386.fi
387
388.B OPTIONS:
389
390.nf
c9e32613 391\-h, \-\-help
6991b181 392 Show summary of possible options and commands.
c9e32613 393\-\-list-options
6991b181 394 Simple listing of options
391b9c72 395\-s, \-\-session NAME
6991b181 396 Apply on session name
391b9c72 397\-c, \-\-channel NAME
6991b181 398 Apply on channel name
c9e32613 399\-a, \-\-all
c5650942
DG
400 Enable all tracepoints and syscalls. This actually enable a single
401 wildcard event "*".
c9e32613 402\-k, \-\-kernel
6991b181 403 Apply for the kernel tracer
c9e32613 404\-u, \-\-userspace
6991b181
DG
405 Apply for the user-space tracer
406
c9e32613 407\-\-tracepoint
6991b181
DG
408 Tracepoint event (default)
409 - userspace tracer supports wildcards at end of string. Don't forget to
410 quote to deal with bash expansion.
411 e.g.:
412 "*"
413 "app_component:na*"
391b9c72
DG
414\-\-loglevel NAME
415 Tracepoint loglevel range from 0 to loglevel. Listed in the help (\-h).
416\-\-loglevel-only NAME
417 Tracepoint loglevel (only this loglevel).
418
419 The loglevel or loglevel-only options should be combined with a
420 tracepoint name or tracepoint wildcard.
c9e32613 421\-\-probe [addr | symbol | symbol+offset]
6991b181
DG
422 Dynamic probe. Addr and offset can be octal (0NNN...), decimal (NNN...)
423 or hexadecimal (0xNNN...)
c9e32613 424\-\-function [addr | symbol | symbol+offset]
6991b181
DG
425 Dynamic function entry/return probe. Addr and offset can be octal
426 (0NNN...), decimal (NNN...) or hexadecimal (0xNNN...)
c9e32613 427\-\-syscall
6b8f2e64
DG
428 System call event. Enabling syscalls tracing (kernel tracer), you will
429 not be able to disable them with disable-event. This is a known
430 limitation. You can disable the entire channel to do the trick.
9bd578f5 431
919e300c 432\-\-filter 'expression'
6b8f2e64 433 Set a filter on a newly enabled event. Filter expression on event
ee8ccafa
MD
434 fields and context. Event recording depends on evaluation. Only
435 specify on first activation of a given event within a session.
436 Filter only allowed when enabling events within a session before
437 tracing is started. If the filter fails to link with the event
438 within the traced domain, the event will be discarded.
439 Currently, filter is only implemented for the user-space tracer.
6b8f2e64
DG
440
441 Expression examples:
442
443 'intfield > 500 && intfield < 503'
444 '(stringfield == "test" || intfield != 10) && intfield > 33'
445 'doublefield > 1.1 && intfield < 5.3'
446
447 Wildcards are allowed at the end of strings:
448 'seqfield1 == "te*"'
449 In string literals, the escape character is a '\\'. Use '\\*' for
ee8ccafa
MD
450 the '*' character, and '\\\\' for the '\\' character. Wildcard
451 match any sequence of characters, including an empty sub-string
452 (match 0 or more characters).
453
454 Context information can be used for filtering. The examples
455 below show usage of context filtering on process name (with a
456 wildcard), process ID range, and unique thread ID for filtering.
457 The process and thread ID of running applications can be found
458 under columns "PID" and "LWP" of the "ps -eLf" command.
459
460 '$ctx.procname == "demo*"'
461 '$ctx.vpid >= 4433 && $ctx.vpid < 4455'
462 '$ctx.vtid == 1234'
6991b181
DG
463.fi
464
c9e32613 465.IP "\fBdisable-channel\fP NAME[,NAME2,...] [\-k|\-u] [OPTIONS]"
6991b181
DG
466.nf
467Disable tracing channel
468
469Disabling a channel makes all event(s) in that channel to stop tracing. You can
470enable it back by calling \fBlttng enable-channel NAME\fP again.
471
c9e32613 472If \fB\-s, \-\-session\fP is omitted, the session name is taken from the .lttngrc
6991b181
DG
473file.
474.fi
475
476.B OPTIONS:
477
6b8f2e64
DG
478.nf
479\-h, \-\-help
480 Show summary of possible options and commands.
481\-\-list-options
482 Simple listing of options
483\-s, \-\-session NAME
6991b181 484 Apply on session name
c9e32613 485\-k, \-\-kernel
6991b181 486 Apply for the kernel tracer
c9e32613 487\-u, \-\-userspace
6991b181
DG
488 Apply for the user-space tracer
489.fi
490
c9e32613 491.IP "\fBdisable-event\fP NAME[,NAME2,...] [\-k|\-u] [OPTIONS]"
6991b181
DG
492.nf
493Disable tracing event
494
495The event, once disabled, can be re-enabled by calling \fBlttng enable-event
496NAME\fP again.
497
c9e32613 498If \fB\-s, \-\-session\fP is omitted, the session name is taken from the .lttngrc
6991b181
DG
499file.
500.fi
501
502.B OPTIONS:
503
504.nf
c9e32613 505\-h, \-\-help
6991b181 506 Show summary of possible options and commands.
c9e32613 507\-\-list-options
6991b181 508 Simple listing of options
391b9c72 509\-s, \-\-session NAME
6991b181 510 Apply on session name
c5650942
DG
511\-a, \-\-all-events
512 Disable all events. This does NOT disable "*" but rather
513 every known events of the session.
c9e32613 514\-k, \-\-kernel
6991b181 515 Apply for the kernel tracer
c9e32613 516\-u, \-\-userspace
6991b181
DG
517 Apply for the user-space tracer
518.fi
519
c9e32613 520.IP "\fBlist\fP [\-k|\-u] [SESSION [SESSION_OPTIONS]]"
6991b181 521.nf
c9e32613 522List tracing session information.
6991b181
DG
523
524With no arguments, it will list available tracing session(s).
525
fa072eae
YB
526With the session name, it will display the details of the session including
527the trace file path, the associated channels and their state (activated
d829b38c 528and deactivated), the activated events and more.
fa072eae 529
c9e32613 530With \-k alone, it will list all available kernel events (except the system
6991b181 531calls events).
c9e32613
DG
532With \-u alone, it will list all available user-space events from registered
533applications. Here is an example of 'lttng list \-u':
6991b181
DG
534
535PID: 7448 - Name: /tmp/lttng-ust/tests/hello/.libs/lt-hello
536 ust_tests_hello:tptest_sighandler (type: tracepoint)
537 ust_tests_hello:tptest (type: tracepoint)
538
539You can now enable any event listed by using the name :
540\fBust_tests_hello:tptest\fP.
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 549 Simple listing of options
c9e32613 550\-k, \-\-kernel
d829b38c 551 Select kernel domain
c9e32613 552\-u, \-\-userspace
6991b181
DG
553 Select user-space domain.
554
6b8f2e64
DG
555.B SESSION OPTIONS:
556
c9e32613 557\-c, \-\-channel NAME
6991b181 558 List details of a channel
c9e32613 559\-d, \-\-domain
6991b181
DG
560 List available domain(s)
561.fi
562
563.IP "\fBset-session\fP NAME"
564.nf
565Set current session name
566
567Will change the session name in the .lttngrc file.
568.fi
569
570.B OPTIONS:
571
572.nf
c9e32613 573\-h, \-\-help
6991b181 574 Show summary of possible options and commands.
c9e32613 575\-\-list-options
6991b181
DG
576 Simple listing of options
577.fi
578
579.IP
580
6b8f2e64 581.IP "\fBstart\fP [NAME] [OPTIONS]"
6991b181
DG
582.nf
583Start tracing
584
585It will start tracing for all tracers for a specific tracing session.
586
587If 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
DG
596 Simple listing of options
597.fi
598
599.IP
600
6b8f2e64 601.IP "\fBstop\fP [NAME] [OPTIONS]"
6991b181
DG
602.nf
603Stop tracing
604
391b9c72
DG
605It will stop tracing for all tracers for a specific tracing session. Before
606returning, the command checks for data availability meaning that it will wait
607until the trace is readable for the session. Use \-\-no-wait to avoid this
608behavior.
6991b181
DG
609
610If NAME is omitted, the session name is taken from the .lttngrc file.
611.fi
612
613.B OPTIONS:
614
615.nf
c9e32613 616\-h, \-\-help
6991b181 617 Show summary of possible options and commands.
c9e32613 618\-\-list-options
6991b181 619 Simple listing of options
391b9c72
DG
620\-\-no-wait
621 Don't wait for data availability.
6991b181
DG
622.fi
623
624.IP
625
626.IP "\fBversion\fP"
627.nf
628Show version information
629.fi
630
631.B OPTIONS:
632
633.nf
c9e32613 634\-h, \-\-help
6991b181 635 Show summary of possible options and commands.
c9e32613 636\-\-list-options
6991b181
DG
637 Simple listing of options
638.fi
639
640.IP
641
642.IP "\fBview\fP [SESSION_NAME] [OPTIONS]"
643.nf
644View traces of a tracing session
645
646By default, the babeltrace viewer will be used for text viewing.
647
fa072eae
YB
648If SESSION_NAME is omitted, the session name is taken from the .lttngrc file.
649
6991b181
DG
650.fi
651
652.B OPTIONS:
653
654.nf
c9e32613 655\-h, \-\-help
6991b181 656 Show this help
c9e32613 657\-\-list-options
6991b181 658 Simple listing of options
c9e32613 659\-t, \-\-trace-path PATH
6991b181 660 Trace directory path for the viewer
c9e32613 661\-e, \-\-viewer CMD
6991b181
DG
662 Specify viewer and/or options to use
663 This will completely override the default viewers so
664 please make sure to specify the full command. The trace
665 directory path of the session will be appended at the end
666 to the arguments
667.fi
668
c206d957 669.SH "EXIT VALUES"
6b8f2e64
DG
670On success 0 is returned and a positive value on error. Value of 1 means a command
671error, 2 an undefined command, 3 a fatal error and 4 a command warning meaning that
672something went wrong during the command.
c206d957 673
6b8f2e64
DG
674Any other value above 10, please refer to
675.BR <lttng/lttng-error.h>
676for a detailed list or use lttng_strerror() to get a human readable string of
677the error code.
c206d957 678
c206d957 679.PP
6991b181
DG
680.SH "ENVIRONMENT VARIABLES"
681
682.PP
683Note that all command line options override environment variables.
684.PP
685
686.PP
05833633 687.IP "LTTNG_SESSIOND_PATH"
c9e32613
DG
688Allows one to specify the full session daemon binary path to lttng command line
689tool. You can also use \-\-sessiond-path option having the same effect.
6991b181 690.SH "SEE ALSO"
6b8f2e64
DG
691.BR babeltrace(1),
692.BR lttng-ust(3),
693.BR lttng-sessiond(8),
694.BR lttng-relayd(8),
695.BR lttng-health-check(3)
6991b181
DG
696.SH "BUGS"
697
6991b181 698If you encounter any issues or usability problem, please report it on our
6b8f2e64
DG
699mailing list <lttng-dev@lists.lttng.org> to help improve this project or
700at https://bugs.lttng.org which is a bugtracker.
6991b181
DG
701.SH "CREDITS"
702
703.PP
c9e32613 704lttng is distributed under the GNU General Public License version 2. See the file
6991b181
DG
705COPYING for details.
706.PP
707A Web site is available at http://lttng.org for more information on the LTTng
708project.
709.PP
710You can also find our git tree at http://git.lttng.org.
711.PP
712Mailing lists for support and development: <lttng-dev@lists.lttng.org>.
713.PP
714You can find us on IRC server irc.oftc.net (OFTC) in #lttng.
715.PP
716.SH "THANKS"
717
718.PP
719Thanks to Yannick Brosseau without whom this project would never have been so
720lean and mean! Also thanks to the Ericsson teams working on tracing which
fa072eae 721helped us greatly with detailed bug reports and unusual test cases.
6991b181
DG
722
723Thanks to our beloved packager Alexandre Montplaisir-Goncalves (Ubuntu and PPA
724maintainer) and Jon Bernard for our Debian packages.
725
726Special thanks to Michel Dagenais and the DORSAL laboratory at Polytechnique de
727Montreal for the LTTng journey.
c9e32613 728.PP
6991b181
DG
729.SH "AUTHORS"
730
731.PP
732lttng-tools was originally written by Mathieu Desnoyers, Julien Desfossez and
733David Goulet. More people have since contributed to it. It is currently
734maintained by David Goulet <dgoulet@efficios.com>.
735.PP
This page took 0.061858 seconds and 5 git commands to generate.