Define command short descriptions in configure.ac
[lttng-tools.git] / doc / man / lttng.1.txt
... / ...
CommitLineData
1lttng(1)
2========
3
4
5NAME
6----
7lttng - LTTng 2 tracer control command-line tool
8
9
10SYNOPSIS
11--------
12[verse]
13*lttng* [option:--group='GROUP'] [option:--mi='TYPE'] [option:--no-sessiond | option:--sessiond-path='PATH']
14 [option:--quiet | option:-v | option:-vv | option:-vvv] '<<commands,COMMAND>>' ['COMMAND OPTIONS']
15
16
17DESCRIPTION
18-----------
19The http://lttng.org/[_Linux Trace Toolkit: next generation_] is an open
20source software package used for correlated tracing of the Linux kernel,
21user applications, and user libraries.
22
23LTTng consists of Linux kernel modules (for Linux kernel tracing) and
24dynamically loaded libraries (for user application and library tracing).
25
26An LTTng _session daemon_, man:lttng-sessiond(8), receives
27commands from the command-line interface `lttng` to control the LTTng
28tracers. All interactions with the LTTng tracers happen through the
29`lttng` tool or through the liblttng-ctl library shipped with the
30LTTng-tools package.
31
32A _tracing domain_ is a tracer category. There are five available
33domains. For some commands, the domain needs to be specified with a
34command-line option. The domain options are:
35
36nloption:-j, nloption:--jul::
37 Apply command to the `java.util.logging` (JUL) domain.
38
39nloption:-k, nloption:--kernel::
40 Apply command to the Linux kernel domain.
41
42nloption:-l, nloption:--log4j::
43 Apply command to the https://logging.apache.org/log4j/1.2/[Apache log4j 1.2]
44 (Java) domain.
45
46nloption:-p, nloption:--python::
47 Apply command to the https://www.python.org/[Python] domain.
48
49nloption:-u, nloption:--userspace::
50 Apply command to the user space domain (application using
51 liblttng-ust directly; see man:lttng-ust(3)).
52
53The LTTng session daemon is a tracing registry which allows the user to
54interact with multiple tracers (kernel and user space) within the same
55container, a _tracing session_. Traces can be gathered from the Linux
56kernel and/or from instrumented applications (see
57man:lttng-ust(3)). You can aggregate and read the events of LTTng
58traces using man:babeltrace(1).
59
60To trace the Linux kernel, the session daemon needs to be running as
61`root`. LTTng uses a _tracing group_ to allow specific users to interact
62with the root session daemon. The default tracing group name is
63`tracing`. You can use the option:--group option to set the tracing
64group name to use.
65
66Session daemons can coexist. You can have a session daemon running as
67user Alice that can be used to trace her applications alongside a root
68session daemon or a session daemon running as user Bob.
69
70NOTE: It is highly recommended to start the session daemon at boot time
71for stable and long-term tracing.
72
73User applications instrumented with LTTng automatically register to the
74root session daemon and to user session daemons. This allows any session
75daemon to list the available traceable applications and event sources
76(see man:lttng-list(1)).
77
78By default, the man:lttng-create(1) command automatically spawns a
79user session daemon if none is currently running. The
80option:--no-sessiond general option can be set to avoid this.
81
82
83OPTIONS
84-------
85option:-g, option:--group='GROUP'::
86 Use 'GROUP' as Unix tracing group (default: `tracing`).
87
88option:-m, option:--mi='TYPE'::
89 Print the command's result using the machine interface type 'TYPE'
90 instead of a human-readable output.
91+
92Supported types: `xml`.
93+
94The machine interface (MI) mode converts the traditional pretty-printing
95to a machine output syntax. The MI mode provides a change-resistant way
96to access information generated by the `lttng` command-line program.
97+
98When using the MI mode, the data is printed to the standard output.
99Errors and warnings are printed on the standard error with the
100pretty-print default format.
101+
102If any error occurs during the execution of a command, the return value
103of the command will be different than 0. In this case, `lttng` does
104:not: guarantee the syntax and data validity of the generated MI output.
105+
106For the `xml` MI type, an XML schema definition (XSD) file used for
107validation is available: see the `src/common/mi_lttng.xsd` file in
108the LTTng-tools source tree.
109
110option:-n, option:--no-sessiond::
111 Do not automatically spawn a session daemon.
112
113option:-q, option:--quiet::
114 Suppress all messages, including warnings and errors.
115
116option:--sessiond-path='PATH'::
117 Set the session daemon binary's absolute path to 'PATH'.
118
119option:-v, option:--verbose::
120 Increase verbosity.
121+
122Three levels of verbosity are available, which are triggered by
123appending additional `v` letters to the option
124(that is, `-vv` and `-vvv`).
125
126
127Program information
128~~~~~~~~~~~~~~~~~~~
129option:-h, option:--help::
130 Show help.
131
132option:--list-commands::
133 List available commands.
134
135option:--list-options::
136 List available general options.
137
138option:-V, option:--version::
139 Show version.
140
141
142[[commands]]
143COMMANDS
144--------
145The following commands also have their own nloption:--help option.
146
147
148Tracing sessions
149~~~~~~~~~~~~~~~~
150man:lttng-create(1)::
151 {cmd_descr_create}.
152
153man:lttng-destroy(1)::
154 {cmd_descr_destroy}.
155
156man:lttng-load(1)::
157 {cmd_descr_load}.
158
159man:lttng-metadata(1)::
160 {cmd_descr_metadata}.
161
162man:lttng-save(1)::
163 {cmd_descr_save}.
164
165man:lttng-set-session(1)::
166 {cmd_descr_set_session}.
167
168
169Channels
170~~~~~~~~
171man:lttng-add-context(1)::
172 {cmd_descr_add_context}.
173
174man:lttng-disable-channel(1)::
175 {cmd_descr_disable_channel}.
176
177man:lttng-enable-channel(1)::
178 {cmd_descr_enable_channel}.
179
180
181Event rules
182~~~~~~~~~~~
183man:lttng-disable-event(1)::
184 {cmd_descr_disable_event}.
185
186man:lttng-enable-event(1)::
187 {cmd_descr_enable_event}.
188
189
190Status
191~~~~~~
192man:lttng-list(1)::
193 {cmd_descr_list}.
194
195man:lttng-status(1)::
196 {cmd_descr_status}.
197
198
199Control
200~~~~~~~
201man:lttng-snapshot(1)::
202 {cmd_descr_snapshot}.
203
204man:lttng-start(1)::
205 {cmd_descr_start}.
206
207man:lttng-stop(1)::
208 {cmd_descr_stop}.
209
210
211Resource tracking
212~~~~~~~~~~~~~~~~~
213man:lttng-track(1)::
214 {cmd_descr_track}.
215
216man:lttng-untrack(1)::
217 {cmd_descr_untrack}.
218
219
220Miscellaneous
221~~~~~~~~~~~~~
222man:lttng-calibrate(1)::
223 {cmd_descr_calibrate}.
224
225man:lttng-help(1)::
226 {cmd_descr_help}.
227
228man:lttng-version(1)::
229 {cmd_descr_version}.
230
231man:lttng-view(1)::
232 {cmd_descr_view}.
233
234
235include::common-cmd-footer.txt[]
236
237
238SEE ALSO
239--------
240man:lttng-sessiond(8),
241man:lttng-relayd(8),
242man:lttng-crash(1),
243man:lttng-ust(3),
244man:babeltrace(1)
This page took 0.025934 seconds and 5 git commands to generate.