doc/lttngtrace.1

   1 .TH "LTTNGTRACE" "1" "June 01, 2015" "" ""
   2
   3 .SH "NAME"
   4 lttngtrace \(em Live textual LTTng Trace Viewer
   5
   6 .SH "SYNOPSIS"
   7
   8 .PP
   9 .nf
  10 lttngtrace [OPTIONS] [EXECUTABLE]
  11 .fi
  12 .SH "DESCRIPTION"
  13
  14 .PP
  15
  16 Lttngtrace is a live textual LTTng trace viewer, it allows to easily (one
  17 command) start a LTTng session and view the live events. The intent is to do
  18 something similar to strace but less intrusive and more flexible:
  19 .nf
  20 - run a command and see it's kernel trace almost instantly without slowing it
  21   down too much (buffered at most 1 second) in combination with the trace of
  22   any other process or the whole system
  23 - follow multiple processes and/or the whole system
  24 - follow the children of all attached processes
  25 - attach to processes by name and/or pid
  26 - actual time taken by the system calls (with reminder of start timestamp)
  27 - sched_switch events to know the context switches that occurred for the
  28   process we are interested in
  29 - current CPU (to see the migrations)
  30 - highlight the trace of a selection of processes while tracing the whole
  31   system to easily see the interactions
  32 - arbitrary kprobe additions to see if a process hits a certain place in the
  33   kernel
  34 .fi
  35
  36 .PP
  37 Only a subset of the LTTng events are enabled (the statedump, sched_switch,
  38 sched_process_fork and all the system calls).
  39
  40 .PP
  41
  42 The events are displayed with additionnal context information than just the raw
  43 LTTng trace (such as the current process name/PID/TID, the start/end time of
  44 the current system call, the delay since the last displayed event (filtering
  45 aware)).
  46
  47 .SH "OPTIONS"
  48
  49 .TP
  50 .BR "-f"
  51 Follow threads associated with selected PIDs
  52 .TP
  53 .BR "-p"
  54 Comma-separated list of PIDs to display (in addition to the eventual executed program)
  55 .TP
  56 .BR "-n"
  57 Comma-separated list of procnames to display (in addition to the eventual executed program)
  58 .TP
  59 .BR "-a"
  60 In textdump mode, display all events but write in bold the processes we are interested in (-f and -p)
  61 .TP
  62 .BR "-k"
  63 kprobes to insert (same format as lttng enable-event, can be repeated)
  64 .TP
  65 .BR "-o <filename>"
  66 In textdump, output the log in <filename>
  67 .TP
  68 .BR "EXECUTABLE"
  69 Program to run and connect the tracer (can be combined with other options to see the trace of other processes)
  70
  71 .SH "REQUIREMENTS"
  72
  73 .PP
  74
  75 A working installation of LTTng >= 2.4, the appropriate rights for the user to
  76 create a kernel trace and start daemons (sudo is tried in case the user is not
  77 root), Babeltrace = 1.2.4, LTTngTop = 0.3
  78
  79 .SH "SEE ALSO"
  80
  81 .PP
  82 lttngtop(1), babeltrace(1), babeltrace-log(1), lttng(1), lttng-ust(3), lttng-sessiond(8)
  83 .PP
  84 .SH "BUGS"
  85
  86 .PP
  87 Some highlighting problems with -a
  88 .SH "CREDITS"
  89
  90 lttngtrace is a wrapper on top of LTTngTop released under the GPLv2 license.
  91 See the LICENSE file in the source tree for details.
  92
  93 .PP
  94 A Web site is available at http://www.efficios.com/babeltrace for more
  95 information on Babeltrace and the Common Trace Format. See
  96 http://lttng.org for more information on the LTTng project.
  97 .PP
  98 Mailing list for support and development: <lttng-dev@lists.lttng.org>.
  99 .PP
 100 You can find us on IRC server irc.oftc.net (OFTC) in #lttng.
 101 .PP
 102
 103 .SH "AUTHORS"
 104
 105 .PP
 106 LTTngTop was originally written and is maintained by Julien Desfossez
 107 <jdesfossez@efficios.com>
 108 .PP