(originally known as the LTTng QUICKSTART guide)
<h2>Table of Contents</h2>
-<ul>
+<ul>
<li><a href="#intro" name="TOCintro">Introduction</a></li>
+
<li><a href="#section1" name="TOCsection1">Installing LTTng and LTTV from
-<ul>
-<li><a href="#userspacetracing" name="TOCuserspacetracing">Userspace Tracing</ul>
sources</a></li>
+<ul>
+<li><a href="#prerequisites" name="TOCprerequisites">Prerequisistes</li>
+<li><a href="#getlttng" name="TOCgetlttng">Getting the LTTng packages</li>
+<li><a href="#getlttngsrc" name="TOCgetlttngsrc">Getting the LTTng kernel sources</li>
+<li><a href="#installlttng" name="TOCinstalllttng">Installing a LTTng kernel</li>
+<li><a href="#editconfig" name="TOCeditconfig">Editing the system wide
+configuration</a>
+<li><a href="#getlttctl" name="TOCgetlttctl">Getting and installing the
+ltt-control package</li>
+<li><a href="#userspacetracing" name="TOCuserspacetracing">Userspace Tracing</li>
+<li><a href="#getlttv" name="TOCgetlttv">Getting and installing the LTTV package</ul>
+
<li><a href="#section2" name="TOCsection2">Using LTTng and LTTV</a></li>
+<ul>
+<li><a href="#uselttvgui" name="TOCuselttvgui">Use graphical LTTV to control
+tracing and analyse traces</a></li>
+<li><a href="#uselttngtext" name="TOCuselttngtext">Use text mode LTTng to
+<li><a href="#uselttvtext" name="TOCuselttvtext">Use text mode LTTV</a></li>
+<li><a href="#hybrid" name="TOChybrid">Tracing in "Hybrid" mode</a></li>
+<li><a href="#flight" name="TOCflight">Tracing in flight recorder mode</a></li>
+
+</ul>
+
<li><a href="#section3" name="TOCsection3">Adding kernel and user-space
-tracepoints</a></li>
+instrumentation</a>
+<ul>
+<li><a href="#kerneltp" name="TOCkerneltp">Adding kernel instrumentation</a></li>
+<li><a href="#usertp" name="TOCusertp">Adding userspace instrumentation</a></li>
+</ul>
+
<li><a href="#section4" name="TOCsection4">Creating Debian and RPM packages
-from LTTV</a>
+from LTTV</a></li>
+<ul>
+<li><a href="#pkgdebian" name="TOCpkgdebian">Create custom LTTV Debian
+<li><a href="#pkglttng" name="TOCpkglttng">Create custom LTTng packages</a></li>
+</ul>
</ul>
<br>
<br>
Supported architectures :
-<br>
+br>
LTTng :<br>
<li> x86 32/64 bits
<li> PowerPC 32 and 64 bits
<h2><a href="#TOCsection1" name="section1">Installation from sources</a></h2>
<p>
-<li>Prerequisites</li>
+<h3><a href="#TOCprerequisites" name="prerequisites">Prerequisites</a></h3>
<ul>
<p>
Tools needed to follow the package download steps :
versions compatibility</a>.
-<li>Getting the LTTng packages</li>
+<h3><a href="#TOCgetlttng" name="getlttng">Getting the LTTng packages</a></h3>
<PRE>
su -
</PRE>
-<li>Getting LTTng kernel sources</li>
+<h3><a href="#TOCgetlttngsrc" name="getlttngsrc">Getting LTTng kernel sources</a></h3>
<PRE>
su -
</PRE>
-<li>Installing a LTTng kernel</li>
+<h3><a href="#TOCinstalllttng" name="installlttng">Installing a LTTng kernel</a></h3>
<PRE>
su -
--
</PRE>
-<li>Editing the system wide configuration</li>
+<h3><a href="#TOCeditconfig" name="editconfig">Editing the system wide
+configuration</a></h3>
<p>
You must activate debugfs and specify a mount point. This is typically done in
#echo lockdep-trace >> /etc/modules
</PRE>
-<li>Getting and installing the ltt-control package (on the traced machine)</li>
+
+<h3><a href="#TOCgetlttctl" name="getlttctl">Getting and installing the
+ltt-control package (on the traced machine)</a></h3>
<p>
(note : the ltt-control package contains lttd and lttctl. Although it has the
same name as the ltt-control kernel module, they are *not* the same thing.)
event name : event
</PRE>
-<li>Getting and installing the LTTV package (on the visualisation machine, same
-or different from the visualisation machine)</li>
+<h3><a href="#TOCgetlttv" name="getlttv">Getting and installing the LTTV package
+(on the visualisation machine, same
+or different from the visualisation machine)</a></h3>
<PRE>
su -
<h2><a href="#TOCsection2" name="section2">Using LTTng and LTTV</a></h2>
-<li>IMPORTANT : Arm Linux Kernel Markers after each boot</li>
+<li><b>IMPORTANT : Arm Linux Kernel Markers after each boot before tracing</b></li>
<PRE>
ltt-armall
</PRE>
-<li>Use graphical LTTV to control tracing and analyse traces</li>
+<h3><a href="#TOCuselttvgui" name="uselttvgui">Use graphical LTTV to control
+tracing and analyse traces</a></h3>
<PRE>
lttv-gui (or /usr/local/bin/lttv-gui)
- Spot the "Tracing Control" icon : click on it
* You should now see a trace
</PRE>
-<li>Use text mode LTTng to control tracing</li>
+<h3><a href="#TOCuselttngtext" name="uselttngtext">Use text mode LTTng to control tracing</a></h3>
<PRE>
The tracing can be controlled from a terminal by using the lttctl command (as
root).
how. lttv now also shows event lost messages in the console when loading a trace
with missing events or lost subbuffers.)
-<li>Use text mode LTTV</li>
+<h3><a href="#TOCuselttvtext" name="uselttvtext">Use text mode LTTV</a></h3>
<p>
Feel free to look in /usr/local/lib/lttv/plugins to see all the text and
graphical plugins available.
bottom right label "Current time". Support for this type of filtering should
be added to the filter module soon.
-<li>Hybrid mode</li>
+<h3><a href="#TOChybrid" name="hybrid">Tracing in "Hybrid" mode</a></h3>
<p>
Starting from LTTng 0.5.105 and ltt-control 0.20, a new mode can be used :
hybrid. It can be especially useful when studying big workloads on a long period
<p>
Each "overwrite" channel is flight recorder channel.
+
+<h3><a href="#TOCflight" name="flight">Tracing in flight recorder mode</a></h3>
<li>Flight recorder mode</li>
<p>
The flight recorder mode writes data into overwritten buffers for all channels,
markers</a></h2>
<p>
+<h3><a href="#TOCkerneltp" name="kerneltp">Adding kernel
+instrumentation</a></h3>
+
<p>
-See Documentation/markers.txt and Documentation/tracepoints.txt in your kernel
+See <a
+href="http://git.kernel.org/?p=linux/kernel/git/compudj/linux-2.6-lttng.git;a=blob;f=Documentation/markers.txt">Documentation/markers.txt</a>
+and <a
+href="http://git.kernel.org/?p=linux/kernel/git/compudj/linux-2.6-lttng.git;a=blob;f=Documentation/tracepoints.txt">Documentation/tracepoints.txt</a> in your kernel
tree.
+<p>
+Also see <a
+href="http://git.kernel.org/?p=linux/kernel/git/compudj/linux-2.6-lttng.git;a=tree;f=ltt/probes">ltt/probes/</a>
+for LTTng probe examples.
-<li>Add new events to userspace programs with
-<a href="http://ltt.polymtl.ca/packages/">userspace markers packages</a></li>
+<h3><a href="#TOCusertp" name="usertp">Adding userspace instrumentation</a></h3>
-<p>
+Add new events to userspace programs with
+<a href="http://ltt.polymtl.ca/packages/">userspace markers packages</a>.
Get the latest markers-userspace-*.tar.bz2 and see the Makefile and examples. It
allows inserting markers in executables and libraries, currently only on x86_32
and x86_64.
Note that a new design document for a 3rd generation of tracepoint/marker-based
userspace tracing is available at <a
href="http://ltt.polymtl.ca/svn/trunk/lttv/doc/developer/ust.html">LTTng User-space Tracing
-Design"</a>. This new infrastructure is not yet implemented.
+Design</a>. This new infrastructure is not yet implemented.
<p>
The easy quick-and-dirty way to perform userspace tracing is currently to write
<h2><a href="#TOCsection4" name="section4">Creating Debian or RPM packages</a></h2>
<p>
-<li>Create custom LTTV Debian packages</li>
+<h3><a href="#TOCpkgdebian" name="pkgdebian">Create custom LTTV Debian packages</a></h3>
<PRE>
Use : dpkg-buildpackage -rfakeroot
<p>
You should then have your LTTV .deb files created for your architecture.
-<li>Create custom LTTng packages</li>
+<h3><a href="#TOCpkglttng" name="pkglttng">Create custom LTTng packages</a></h3>
<p>
For building LTTng Debian packages :
get the build tree with patches applies as explained in section 2.
projects / lttv.git / blobdiff