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