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