-.TH "LTTNGTOP" "1" "April 18, 2012" "" ""
+.TH "LTTNGTOP" "1" "June 01, 2015" "" ""
.SH "NAME"
lttngtop \(em LTTng Trace Viewer
LTTngTop requires that the pid, procname, tid and ppid context information
are enabled during tracing.
+
+The command --create-local-session does all the required setup for a local
+trace (that must be stopped and destroyed manually by the user).
+And the command --create-live-session does all the required setup for a live
+trace on localhost (it must also be stopped and destroyed manually by the user).
.PP
.PP
.nf
lttng create lttngtop
-lttng enable-event -k -a
-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
+lttng enable-event -k lttng_statedump_start,lttng_statedump_end,lttng_statedump_process_state,lttng_statedump_file_descriptor,lttng_statedump_vm_map,lttng_statedump_network_interface,lttng_statedump_interrupt,sched_process_free,sched_switchsched_process_fork -s lttngtop
+lttng enable-event -k --syscall -a -s lttngtop
+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 -s lttngtop
+lttng start lttngtop
sleep 10
-lttng stop
-lttng destroy
+lttng stop lttngtop
+lttng destroy lttngtop
.fi
+.SH "LIVE STREAMING"
+
+.PP
+In addition to offline traces, LTTngTop can read traces while they are being
+recorded. The official supported way of doing live streaming is using
+lttng-tools >=2.4 and following the documentation in live-reading-howto.txt of
+lttng-tools and README-LIVE of lttngtop.
+An other experimental way of doing live tracing is with mmap, but this requires some
+more work because is not officially supported and requires out-of-tree patches to
+lttng-tools and babeltrace.
+
+.PP
+To use the network live-reading, the user only needs to specify the relayd hostname
+or IP address with the option -r. For now, LTTngTop will only connect to the first
+live session established on the relay, but in a near future, the user will be able
+to choose which session to attach to.
+
+The default mode after attaching to a session is to start reading the trace from
+this point in time. In order to read the trace from the beginning, the user can specify
+the -b option.
+
+.SH "KEY BINDINGS"
+
+.TP 7
+\ \ \'\fBF2\fR\': \fICPUTop \fR
+Switch to the CPUTop view which displays the CPU usage of each process
+.TP 7
+\ \ \'\fBF3\fR\': \fIPerfTop \fR
+Switch to the PerfTop view which displays the performance counters (PMU) value of each process (if enabled during tracing)
+.TP 7
+\ \ \'\fBF4\fR\': \fIIOTop \fR
+Switch to the IOTop view which displays the I/O usage of each process (as of now read and writes on any file descriptor network or disk)
+.TP 7
+\ \ \'\fBEnter\fR\': \fIProcess details \fR
+Display all relevant information for the process selected
+.TP 7
+\ \ \'\fBSpace\fR\': \fIHighlight \fR
+Highlights the process under the blue line to make it easy to find it across all views or toggle view in preference panel\fR
+.TP 7
+\ \ \'\fBq\fR\': \fIQuit \fR
+Exit the program
+.TP 7
+\ \ \'\fBt\fR\': \fIThreads \fR
+Toggle threads display in CPUTop
+.TP 7
+\ \ \'\fBr\fR\': \fIPreferences \fR
+Display the preference menu for the current view, this menu helps select the column displayed (only in PerfTop view for now) and the column to sort, use 's' to sort and 'space' to toggle the view
+.TP 7
+\ \ \'\fBs\fR\': \fISort \fR
+In preference view, sort on the currently selected line
+.TP 7
+\ \ \'\fBp\fR\': \fIPause/Resume \fR
+Pause the display, hit again to resume the refresh (only works when the trace has not been fully displayed)
+.TP 7
+\ \ \'\fBRight arrow\fR\': \fIMove forward in time \fR
+Display the next second of data, can be hit several time to bypass the default 1 second refresh period to fast forward
+.TP 7
+\ \ \'\fBLeft arrow\fR\': \fIMove backward in time \fR
+Display the previous second of data, automatically switch to pause if not already enabled
+.TP 7
+\ \ \'\fBUp arrow\' / \'k\'\fR: \fIMove UP the cursor \fR
+Move up the blue line to select processes \fR
+.TP 7
+\ \ \'\fBDown arrow\' / \'j\'\fR: \fIMove DOWN the cursor \fR
+Move down the blue line to select processes
+.TP 7
+\ \ \'\fB>\fR': \fI Sort the next column \fR
+Update the sorting to the next column
+.TP 7
+\ \ \'\fB<\fR': \fI Sort the previous column \fR
+Update the sorting to the previous column
+
.SH "SEE ALSO"
.PP
.SH "BUGS"
.PP
-No knows bugs at this point.
+The I/O history has some problems with the file names, and we are missing some
+system calls parsing to have the complete I/O accounting.
If you encounter any issues or usability problem, please report it on
our mailing list <lttng-dev@lists.lttng.org> to help improve this
projects / lttngtop.git / blobdiff