Commit | Line | Data |
---|---|---|
661ad2e0 JD |
1 | .TH "LTTNGTOP" "1" "April 18, 2012" "" "" |
2 | ||
3 | .SH "NAME" | |
4 | lttngtop \(em LTTng Trace Viewer | |
5 | ||
6 | .SH "SYNOPSIS" | |
7 | ||
8 | .PP | |
9 | .nf | |
10 | lttngtop INPUT | |
11 | .fi | |
12 | .SH "DESCRIPTION" | |
13 | ||
14 | .PP | |
15 | ||
16 | Lttngtop is a ncurses interface for reading and browsing traces recorded by the | |
17 | LTTng tracer and displaying various statistics. As of now, the cpu usage, | |
18 | performance counters and per process/file I/O bandwidth are displayed. This | |
19 | version currently only supports offline traces, but a live version is in alpha | |
20 | and will be available for testing soon. | |
21 | .SH "OPTIONS" | |
22 | ||
23 | .TP | |
24 | .BR "INPUT" | |
25 | Input trace path | |
26 | ||
27 | .SH "TRACE REQUIREMENTS" | |
28 | ||
29 | .PP | |
30 | ||
31 | LTTngTop requires that the pid, procname, tid and ppid context information | |
32 | are enabled during tracing. | |
33 | .PP | |
34 | ||
35 | .PP | |
36 | If you want the CPU activity view, you need the sched_switch event, if you | |
37 | want the I/O statistics, you need to enable the system call tracing, and if | |
38 | you want the performance counters, you need to enable them for the events you | |
39 | are interested in (or all of them). Note, there is a hardware limitation for the | |
40 | number of performance counter you can enable, check dmesg for information. | |
41 | .PP | |
42 | ||
43 | .PP | |
44 | The following example creates a trace with all events enabled, the mandatory context informations and | |
45 | three performance counters. It assumes that you are running as root or with a user part of the tracing group and a lttng-sessiond | |
46 | launched as root. | |
47 | .PP | |
48 | ||
49 | .nf | |
50 | lttng create lttngtop | |
51 | lttng enable-event -k -a | |
52 | lttng add-context -k -t pid -t procname -t tid -t ppid -t perf:cache-misses -t perf:major-faults -t perf:branch-load-misses | |
53 | lttng start | |
54 | sleep 10 | |
55 | lttng stop | |
56 | lttng destroy | |
57 | .fi | |
58 | ||
59 | .SH "SEE ALSO" | |
60 | ||
61 | .PP | |
62 | babeltrace(1), babeltrace-log(1), lttng(1), lttng-ust(3), lttng-sessiond(8) | |
63 | .PP | |
64 | .SH "BUGS" | |
65 | ||
66 | .PP | |
67 | No knows bugs at this point. | |
68 | ||
69 | If you encounter any issues or usability problem, please report it on | |
70 | our mailing list <lttng-dev@lists.lttng.org> to help improve this | |
71 | project. | |
72 | .SH "CREDITS" | |
73 | ||
74 | LTTngTop is distributed under the GPLv2 license. See the LICENSE file | |
75 | in the source tree for details. | |
76 | ||
77 | .PP | |
78 | A Web site is available at http://www.efficios.com/babeltrace for more | |
79 | information on Babeltrace and the Common Trace Format. See | |
80 | http://lttng.org for more information on the LTTng project. | |
81 | .PP | |
82 | Mailing list for support and development: <lttng-dev@lists.lttng.org>. | |
83 | .PP | |
84 | You can find us on IRC server irc.oftc.net (OFTC) in #lttng. | |
85 | .PP | |
86 | ||
87 | .SH "AUTHORS" | |
88 | ||
89 | .PP | |
90 | LTTngTop was originally written by Julien Desfossez, with contribution | |
91 | from Mathieu Bain for the I/O bandwidth view, and suggestions and ideas | |
92 | from the team working with the LTTng project. It is currently | |
93 | maintained by Julien Desfossez <jdesfossez@efficios.com> | |
94 | .PP |