Manpage: other layout cleanups
[lttng-tools.git] / doc / man / lttng.1
CommitLineData
b107a0b1 1.TH "LTTNG" "1" "July 18th, 2013" "" ""
6991b181
DG
2
3.SH "NAME"
c5db699c 4lttng \(em LTTng 2.x tracer control command line tool
6991b181
DG
5
6.SH "SYNOPSIS"
7
8.PP
6991b181 9lttng [OPTIONS] <COMMAND>
6991b181
DG
10.SH "DESCRIPTION"
11
12.PP
13The LTTng project aims at providing highly efficient tracing tools for Linux.
14It's tracers help tracking down performance issues and debugging problems
15involving multiple concurrent processes and threads. Tracing across multiple
16systems is also possible.
17
fa072eae 18The \fBlttng\fP command line tool from the lttng-tools package is used to control
6991b181
DG
19both kernel and user-space tracing. Every interactions with the tracer should
20be done by this tool or by the liblttng-ctl provided with the lttng-tools
21package.
22
23LTTng uses a session daemon (lttng-sessiond(8)), acting as a tracing registry,
50a3b92a 24which allows you to interact with multiple tracers (kernel and user-space)
6991b181
DG
25inside the same container, a tracing session. Traces can be gathered from the
26kernel and/or instrumented applications (lttng-ust(3)). Aggregating and reading
27those traces is done using the babeltrace(1) text viewer.
28
50a3b92a
DG
29We introduce the notion of \fBtracing domains\fP which is essentially a type of
30tracer (kernel or user space for now). In the future, we could see a third
31tracer being for instance an hypervisor. For some commands, you'll need to
32specify on which domain the command applies (-u or -k). For instance, enabling
33a kernel event, you must specify the kernel domain to the command so we know
34for which tracer this event is for.
35
6991b181
DG
36In order to trace the kernel, the session daemon needs to be running as root.
37LTTng provides the use of a \fBtracing group\fP (default: tracing). Whomever is
38in that group can interact with the root session daemon and thus trace the
39kernel. Session daemons can co-exist meaning that you can have a session daemon
fa072eae
YB
40running as Alice that can be used to trace her applications along side with a
41root daemon or even a Bob daemon. We highly recommend to start the session
6991b181
DG
42daemon at boot time for stable and long term tracing.
43
44Every user-space applications instrumented with lttng-ust(3), will
45automatically register to the session daemon. This feature gives you the
46ability to list available traceable applications and tracepoints on a per user
47basis. (See \fBlist\fP command).
48.SH "OPTIONS"
49
50.PP
51This program follow the usual GNU command line syntax with long options starting with
52two dashes. Below is a summary of the available options.
53.PP
54
55.TP
c9e32613 56.BR "\-h, \-\-help"
6991b181
DG
57Show summary of possible options and commands.
58.TP
c9e32613 59.BR "\-v, \-\-verbose"
6991b181 60Increase verbosity.
d829b38c 61Three levels of verbosity are available which are triggered by putting additional v to
fa072eae 62the option (\-vv or \-vvv)
6991b181 63.TP
c9e32613 64.BR "\-q, \-\-quiet"
6991b181
DG
65Suppress all messages (even errors).
66.TP
c9e32613 67.BR "\-g, \-\-group NAME"
6991b181
DG
68Set unix tracing group name. (default: tracing)
69.TP
c9e32613 70.BR "\-n, \-\-no-sessiond"
6991b181
DG
71Don't automatically spawn a session daemon.
72.TP
391b9c72 73.BR "\-\-sessiond\-path PATH"
6991b181
DG
74Set session daemon full binary path.
75.TP
c9e32613 76.BR "\-\-list\-options"
6991b181
DG
77Simple listing of lttng options.
78.TP
c9e32613 79.BR "\-\-list\-commands"
6991b181
DG
80Simple listing of lttng commands.
81.SH "COMMANDS"
82
812a5eb7 83.PP
ee2758e5 84\fBadd-context\fP [OPTIONS]
812a5eb7 85.RS
6991b181
DG
86Add context to event(s) and/or channel(s).
87
391b9c72
DG
88A context is basically extra information appended to a channel. For instance,
89you could ask the tracer to add the PID information for all events in a
90channel. You can also add performance monitoring unit counters (perf PMU) using
91the perf kernel API).
6991b181
DG
92
93For example, this command will add the context information 'prio' and two perf
94counters (hardware branch misses and cache misses), to all events in the trace
95data output:
96
812a5eb7
MD
97.nf
98# lttng add-context \-k \-t prio \-t perf:branch-misses \\
99 \-t perf:cache-misses
100.fi
6991b181 101
c9e32613 102Please take a look at the help (\-h/\-\-help) for a detailed list of available
6991b181
DG
103contexts.
104
bd337b98
DG
105If no channel is given (\-c), the context is added to all channels that were
106already enabled. If the session has no channel, a default channel is created.
107Otherwise the context will be added only to the given channel (\-c).
6991b181 108
c9e32613 109If \fB\-s, \-\-session\fP is omitted, the session name is taken from the .lttngrc
6991b181 110file.
6991b181
DG
111
112.B OPTIONS:
113
812a5eb7
MD
114.TP
115.BR "\-h, \-\-help"
116Show summary of possible options and commands.
117.TP
118.BR "\-s, \-\-session NAME"
119Apply on session name.
120.TP
121.BR "\-c, \-\-channel NAME"
122Apply on channel name.
123.TP
124.BR "\-k, \-\-kernel"
125Apply for the kernel tracer
126.TP
127.BR "\-u, \-\-userspace"
128Apply for the user-space tracer
129.TP
130.BR "\-t, \-\-type TYPE"
131Context type. You can repeat this option on the command line. Please
132use "lttng add-context \-h" to list all available types.
133.RE
134.PP
6991b181 135
22019883
MD
136.PP
137\fBcalibrate\fP [OPTIONS]
138.RS
6991b181
DG
139Quantify LTTng overhead
140
141The LTTng calibrate command can be used to find out the combined average
142overhead of the LTTng tracer and the instrumentation mechanisms used. This
143overhead can be calibrated in terms of time or using any of the PMU performance
144counter available on the system.
145
146For now, the only calibration implemented is that of the kernel function
147instrumentation (kretprobes).
148
149* Calibrate kernel function instrumentation
150
151Let's use an example to show this calibration. We use an i7 processor with 4
152general-purpose PMU registers. This information is available by issuing dmesg,
153looking for "generic registers".
154
155This sequence of commands will gather a trace executing a kretprobe hooked on
156an empty function, gathering PMU counters LLC (Last Level Cache) misses
c9e32613 157information (see lttng add-context \-\-help to see the list of available PMU
6991b181
DG
158counters).
159
22019883 160.nf
6991b181 161# lttng create calibrate-function
22019883
MD
162# lttng enable-event calibrate \-\-kernel \\
163 \-\-function lttng_calibrate_kretprobe
164# lttng add-context \-\-kernel \-t perf:LLC-load-misses \\
165 \-t perf:LLC-store-misses \\
166 \-t perf:LLC-prefetch-misses
6991b181
DG
167# lttng start
168# for a in $(seq 1 10); do \\
c9e32613 169 lttng calibrate \-\-kernel \-\-function;
6991b181
DG
170 done
171# lttng destroy
22019883
MD
172# babeltrace $(ls \-1drt ~/lttng-traces/calibrate-function-* \\
173 | tail \-n 1)
174.fi
6991b181
DG
175
176The output from babeltrace can be saved to a text file and opened in a
177spreadsheet (e.g. oocalc) to focus on the per-PMU counter delta between
178consecutive "calibrate_entry" and "calibrate_return" events. Note that these
179counters are per-CPU, so scheduling events would need to be present to account
180for migration between CPU. Therefore, for calibration purposes, only events
181staying on the same CPU must be considered.
182
183The average result, for the i7, on 10 samples:
184
22019883 185.nf
6991b181
DG
186 Average Std.Dev.
187perf_LLC_load_misses: 5.0 0.577
188perf_LLC_store_misses: 1.6 0.516
189perf_LLC_prefetch_misses: 9.0 14.742
22019883 190.fi
6991b181
DG
191
192As we can notice, the load and store misses are relatively stable across runs
193(their standard deviation is relatively low) compared to the prefetch misses.
194We can conclude from this information that LLC load and store misses can be
195accounted for quite precisely, but prefetches within a function seems to behave
196too erratically (not much causality link between the code executed and the CPU
197prefetch activity) to be accounted for.
6991b181
DG
198
199.B OPTIONS:
200
22019883
MD
201.TP
202.BR "\-h, \-\-help"
203Show summary of possible options and commands.
204.TP
205.BR "\-k, \-\-kernel"
206Apply for the kernel tracer
207.TP
208.BR "\-u, \-\-userspace"
209Apply for the user-space tracer
210.TP
211.BR "\-\-function"
212Dynamic function entry/return probe (default)
213.RE
214.PP
6991b181 215
ee2758e5
MD
216.PP
217.IP \fBcreate\fP [NAME] [OPTIONS]
218.RS
6991b181
DG
219Create tracing session.
220
221A tracing session contains channel(s) which contains event(s). It is domain
222agnostic meaning that you can enable channels and events for either the
223user-space tracer and/or the kernel tracer. It acts like a container
224aggregating multiple tracing sources.
225
226On creation, a \fB.lttngrc\fP file is created in your $HOME directory
227containing the current session name. If NAME is omitted, a session name is
fa072eae 228automatically created having this form: 'auto-yyyymmdd-hhmmss'.
6991b181 229
c9e32613 230If no \fB\-o, \-\-output\fP is specified, the traces will be written in
6991b181 231$HOME/lttng-traces.
feb0f3e5
AM
232
233The $HOME environment variable can be overridden by defining the environment
234variable LTTNG_HOME. This is useful when the user running the commands has
235a non-writeable home directory.
6991b181
DG
236
237.B OPTIONS:
238
ee2758e5
MD
239.TP
240.BR "\-h, \-\-help"
241Show summary of possible options and commands.
242.TP
243.BR "\-\-list-options"
244Simple listing of options
245.TP
246.BR "\-o, \-\-output PATH"
247Specify output path for traces
248.TP
249.BR "\-\-no-output"
250Traces will not be outputed
251.TP
252.BR "\-\-snapshot"
253Set the session in snapshot mode. Created in no-output mode and uses the
254URL, if one, as the default snapshot output. Every channel will be set
255in overwrite mode and with mmap output (splice not supported).
6b8f2e64 256
ee2758e5
MD
257.TP
258.BR "\-U, \-\-set-url=URL"
259Set URL for the consumer output destination. It is persistent for the
260session lifetime. Redo the command to change it. This will set both data
261and control URL for network.
262.TP
263.BR "\-C, \-\-ctrl-url=URL"
264Set control path URL. (Must use -D also)
265.TP
266.BR "\-D, \-\-data-url=URL"
267Set data path URL. (Must use -C also)
268.PP
6b8f2e64
DG
269Using these options, each API call can be controlled individually. For
270instance, \-C does not enable the consumer automatically. You'll need the \-e
271option for that.
272
785d2d0d
DG
273.B URL FORMAT:
274
275proto://[HOST|IP][:PORT1[:PORT2]][/TRACE_PATH]
276
277Supported protocols are (proto):
ee2758e5
MD
278.TP
279.BR "file://..."
280Local filesystem full path.
785d2d0d 281
ee2758e5
MD
282.TP
283.BR "net://..."
284This will use the default network transport layer which is TCP for both
285control (PORT1) and data port (PORT2). The default ports are
286respectively 5342 and 5343. Note that net[6]:// is not yet supported.
785d2d0d 287
ee2758e5
MD
288.TP
289.BR "tcp[6]://..."
290Can only be used with -C and -D together
785d2d0d
DG
291
292NOTE: IPv6 address MUST be enclosed in brackets '[]' (rfc2732)
6b8f2e64
DG
293
294.B EXAMPLES:
295
ee2758e5 296.nf
6b8f2e64 297# lttng create -U net://192.168.1.42
ee2758e5 298.fi
6b8f2e64
DG
299Uses TCP and default ports for the given destination.
300
ee2758e5 301.nf
6b8f2e64 302# lttng create -U net6://[fe80::f66d:4ff:fe53:d220]
ee2758e5 303.fi
6b8f2e64
DG
304Uses TCP, default ports and IPv6.
305
ee2758e5 306.nf
6b8f2e64 307# lttng create s1 -U net://myhost.com:3229
6991b181 308.fi
ee2758e5
MD
309Create session s1 and set its consumer to myhost.com on port 3229 for control.
310.RE
311.PP
6991b181 312
f2b14ef1
MD
313.PP
314\fBdestroy\fP [NAME] [OPTIONS]
315.RS
6991b181
DG
316Teardown tracing session
317
318Free memory on the session daemon and tracer side. It's gone!
319
320If NAME is omitted, the session name is taken from the .lttngrc file.
6991b181
DG
321
322.B OPTIONS:
323
f2b14ef1
MD
324.TP
325.BR "\-h, \-\-help"
326Show summary of possible options and commands.
327.TP
328.BR "\-a, \-\-all"
329Destroy all sessions
330.TP
331.BR "\-\-list-options"
332Simple listing of options
333.RE
334.PP
6991b181 335
05be3802
MD
336.PP
337\fBenable-channel\fP NAME[,NAME2,...] (\-k | \-u) [OPTIONS]
338.RS
6991b181
DG
339Enable tracing channel
340
004f3466
DG
341To enable an event, you must enable both the event and the channel that
342contains it.
b883c01b 343
c9e32613 344If \fB\-s, \-\-session\fP is omitted, the session name is taken from the .lttngrc
6991b181 345file.
7972aab2 346
05be3802
MD
347Exactly one of \-k or -u must be specified.
348
7972aab2 349It is important to note that if a certain type of buffers is used, the session
bd337b98 350will be set with that type and all other subsequent channel needs to have the
7972aab2 351same type.
bd337b98 352
d2f11c4a
DG
353Note that once the session has been started and enabled on the tracer side,
354it's not possible anymore to enable a new channel for that session.
6991b181
DG
355
356.B OPTIONS:
357
05be3802
MD
358.TP
359.BR "\-h, \-\-help"
360Show this help
361.TP
362.BR "\-\-list-options"
363Simple listing of options
364.TP
365.BR "\-s, \-\-session NAME"
366Apply on session name
367.TP
368.BR "\-k, \-\-kernel"
369Apply to the kernel tracer
370.TP
371.BR "\-u, \-\-userspace"
372Apply to the user-space tracer
373.TP
374.BR "\-\-discard"
375Discard event when subbuffers are full (default)
376.TP
377.BR "\-\-overwrite"
378Flight recorder mode : overwrites events when subbuffers are full
379.TP
380.BR "\-\-subbuf-size SIZE"
381Subbuffer size in bytes {+k,+M,+G}.
382(default UST uid: 131072, UST pid: 4096, kernel: 262144, metadata: 4096)
383Rounded up to the next power of 2.
384
385The minimum subbuffer size, for each tracer, is the max value between
386the default above and the system page size. You can issue this command
387to get the current page size on your system: \fB$ getconf PAGE_SIZE\fP
388.TP
389.BR "\-\-num-subbuf NUM"
390Number of subbuffers. (default UST uid: 4, UST pid: 4, kernel: 4,
391metadata: 2) Rounded up to the next power of 2.
392.TP
393.BR "\-\-switch-timer USEC"
394Switch subbuffer timer interval in µsec.
395(default UST uid: 0, UST pid: 0, kernel: 0, metadata: 0)
396.TP
397.BR "\-\-read-timer USEC"
398Read timer interval in µsec.
399(default UST uid: 0, UST pid: 0, kernel: 200000, metadata: 0)
400.TP
401.BR "\-\-output TYPE"
402Channel output type. Possible values: mmap, splice
403(default UST uid: mmap, UST pid: mmap, kernel: splice, metadata: mmap)
404.TP
405.BR "\-\-buffers-uid"
406Use per UID buffer (\-u only). Buffers are shared between applications
407that have the same UID.
408.TP
409.BR "\-\-buffers-pid"
410Use per PID buffer (\-u only). Each application has its own buffers.
411.TP
412.BR "\-\-buffers-global"
413Use shared buffer for the whole system (\-k only)
414.TP
415.BR "\-C, \-\-tracefile-size SIZE"
416Maximum size of each tracefile within a stream (in bytes).
4170 means unlimited. (default: 0)
418.TP
419.BR "\-W, \-\-tracefile-count COUNT"
420Used in conjunction with \-C option, this will limit the number of files
421created to the specified count. 0 means unlimited. (default: 0)
1624d5b7
JD
422
423.B EXAMPLES:
424
05be3802
MD
425.nf
426$ lttng enable-channel -k -C 4096 -W 32 chan1
427.fi
cea28771
DG
428For each stream, the maximum size of each trace file will be 4096 bytes, and
429there will be a maximum of 32 different files. The file count is appended after
1624d5b7
JD
430the stream number as seen in the following example. The last trace file is
431smaller than 4096 since it was not completely filled.
432
05be3802 433.nf
1624d5b7
JD
434 ~/lttng-traces/[...]/chan1_0_0 (4096)
435 ~/lttng-traces/[...]/chan1_0_1 (4096)
436 ~/lttng-traces/[...]/chan1_0_2 (3245)
437 ~/lttng-traces/[...]/chan1_1_0 (4096)
438 ...
05be3802 439.fi
1624d5b7 440
05be3802
MD
441.nf
442$ lttng enable-channel -k -C 4096
443.fi
1624d5b7
JD
444This will create trace files of 4096 bytes and will create new ones as long as
445there is data available.
05be3802
MD
446.RE
447.PP
6991b181 448
6a240cd9
MD
449.PP
450\fBenable-event\fP NAME[,NAME2,...] [-k|-u] [OPTIONS]
451.RS
6991b181
DG
452Enable tracing event
453
c9e32613 454A tracing event is always assigned to a channel. If \fB\-c, \-\-channel\fP is
6991b181 455omitted, a default channel named '\fBchannel0\fP' is created and the event is
c9e32613 456added to it. For the user-space tracer, using \fB\-a, \-\-all\fP is the same as
6991b181
DG
457using the wildcard "*".
458
c9e32613 459If \fB\-s, \-\-session\fP is omitted, the session name is taken from the .lttngrc
6991b181 460file.
6991b181
DG
461
462.B OPTIONS:
463
6a240cd9
MD
464.TP
465.BR "\-h, \-\-help"
466Show summary of possible options and commands.
467.TP
468.BR "\-\-list-options"
469Simple listing of options
470.TP
471.BR "\-s, \-\-session NAME"
472Apply on session name
473.TP
474.BR "\-c, \-\-channel NAME"
475Apply on channel name
476.TP
477.BR "\-a, \-\-all"
478Enable all tracepoints and syscalls. This actually enable a single
479wildcard event "*".
480.TP
481.BR "\-k, \-\-kernel"
482Apply for the kernel tracer
483.TP
484.BR "\-u, \-\-userspace"
485Apply for the user-space tracer
486.TP
487.BR "\-\-tracepoint"
488Tracepoint event (default). Userspace tracer supports wildcards at end
489of string. Don't forget to quote to deal with bash expansion.
490e.g.:
6991b181 491.nf
6991b181
DG
492 "*"
493 "app_component:na*"
6991b181 494.fi
6a240cd9
MD
495.TP
496.BR "\-\-loglevel NAME"
497Tracepoint loglevel range from 0 to loglevel. Listed in the help (\-h).
498.TP
499.BR "\-\-loglevel-only NAME"
500Tracepoint loglevel (only this loglevel).
501The loglevel or loglevel-only options should be combined with a
502tracepoint name or tracepoint wildcard.
503.TP
504.BR "\-\-probe (addr | symbol | symbol+offset)"
505Dynamic probe. Addr and offset can be octal (0NNN...), decimal (NNN...)
506or hexadecimal (0xNNN...)
507.TP
508.BR "\-\-function (addr | symbol | symbol+offset)"
509Dynamic function entry/return probe. Addr and offset can be octal
510(0NNN...), decimal (NNN...) or hexadecimal (0xNNN...)
511.TP
512.BR "\-\-syscall"
513System call event. Enabling syscalls tracing (kernel tracer), you will
514not be able to disable them with disable-event. This is a known
515limitation. You can disable the entire channel to do the trick.
516.TP
517.BR "\-\-filter 'expression'"
518Set a filter on a newly enabled event. Filter expression on event
519fields and context. Event recording depends on evaluation. Only
520specify on first activation of a given event within a session.
521Filter only allowed when enabling events within a session before
522tracing is started. If the filter fails to link with the event
523within the traced domain, the event will be discarded.
524Currently, filter is only implemented for the user-space tracer.
525
526Expression examples:
527
528.nf
529 'intfield > 500 && intfield < 503'
530 '(strfield == "test" || intfield != 10) && intfield > 33'
531 'doublefield > 1.1 && intfield < 5.3'
532.fi
533
534Wildcards are allowed at the end of strings:
535 'seqfield1 == "te*"'
536In string literals, the escape character is a '\\'. Use '\\*' for
537the '*' character, and '\\\\' for the '\\' character. Wildcard
538match any sequence of characters, including an empty sub-string
539(match 0 or more characters).
540
541Context information can be used for filtering. The examples below show
542usage of context filtering on process name (with a wildcard), process ID
543range, and unique thread ID for filtering. The process and thread ID of
544running applications can be found under columns "PID" and "LWP" of the
545"ps -eLf" command.
546
547.nf
548 '$ctx.procname == "demo*"'
549 '$ctx.vpid >= 4433 && $ctx.vpid < 4455'
550 '$ctx.vtid == 1234'
551.fi
552
553.RE
554.PP
6991b181 555
272c6a17
MD
556.PP
557\fBdisable-channel\fP NAME[,NAME2,...] (\-k | \-u) [OPTIONS]
558.RS
6991b181
DG
559Disable tracing channel
560
561Disabling a channel makes all event(s) in that channel to stop tracing. You can
562enable it back by calling \fBlttng enable-channel NAME\fP again.
563
c9e32613 564If \fB\-s, \-\-session\fP is omitted, the session name is taken from the .lttngrc
6991b181 565file.
6991b181
DG
566
567.B OPTIONS:
568
272c6a17
MD
569.TP
570.BR "\-h, \-\-help"
571Show summary of possible options and commands.
572.TP
573.BR "\-\-list-options"
574Simple listing of options
575.TP
576.BR "\-s, \-\-session NAME"
577Apply on session name
578.TP
579.BR "\-k, \-\-kernel"
580Apply for the kernel tracer
581.TP
582.BR "\-u, \-\-userspace"
583Apply for the user-space tracer
584.RE
585.PP
6991b181 586
c138a39b
MD
587.PP
588\fBdisable-event\fP NAME[,NAME2,...] (\-k | \-u) [OPTIONS]
589.RS
6991b181
DG
590Disable tracing event
591
592The event, once disabled, can be re-enabled by calling \fBlttng enable-event
593NAME\fP again.
594
c9e32613 595If \fB\-s, \-\-session\fP is omitted, the session name is taken from the .lttngrc
6991b181 596file.
6991b181
DG
597
598.B OPTIONS:
599
c138a39b
MD
600.TP
601.BR "\-h, \-\-help"
602Show summary of possible options and commands.
603.TP
604.BR "\-\-list-options"
605Simple listing of options
606.TP
607.BR "\-s, \-\-session NAME"
608Apply on session name
609.TP
610.BR "\-a, \-\-all-events"
611Disable all events. This does NOT disable "*" but rather every known
612events of the session.
613.TP
614.BR "\-k, \-\-kernel"
615Apply for the kernel tracer
616.TP
617.BR "\-u, \-\-userspace"
618Apply for the user-space tracer
619.RE
620.PP
6991b181 621
747361fe
MD
622.PP
623\fBlist\fP [OPTIONS] [SESSION [SESSION OPTIONS]]
624.RS
c9e32613 625List tracing session information.
6991b181
DG
626
627With no arguments, it will list available tracing session(s).
628
fa072eae
YB
629With the session name, it will display the details of the session including
630the trace file path, the associated channels and their state (activated
d829b38c 631and deactivated), the activated events and more.
fa072eae 632
c9e32613 633With \-k alone, it will list all available kernel events (except the system
6991b181 634calls events).
c9e32613
DG
635With \-u alone, it will list all available user-space events from registered
636applications. Here is an example of 'lttng list \-u':
6991b181 637
747361fe 638.nf
6991b181
DG
639PID: 7448 - Name: /tmp/lttng-ust/tests/hello/.libs/lt-hello
640 ust_tests_hello:tptest_sighandler (type: tracepoint)
641 ust_tests_hello:tptest (type: tracepoint)
747361fe 642.fi
6991b181
DG
643
644You can now enable any event listed by using the name :
645\fBust_tests_hello:tptest\fP.
6991b181
DG
646
647.B OPTIONS:
648
747361fe
MD
649.TP
650.BR "\-h, \-\-help"
651Show summary of possible options and commands.
652.TP
653.BR "\-\-list-options"
654Simple listing of options
655.TP
656.BR "\-k, \-\-kernel"
657Select kernel domain
658.TP
659.BR "\-u, \-\-userspace"
660Select user-space domain.
6991b181 661
747361fe 662.PP
6b8f2e64
DG
663.B SESSION OPTIONS:
664
747361fe
MD
665.TP
666.BR "\-c, \-\-channel NAME"
667List details of a channel
668.TP
669.BR "\-d, \-\-domain"
670List available domain(s)
671.RE
672.PP
6991b181 673
7c96a096
MD
674.PP
675\fBset-session\fP NAME [OPTIONS]
676.RS
6991b181
DG
677Set current session name
678
679Will change the session name in the .lttngrc file.
6991b181
DG
680
681.B OPTIONS:
682
7c96a096
MD
683.TP
684.BR "\-h, \-\-help"
685Show summary of possible options and commands.
686.TP
687.BR "\-\-list-options"
688Simple listing of options
689.RE
690.PP
6991b181 691
8df3bfe9
MD
692.PP
693\fBsnapshot\fP [OPTIONS] ACTION
694.RS
b872baea 695Snapshot command for LTTng session.
b872baea
DG
696
697.B OPTIONS:
698
8df3bfe9
MD
699.TP
700.BR "\-h, \-\-help"
701Show summary of possible options and commands.
702.TP
703.BR "\-\-list-options"
704Simple listing of options
b872baea 705
8df3bfe9 706.PP
b872baea
DG
707.B ACTION:
708
8df3bfe9 709.TP
b872baea
DG
710\fBadd-output\fP [-m <SIZE>] [-s <NAME>] [-n <NAME>] <URL> | -C <URL> -D <URL>
711
712Setup and add an snapshot output for a session. Output are the destination
713where the snapshot will be sent. Only one output is permitted. To change it,
714you'll need to delete it and add back the new one.
715
8df3bfe9 716.TP
b872baea
DG
717\fBdel-output\fP ID | NAME [-s <NAME>]
718
719Delete an output for a session using the ID. You can either specify the
720output's ID that can be found with list-output or the name.
721
8df3bfe9 722.TP
b872baea
DG
723\fBlist-output\fP [-s <NAME>]
724
725List the output of a session. Attributes of the output are printed.
726
8df3bfe9 727.TP
b872baea
DG
728\fBrecord\fP [-m <SIZE>] [-s <NAME>] [-n <NAME>] [<URL> | -C <URL> -D <URL>]
729
730Snapshot a session's buffer(s) for all domains. If an URL is specified, it is
731used instead of a previously added output. Specifying only a name or/and a max
732size will override the current output values. For instance, you can record a
733snapshot with a custom maximum size or with a different name.
734
8df3bfe9 735.nf
b872baea
DG
736$ lttng add-output -n mysnapshot file:///data/snapshot
737[...]
738$ lttng snapshot record -n new_name_snapshot
8df3bfe9 739.fi
b872baea
DG
740
741The above will create a snapshot in /data/snapshot/new_name_snapshot* directory
742rather then in mysnapshot*/
b872baea 743
8df3bfe9
MD
744.PP
745.B DETAILED ACTION OPTIONS
b872baea 746
8df3bfe9
MD
747.TP
748.BR "\-s, \-\-session NAME"
749Apply to session name.
750.TP
751.BR "\-n, \-\-name NAME"
752Name of the snapshot's output.
753.TP
754.BR "\-m, \-\-max-size SIZE"
755Maximum size in bytes of the snapshot. The maxium size does not include
756the metadata file.
757.TP
758.BR "\-C, \-\-ctrl-url URL"
759Set control path URL. (Must use -D also)
760.TP
761.BR "\-D, \-\-data-url URL"
762Set data path URL. (Must use -C also)
763.RE
764.PP
b872baea 765
afb8ca1b
MD
766.PP
767\fBstart\fP [NAME] [OPTIONS]
768.RS
6991b181
DG
769Start tracing
770
771It will start tracing for all tracers for a specific tracing session.
6991b181 772If NAME is omitted, the session name is taken from the .lttngrc file.
6991b181
DG
773
774.B OPTIONS:
775
afb8ca1b
MD
776.TP
777.BR "\-h, \-\-help"
778Show summary of possible options and commands.
779.TP
780.BR "\-\-list-options"
781Simple listing of options
782.RE
783.PP
6991b181 784
6c09bfdb
MD
785.PP
786\fBstop\fP [NAME] [OPTIONS]
787.RS
6991b181
DG
788Stop tracing
789
391b9c72
DG
790It will stop tracing for all tracers for a specific tracing session. Before
791returning, the command checks for data availability meaning that it will wait
792until the trace is readable for the session. Use \-\-no-wait to avoid this
793behavior.
6991b181
DG
794
795If NAME is omitted, the session name is taken from the .lttngrc file.
6991b181
DG
796
797.B OPTIONS:
798
6c09bfdb
MD
799.TP
800.BR "\-h, \-\-help"
801Show summary of possible options and commands.
802.TP
803.BR "\-\-list-options"
804Simple listing of options
805.TP "\-\-no-wait"
806Don't wait for data availability.
807.RE
808.PP
6991b181 809
5975c30a
MD
810.PP
811\fBversion\fP
812.RS
6991b181 813Show version information
6991b181
DG
814
815.B OPTIONS:
816
5975c30a
MD
817.TP
818.BR "\-h, \-\-help"
819Show summary of possible options and commands.
820.TP
821.BR "\-\-list-options"
822Simple listing of options
823.RE
824.PP
6991b181 825
5b4c1410
MD
826.PP
827\fBview\fP [SESSION_NAME] [OPTIONS]
828.RS
829View traces of a tracing session. By default, the babeltrace viewer
830will be used for text viewing. If SESSION_NAME is omitted, the session
831name is taken from the .lttngrc file.
6991b181
DG
832
833.B OPTIONS:
834
5b4c1410
MD
835.TP
836.BR "\-h, \-\-help"
837Show this help
838.TP
839.BR "\-\-list-options"
840Simple listing of options
841.TP
842.BR "\-t, \-\-trace-path PATH"
843Trace directory path for the viewer
844.TP
845.BR "\-e, \-\-viewer CMD"
846Specify viewer and/or options to use This will completely override the
847default viewers so please make sure to specify the full command. The
848trace directory path of the session will be appended at the end to the
849arguments
850.RE
851.PP
6991b181 852
c206d957 853.SH "EXIT VALUES"
b107a0b1 854.PP
6b8f2e64
DG
855On success 0 is returned and a positive value on error. Value of 1 means a command
856error, 2 an undefined command, 3 a fatal error and 4 a command warning meaning that
857something went wrong during the command.
c206d957 858
6b8f2e64 859Any other value above 10, please refer to
b107a0b1 860.BR "<lttng/lttng-error.h>"
6b8f2e64
DG
861for a detailed list or use lttng_strerror() to get a human readable string of
862the error code.
c206d957 863.PP
b107a0b1 864
6991b181
DG
865.SH "ENVIRONMENT VARIABLES"
866
867.PP
868Note that all command line options override environment variables.
869.PP
870
871.PP
05833633 872.IP "LTTNG_SESSIOND_PATH"
c9e32613
DG
873Allows one to specify the full session daemon binary path to lttng command line
874tool. You can also use \-\-sessiond-path option having the same effect.
b107a0b1
MD
875.PP
876
6991b181 877.SH "SEE ALSO"
6b8f2e64
DG
878.BR babeltrace(1),
879.BR lttng-ust(3),
880.BR lttng-sessiond(8),
881.BR lttng-relayd(8),
882.BR lttng-health-check(3)
b107a0b1 883
6991b181
DG
884.SH "BUGS"
885
b107a0b1 886.PP
6991b181 887If you encounter any issues or usability problem, please report it on our
6b8f2e64
DG
888mailing list <lttng-dev@lists.lttng.org> to help improve this project or
889at https://bugs.lttng.org which is a bugtracker.
b107a0b1
MD
890.PP
891
6991b181
DG
892.SH "CREDITS"
893
894.PP
c9e32613 895lttng is distributed under the GNU General Public License version 2. See the file
6991b181
DG
896COPYING for details.
897.PP
898A Web site is available at http://lttng.org for more information on the LTTng
899project.
900.PP
901You can also find our git tree at http://git.lttng.org.
902.PP
903Mailing lists for support and development: <lttng-dev@lists.lttng.org>.
904.PP
905You can find us on IRC server irc.oftc.net (OFTC) in #lttng.
906.PP
907.SH "THANKS"
908
909.PP
910Thanks to Yannick Brosseau without whom this project would never have been so
911lean and mean! Also thanks to the Ericsson teams working on tracing which
fa072eae 912helped us greatly with detailed bug reports and unusual test cases.
6991b181
DG
913
914Thanks to our beloved packager Alexandre Montplaisir-Goncalves (Ubuntu and PPA
915maintainer) and Jon Bernard for our Debian packages.
916
917Special thanks to Michel Dagenais and the DORSAL laboratory at Polytechnique de
918Montreal for the LTTng journey.
c9e32613 919.PP
6991b181
DG
920.SH "AUTHORS"
921
922.PP
923lttng-tools was originally written by Mathieu Desnoyers, Julien Desfossez and
924David Goulet. More people have since contributed to it. It is currently
925maintained by David Goulet <dgoulet@efficios.com>.
926.PP
This page took 0.06857 seconds and 4 git commands to generate.