Manpage: cleanup layout of disable-event
[lttng-tools.git] / doc / man / lttng.1
... / ...
CommitLineData
1.TH "LTTNG" "1" "December 3rd, 2012" "" ""
2
3.SH "NAME"
4lttng \(em LTTng 2.x tracer control command line tool
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
20The \fBlttng\fP command line tool from the lttng-tools package is used to control
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,
26which allows you to interact with multiple tracers (kernel and user-space)
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
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
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
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
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
58.BR "\-h, \-\-help"
59Show summary of possible options and commands.
60.TP
61.BR "\-v, \-\-verbose"
62Increase verbosity.
63Three levels of verbosity are available which are triggered by putting additional v to
64the option (\-vv or \-vvv)
65.TP
66.BR "\-q, \-\-quiet"
67Suppress all messages (even errors).
68.TP
69.BR "\-g, \-\-group NAME"
70Set unix tracing group name. (default: tracing)
71.TP
72.BR "\-n, \-\-no-sessiond"
73Don't automatically spawn a session daemon.
74.TP
75.BR "\-\-sessiond\-path PATH"
76Set session daemon full binary path.
77.TP
78.BR "\-\-list\-options"
79Simple listing of lttng options.
80.TP
81.BR "\-\-list\-commands"
82Simple listing of lttng commands.
83.SH "COMMANDS"
84
85.PP
86\fBadd-context\fP [OPTIONS]
87.RS
88Add context to event(s) and/or channel(s).
89
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).
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
99.nf
100# lttng add-context \-k \-t prio \-t perf:branch-misses \\
101 \-t perf:cache-misses
102.fi
103
104Please take a look at the help (\-h/\-\-help) for a detailed list of available
105contexts.
106
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).
110
111If \fB\-s, \-\-session\fP is omitted, the session name is taken from the .lttngrc
112file.
113
114.B OPTIONS:
115
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
137
138.PP
139\fBcalibrate\fP [OPTIONS]
140.RS
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
159information (see lttng add-context \-\-help to see the list of available PMU
160counters).
161
162.nf
163# lttng create calibrate-function
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
169# lttng start
170# for a in $(seq 1 10); do \\
171 lttng calibrate \-\-kernel \-\-function;
172 done
173# lttng destroy
174# babeltrace $(ls \-1drt ~/lttng-traces/calibrate-function-* \\
175 | tail \-n 1)
176.fi
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
187.nf
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
192.fi
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.
200
201.B OPTIONS:
202
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
217
218.PP
219.IP \fBcreate\fP [NAME] [OPTIONS]
220.RS
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
230automatically created having this form: 'auto-yyyymmdd-hhmmss'.
231
232If no \fB\-o, \-\-output\fP is specified, the traces will be written in
233$HOME/lttng-traces.
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.
238
239.B OPTIONS:
240
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).
258
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
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
275.B URL FORMAT:
276
277proto://[HOST|IP][:PORT1[:PORT2]][/TRACE_PATH]
278
279Supported protocols are (proto):
280.TP
281.BR "file://..."
282Local filesystem full path.
283
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.
289
290.TP
291.BR "tcp[6]://..."
292Can only be used with -C and -D together
293
294NOTE: IPv6 address MUST be enclosed in brackets '[]' (rfc2732)
295
296.B EXAMPLES:
297
298.nf
299# lttng create -U net://192.168.1.42
300.fi
301Uses TCP and default ports for the given destination.
302
303.nf
304# lttng create -U net6://[fe80::f66d:4ff:fe53:d220]
305.fi
306Uses TCP, default ports and IPv6.
307
308.nf
309# lttng create s1 -U net://myhost.com:3229
310.fi
311Create session s1 and set its consumer to myhost.com on port 3229 for control.
312.RE
313.PP
314
315.PP
316\fBdestroy\fP [NAME] [OPTIONS]
317.RS
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.
323
324.B OPTIONS:
325
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
337
338.PP
339\fBenable-channel\fP NAME[,NAME2,...] (\-k | \-u) [OPTIONS]
340.RS
341Enable tracing channel
342
343To enable an event, you must enable both the event and the channel that
344contains it.
345
346If \fB\-s, \-\-session\fP is omitted, the session name is taken from the .lttngrc
347file.
348
349Exactly one of \-k or -u must be specified.
350
351It is important to note that if a certain type of buffers is used, the session
352will be set with that type and all other subsequent channel needs to have the
353same type.
354
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.
357
358.B OPTIONS:
359
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)
424
425.B EXAMPLES:
426
427.nf
428$ lttng enable-channel -k -C 4096 -W 32 chan1
429.fi
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
432the stream number as seen in the following example. The last trace file is
433smaller than 4096 since it was not completely filled.
434
435.nf
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 ...
441.fi
442
443.nf
444$ lttng enable-channel -k -C 4096
445.fi
446This will create trace files of 4096 bytes and will create new ones as long as
447there is data available.
448.RE
449.PP
450
451.PP
452\fBenable-event\fP NAME[,NAME2,...] [-k|-u] [OPTIONS]
453.RS
454Enable tracing event
455
456A tracing event is always assigned to a channel. If \fB\-c, \-\-channel\fP is
457omitted, a default channel named '\fBchannel0\fP' is created and the event is
458added to it. For the user-space tracer, using \fB\-a, \-\-all\fP is the same as
459using the wildcard "*".
460
461If \fB\-s, \-\-session\fP is omitted, the session name is taken from the .lttngrc
462file.
463
464.B OPTIONS:
465
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.:
493.nf
494 "*"
495 "app_component:na*"
496.fi
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
557
558.PP
559\fBdisable-channel\fP NAME[,NAME2,...] (\-k | \-u) [OPTIONS]
560.RS
561Disable tracing channel
562
563Disabling a channel makes all event(s) in that channel to stop tracing. You can
564enable it back by calling \fBlttng enable-channel NAME\fP again.
565
566If \fB\-s, \-\-session\fP is omitted, the session name is taken from the .lttngrc
567file.
568
569.B OPTIONS:
570
571.TP
572.BR "\-h, \-\-help"
573Show summary of possible options and commands.
574.TP
575.BR "\-\-list-options"
576Simple listing of options
577.TP
578.BR "\-s, \-\-session NAME"
579Apply on session name
580.TP
581.BR "\-k, \-\-kernel"
582Apply for the kernel tracer
583.TP
584.BR "\-u, \-\-userspace"
585Apply for the user-space tracer
586.RE
587.PP
588
589.PP
590\fBdisable-event\fP NAME[,NAME2,...] (\-k | \-u) [OPTIONS]
591.RS
592Disable tracing event
593
594The event, once disabled, can be re-enabled by calling \fBlttng enable-event
595NAME\fP again.
596
597If \fB\-s, \-\-session\fP is omitted, the session name is taken from the .lttngrc
598file.
599
600.B OPTIONS:
601
602.TP
603.BR "\-h, \-\-help"
604Show summary of possible options and commands.
605.TP
606.BR "\-\-list-options"
607Simple listing of options
608.TP
609.BR "\-s, \-\-session NAME"
610Apply on session name
611.TP
612.BR "\-a, \-\-all-events"
613Disable all events. This does NOT disable "*" but rather every known
614events of the session.
615.TP
616.BR "\-k, \-\-kernel"
617Apply for the kernel tracer
618.TP
619.BR "\-u, \-\-userspace"
620Apply for the user-space tracer
621.RE
622.PP
623
624.IP "\fBlist\fP [\-k|\-u] [SESSION [SESSION_OPTIONS]]"
625.nf
626List tracing session information.
627
628With no arguments, it will list available tracing session(s).
629
630With the session name, it will display the details of the session including
631the trace file path, the associated channels and their state (activated
632and deactivated), the activated events and more.
633
634With \-k alone, it will list all available kernel events (except the system
635calls events).
636With \-u alone, it will list all available user-space events from registered
637applications. Here is an example of 'lttng list \-u':
638
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)
642
643You can now enable any event listed by using the name :
644\fBust_tests_hello:tptest\fP.
645.fi
646
647.B OPTIONS:
648
649.nf
650\-h, \-\-help
651 Show summary of possible options and commands.
652\-\-list-options
653 Simple listing of options
654\-k, \-\-kernel
655 Select kernel domain
656\-u, \-\-userspace
657 Select user-space domain.
658
659.B SESSION OPTIONS:
660
661\-c, \-\-channel NAME
662 List details of a channel
663\-d, \-\-domain
664 List available domain(s)
665.fi
666
667.IP "\fBset-session\fP NAME"
668.nf
669Set current session name
670
671Will change the session name in the .lttngrc file.
672.fi
673
674.B OPTIONS:
675
676.nf
677\-h, \-\-help
678 Show summary of possible options and commands.
679\-\-list-options
680 Simple listing of options
681.fi
682
683.IP
684
685.IP "\fBsnapshot\fP ACTION"
686.nf
687Snapshot command for LTTng session.
688.fi
689
690.B OPTIONS:
691
692.nf
693\-h, \-\-help
694 Show summary of possible options and commands.
695\-\-list-options
696 Simple listing of options
697.fi
698
699.B ACTION:
700
701.nf
702\fBadd-output\fP [-m <SIZE>] [-s <NAME>] [-n <NAME>] <URL> | -C <URL> -D <URL>
703
704Setup and add an snapshot output for a session. Output are the destination
705where the snapshot will be sent. Only one output is permitted. To change it,
706you'll need to delete it and add back the new one.
707
708\fBdel-output\fP ID | NAME [-s <NAME>]
709
710Delete an output for a session using the ID. You can either specify the
711output's ID that can be found with list-output or the name.
712
713\fBlist-output\fP [-s <NAME>]
714
715List the output of a session. Attributes of the output are printed.
716
717\fBrecord\fP [-m <SIZE>] [-s <NAME>] [-n <NAME>] [<URL> | -C <URL> -D <URL>]
718
719Snapshot a session's buffer(s) for all domains. If an URL is specified, it is
720used instead of a previously added output. Specifying only a name or/and a max
721size will override the current output values. For instance, you can record a
722snapshot with a custom maximum size or with a different name.
723
724$ lttng add-output -n mysnapshot file:///data/snapshot
725[...]
726$ lttng snapshot record -n new_name_snapshot
727
728The above will create a snapshot in /data/snapshot/new_name_snapshot* directory
729rather then in mysnapshot*/
730.fi
731
732.B LONG OPTIONS
733
734.nf
735\-s, \-\-session NAME
736 Apply to session name.
737\-n, \-\-name NAME
738 Name of the snapshot's output.
739\-m, \-\-max-size SIZE
740 Maximum size in bytes of the snapshot. The maxium size does not
741 include the metadata file.
742\-C, \-\-ctrl-url URL
743 Set control path URL. (Must use -D also)
744\-D, \-\-data-url URL
745 Set data path URL. (Must use -C also)
746.fi
747
748.IP
749
750.IP "\fBstart\fP [NAME] [OPTIONS]"
751.nf
752Start tracing
753
754It will start tracing for all tracers for a specific tracing session.
755
756If NAME is omitted, the session name is taken from the .lttngrc file.
757.fi
758
759.B OPTIONS:
760
761.nf
762\-h, \-\-help
763 Show summary of possible options and commands.
764\-\-list-options
765 Simple listing of options
766.fi
767
768.IP
769
770.IP "\fBstop\fP [NAME] [OPTIONS]"
771.nf
772Stop tracing
773
774It will stop tracing for all tracers for a specific tracing session. Before
775returning, the command checks for data availability meaning that it will wait
776until the trace is readable for the session. Use \-\-no-wait to avoid this
777behavior.
778
779If NAME is omitted, the session name is taken from the .lttngrc file.
780.fi
781
782.B OPTIONS:
783
784.nf
785\-h, \-\-help
786 Show summary of possible options and commands.
787\-\-list-options
788 Simple listing of options
789\-\-no-wait
790 Don't wait for data availability.
791.fi
792
793.IP
794
795.IP "\fBversion\fP"
796.nf
797Show version information
798.fi
799
800.B OPTIONS:
801
802.nf
803\-h, \-\-help
804 Show summary of possible options and commands.
805\-\-list-options
806 Simple listing of options
807.fi
808
809.IP
810
811.IP "\fBview\fP [SESSION_NAME] [OPTIONS]"
812.nf
813View traces of a tracing session
814
815By default, the babeltrace viewer will be used for text viewing.
816
817If SESSION_NAME is omitted, the session name is taken from the .lttngrc file.
818
819.fi
820
821.B OPTIONS:
822
823.nf
824\-h, \-\-help
825 Show this help
826\-\-list-options
827 Simple listing of options
828\-t, \-\-trace-path PATH
829 Trace directory path for the viewer
830\-e, \-\-viewer CMD
831 Specify viewer and/or options to use
832 This will completely override the default viewers so
833 please make sure to specify the full command. The trace
834 directory path of the session will be appended at the end
835 to the arguments
836.fi
837
838.SH "EXIT VALUES"
839On success 0 is returned and a positive value on error. Value of 1 means a command
840error, 2 an undefined command, 3 a fatal error and 4 a command warning meaning that
841something went wrong during the command.
842
843Any other value above 10, please refer to
844.BR <lttng/lttng-error.h>
845for a detailed list or use lttng_strerror() to get a human readable string of
846the error code.
847
848.PP
849.SH "ENVIRONMENT VARIABLES"
850
851.PP
852Note that all command line options override environment variables.
853.PP
854
855.PP
856.IP "LTTNG_SESSIOND_PATH"
857Allows one to specify the full session daemon binary path to lttng command line
858tool. You can also use \-\-sessiond-path option having the same effect.
859.SH "SEE ALSO"
860.BR babeltrace(1),
861.BR lttng-ust(3),
862.BR lttng-sessiond(8),
863.BR lttng-relayd(8),
864.BR lttng-health-check(3)
865.SH "BUGS"
866
867If you encounter any issues or usability problem, please report it on our
868mailing list <lttng-dev@lists.lttng.org> to help improve this project or
869at https://bugs.lttng.org which is a bugtracker.
870.SH "CREDITS"
871
872.PP
873lttng is distributed under the GNU General Public License version 2. See the file
874COPYING for details.
875.PP
876A Web site is available at http://lttng.org for more information on the LTTng
877project.
878.PP
879You can also find our git tree at http://git.lttng.org.
880.PP
881Mailing lists for support and development: <lttng-dev@lists.lttng.org>.
882.PP
883You can find us on IRC server irc.oftc.net (OFTC) in #lttng.
884.PP
885.SH "THANKS"
886
887.PP
888Thanks to Yannick Brosseau without whom this project would never have been so
889lean and mean! Also thanks to the Ericsson teams working on tracing which
890helped us greatly with detailed bug reports and unusual test cases.
891
892Thanks to our beloved packager Alexandre Montplaisir-Goncalves (Ubuntu and PPA
893maintainer) and Jon Bernard for our Debian packages.
894
895Special thanks to Michel Dagenais and the DORSAL laboratory at Polytechnique de
896Montreal for the LTTng journey.
897.PP
898.SH "AUTHORS"
899
900.PP
901lttng-tools was originally written by Mathieu Desnoyers, Julien Desfossez and
902David Goulet. More people have since contributed to it. It is currently
903maintained by David Goulet <dgoulet@efficios.com>.
904.PP
This page took 0.025494 seconds and 4 git commands to generate.