remove debug code
[lttngtop.git] / README
CommitLineData
c263c4eb 1LTTngTop
1fc22eb4
JD
2Julien Desfossez <julien.desfossez@polymtl.ca>
3August 2011
4
5Lttngtop is an ncurses interface for reading and browsing traces recorded by
6the LTTng tracer and displaying various statistics.
7As of now, the cpu usage and perf counters are displayed. This version currently
8only supports offline traces, but a live version is in alpha and will be
9available for testing soon.
10
11USAGE
12-----
13
14Record a trace with LTTng 2.0 with at least the sched_switch event, and the pid,
15procname, tid, ppid contexts. To have the perftop view working you can enable
16any number of perf contexts (depending on your hardware).
17For the iotop view, you need to have some syscall events : sys_read, sys_write
18and exit_syscall.
19
20Once your trace is recorded, you can use lttngtop this way :
21$ lttngtop /path/to/your/trace
22
23Make sure you have read permissions on the whole directory.
24
1fc22eb4
JD
25EXAMPLE
26-------
bc02a7aa
YB
27# Get root (or ideally just launch lttng-sessiond as root)
28lttng create lttngtop
29lttng enable-event -k sched_switch
30lttng add-context -k -t pid -t procname -t tid -t ppid -t perf:cache-misses \
1fc22eb4 31 -t perf:major-faults -t perf:branch-load-misses
bc02a7aa
YB
32lttng start
33#...do stuff...
34lttng stop
35lttng destroy
1fc22eb4 36
bc02a7aa
YB
37# Run lttngtop
38lttngtop $HOME/lttng-traces/lttngtop-...
1fc22eb4
JD
39
40BUILDING
41--------
42
43 ./bootstrap (skip if using tarball)
44 ./configure
45 make
46 make install
47
48DEPENDENCIES
49------------
50
51To compile Babeltrace and lttngtop, you will need:
52
53 gcc 3.2 or better
54 libc6 development librairies
55 (Debian : libc6, libc6-dev)
56 (Fedora : glibc, glibc)
57 glib 2.22 or better development libraries
58 (Debian : libglib2.0-0, libglib2.0-dev)
59 (Fedora : glib2, glib2-devel)
1fc22eb4
JD
60 libpopt >= 1.13 development libraries
61 (Debian : libpopt-dev)
62 (Fedora : popt)
63 ncurses development libraries
64 (Debian : libncurses5-dev)
c263c4eb 65 babeltrace development library
1fc22eb4
JD
66
67For developers using the git tree:
68
69This source tree is based on the autotools suite from GNU to simplify
70portability. Here are some things you should have on your system in order to
71compile the git repository tree :
72
73- GNU autotools (automake >=1.10, autoconf >=2.50, autoheader >=2.50)
74 (make sure your system wide "automake" points to a recent version!)
75- GNU Libtool >=2.2
76 (for more information, go to http://www.gnu.org/software/autoconf/)
77- Flex >=2.5.35.
78- Bison >=2.4.
79
80If you get the tree from the repository, you will need to use the "bootstrap"
81script in the root of the tree. It calls all the GNU tools needed to prepare the
82tree configuration.
This page took 0.034486 seconds and 4 git commands to generate.