X-Git-Url: http://git.liburcu.org/?a=blobdiff_plain;f=README;h=2900cdf998d6c888bf0fcd181ee7b637b7b77ca8;hb=3e59e7681922366ad6b1e9415f321478152e0c57;hp=b2fed8845367c8274f66224046eeee31e4d693da;hpb=bc02a7aa917596e98027f6b44f9e3f145e369161;p=lttngtop.git diff --git a/README b/README index b2fed88..2900cdf 100644 --- a/README +++ b/README @@ -1,41 +1,18 @@ LTTngTop -Julien Desfossez -August 2011 +Julien Desfossez +April 2012 Lttngtop is an ncurses interface for reading and browsing traces recorded by the LTTng tracer and displaying various statistics. -As of now, the cpu usage and perf counters are displayed. This version currently -only supports offline traces, but a live version is in alpha and will be -available for testing soon. +As of now, the cpu usage, per file/process I/O bandwidth and perf counters are +displayed. This version currently only supports offline traces, but a live +version is in alpha and will be available for testing soon. USAGE ----- -Record a trace with LTTng 2.0 with at least the sched_switch event, and the pid, -procname, tid, ppid contexts. To have the perftop view working you can enable -any number of perf contexts (depending on your hardware). -For the iotop view, you need to have some syscall events : sys_read, sys_write -and exit_syscall. - -Once your trace is recorded, you can use lttngtop this way : -$ lttngtop /path/to/your/trace - -Make sure you have read permissions on the whole directory. - -EXAMPLE -------- -# Get root (or ideally just launch lttng-sessiond as root) -lttng create lttngtop -lttng enable-event -k sched_switch -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 -lttng start -#...do stuff... -lttng stop -lttng destroy - -# Run lttngtop -lttngtop $HOME/lttng-traces/lttngtop-... +The manpage located in the doc folder of this source tree documents the usage +of LTTngTop. BUILDING --------