doc/lttngtop.1

   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 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_switch -s lttngtop
  52 lttng enable-event -k --syscall -a -s lttngtop
  53 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
  54 lttng start lttngtop
  55 sleep 10
  56 lttng stop lttngtop
  57 lttng destroy lttngtop
  58 .fi
  59
  60 .SH "LIVE STREAMING"
  61
  62 .PP
  63 In addition to offline traces, LTTngTop can read traces while they are being recorded.
  64 The official supported way of doing live streaming is using lttng-tools >=2.4 and
  65 following the documentation in live-reading-howto.txt.
  66 An other experimental way of doing live tracing is with mmap, but this requires some
  67 more work because is not officially supported and requires out-of-tree patches to
  68 lttng-tools and babeltrace.
  69
  70 .PP
  71 To use the network live-reading, the user only needs to specify the relayd hostname
  72 or IP address with the option -r. For now, LTTngTop will only connect to the first
  73 live session established on the relay, but in a near future, the user will be able
  74 to choose which session to attach to.
  75
  76 The default mode after attaching to a session is to start reading the trace from
  77 this point in time. In order to read the trace from the beginning, the user can specify
  78 the -b option.
  79
  80 .SH "KEY BINDINGS"
  81
  82 .TP 7
  83 \ \ \'\fBF2\fR\': \fICPUTop \fR
  84 Switch to the CPUTop view which displays the CPU usage of each process
  85 .TP 7
  86 \ \ \'\fBF3\fR\': \fIPerfTop \fR
  87 Switch to the PerfTop view which displays the performance counters (PMU) value of each process (if enabled during tracing)
  88 .TP 7
  89 \ \ \'\fBF4\fR\': \fIIOTop \fR
  90 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)
  91 .TP 7
  92 \ \ \'\fBEnter\fR\': \fIProcess details \fR
  93 Display all relevant information for the process selected
  94 .TP 7
  95 \ \ \'\fBSpace\fR\': \fIHighlight \fR
  96 Highlights the process under the blue line to make it easy to find it across all views or toggle view in preference panel\fR
  97 .TP 7
  98 \ \ \'\fBq\fR\': \fIQuit \fR
  99 Exit the program
 100 .TP 7
 101 \ \ \'\fBt\fR\': \fIThreads \fR
 102 Toggle threads display in CPUTop
 103 .TP 7
 104 \ \ \'\fBr\fR\': \fIPreferences \fR
 105 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
 106 .TP 7
 107 \ \ \'\fBs\fR\': \fISort \fR
 108 In preference view, sort on the currently selected line
 109 .TP 7
 110 \ \ \'\fBp\fR\': \fIPause/Resume \fR
 111 Pause the display, hit again to resume the refresh (only works when the trace has not been fully displayed)
 112 .TP 7
 113 \ \ \'\fBRight arrow\fR\': \fIMove forward in time \fR
 114 Display the next second of data, can be hit several time to bypass the default 1 second refresh period to fast forward
 115 .TP 7
 116 \ \ \'\fBLeft arrow\fR\': \fIMove backward in time \fR
 117 Display the previous second of data, automatically switch to pause if not already enabled
 118 .TP 7
 119 \ \ \'\fBUp arrow\' / \'k\'\fR: \fIMove UP the cursor \fR
 120 Move up the blue line to select processes \fR
 121 .TP 7
 122 \ \ \'\fBDown arrow\' / \'j\'\fR: \fIMove DOWN the cursor \fR
 123 Move down the blue line to select processes
 124 .TP 7
 125 \ \ \'\fB>\fR': \fI Sort the next column \fR
 126 Update the sorting to the next column
 127 .TP 7
 128 \ \ \'\fB<\fR': \fI Sort the previous column \fR
 129 Update the sorting to the previous column
 130
 131 .SH "SEE ALSO"
 132
 133 .PP
 134 babeltrace(1), babeltrace-log(1), lttng(1), lttng-ust(3), lttng-sessiond(8)
 135 .PP
 136 .SH "BUGS"
 137
 138 .PP
 139 No knows bugs at this point.
 140
 141 If you encounter any issues or usability problem, please report it on
 142 our mailing list <lttng-dev@lists.lttng.org> to help improve this
 143 project.
 144 .SH "CREDITS"
 145
 146 LTTngTop is distributed under the GPLv2 license. See the LICENSE file
 147 in the source tree for details.
 148
 149 .PP
 150 A Web site is available at http://www.efficios.com/babeltrace for more
 151 information on Babeltrace and the Common Trace Format. See
 152 http://lttng.org for more information on the LTTng project.
 153 .PP
 154 Mailing list for support and development: <lttng-dev@lists.lttng.org>.
 155 .PP
 156 You can find us on IRC server irc.oftc.net (OFTC) in #lttng.
 157 .PP
 158
 159 .SH "AUTHORS"
 160
 161 .PP
 162 LTTngTop was originally written by Julien Desfossez, with contribution
 163 from Mathieu Bain for the I/O bandwidth view, and suggestions and ideas
 164 from the team working with the LTTng project. It is currently
 165 maintained by Julien Desfossez <jdesfossez@efficios.com>
 166 .PP