X-Git-Url: http://git.lttng.org./?a=blobdiff_plain;f=trunk%2Flttv%2FQUICKSTART.html;h=31c6bbae40e2c320d64f7633e12eb931e08b2ce6;hb=0e12ccd4b1063e26bc14dbde81920ae41dd868a3;hp=719b462015fdca4eeb7c9bf49018a49f7ef76d56;hpb=2d540155a90f950cbda2d6f5f773e0c2206887b7;p=lttv.git diff --git a/trunk/lttv/QUICKSTART.html b/trunk/lttv/QUICKSTART.html index 719b4620..31c6bbae 100644 --- a/trunk/lttv/QUICKSTART.html +++ b/trunk/lttv/QUICKSTART.html @@ -1,20 +1,24 @@ - Linux Trace Toolkit Next Generation User Documentation + Linux Trace Toolkit Next Generation Manual -

Linux Trace Toolkit Next Generation User Documentation

Linux Trace Toolkit Next Generation Manual

Author : Mathieu Desnoyers, September 2005
Last update : January 21st, 2009
(originally known as the LTTng QUICKSTART guide)

Introduction

Supported architectures

Installing LTTng and LTTV from sources

Userspace Tracing

Getting and installing the LTTV package

Using LTTng and LTTV

Use graphical LTTV to control +tracing and analyse traces
Use text mode LTTng to +control tracing
Use text mode LTTV
Tracing in "Hybrid" mode
Tracing in flight recorder mode

Adding kernel and user-space -tracepoints

Adding kernel instrumentation
Adding userspace instrumentation

Creating Debian and RPM packages -from LTTV +from LTTV

Create custom LTTV Debian +
Create custom LTTng packages

Examples of LTTng use in the +field

Introduction

-This document is made of four parts : the first one explains how +This document is made of five parts : the first one explains how to install LTTng and LTTV from sources, the second one describes the steps to follow to trace a system and view it. The third part explains briefly how to add a new trace point to the kernel and to user space -applications. The fourth and last part explains how to create Debian or RPM -packages from the LTTng and LTTV sources. +applications. The fourth part explains how to create Debian or RPM +packages from the LTTng and LTTV sources. The fifth and last part describes use +of LTTng in the field.

These operations are made for installing the LTTng 0.86 tracer on a linux 2.6.X kernel. You will also find instructions for installation of LTTV 0.12.x : the @@ -54,21 +82,33 @@ To see the list of compatibilities between LTTng, ltt-control, LTTV, please refer to : LTTng+LTTV versions compatibility -The lttng patch is necessary to have the tracing hooks in the kernel. + +The ongoing work had the Linux Kernel Markers integrated in the mainline Linux +kernel since Linux 2.6.24 and the Tracepoints since 2.6.28. In its current +state, the lttng patchset is necessary to have the trace clocksource, the +instrumentation and the LTTng high-speed data extraction mechanism added to the +kernel.

-Supported architectures : -br> +

Supported architectures

x86 32/64 bits
PowerPC 32 and 64 bits
ARM (with limited timestamping precision, e.g. 1HZ. Need architecture-specific support for better precision)
MIPS +
sh (partial architecture-specific instrumentation) +
sparc64 (partial architecture-specific instrumentation) +
s390 (partial architecture-specific instrumentation) +
Other architectures supported without architecture-specific instrumentation +and with low-resolution timestamps.

LTTV :
+
Intel 32/64 bits
PowerPC 32 and 64 bits
Possibly others. Takes care of endianness and type size difference between @@ -360,12 +400,13 @@ make install
Using LTTng and LTTV
-
IMPORTANT : Arm Linux Kernel Markers after each boot
IMPORTANT : Arm Linux Kernel Markers after each boot before tracing

 ltt-armall

Use graphical LTTV to control tracing and analyse traces

Use graphical LTTV to control +tracing and analyse traces

 lttv-gui (or /usr/local/bin/lttv-gui)
   - Spot the "Tracing Control" icon : click on it
@@ -377,7 +418,7 @@ lttv-gui (or /usr/local/bin/lttv-gui)
       * You should now see a trace

Use text mode LTTng to control tracing

Use text mode LTTng to control tracing

 The tracing can be controlled from a terminal by using the lttctl command (as
 root).
@@ -394,12 +435,12 @@ see lttctl --help for details.

(note : to see if the buffers has been filled, look at the dmesg output after -lttctl -R or after stopping tracing from the GUI, it will show an event lost +lttctl -D or after stopping tracing from the GUI, it will show an event lost count. If it is the case, try using larger buffers. See lttctl --help to learn how. lttv now also shows event lost messages in the console when loading a trace with missing events or lost subbuffers.) -

Use text mode LTTV

Use text mode LTTV

Feel free to look in /usr/local/lib/lttv/plugins to see all the text and graphical plugins available. @@ -417,7 +458,7 @@ of the events to the clipboard and paste them in the GUI by clicking on the bottom right label "Current time". Support for this type of filtering should be added to the filter module soon. -

Hybrid mode

Tracing in "Hybrid" mode

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 @@ -442,6 +483,8 @@ lttctl -D -w /tmp/trace2 trace2

Each "overwrite" channel is flight recorder channel. + +

Tracing in flight recorder mode

Flight recorder mode

The flight recorder mode writes data into overwritten buffers for all channels, @@ -462,14 +505,24 @@ lttctl -D -w /tmp/trace3 trace3 markers

Adding kernel +instrumentation

-See Documentation/markers.txt and Documentation/tracepoints.txt in your kernel +See Documentation/markers.txt +and Documentation/tracepoints.txt in your kernel tree. +

+Also see ltt/probes/ +for LTTng probe examples. -

Add new events to userspace programs with -userspace markers packages

Adding userspace instrumentation

+Add new events to userspace programs with +userspace markers packages. 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. @@ -480,7 +533,7 @@ href="http://ltt.polymtl.ca/packages/markers-userspace-0.5.tar.bz2">markers-user Note that a new design document for a 3rd generation of tracepoint/marker-based userspace tracing is available at LTTng User-space Tracing -Design". This new infrastructure is not yet implemented. +Design. This new infrastructure is not yet implemented.

The easy quick-and-dirty way to perform userspace tracing is currently to write @@ -493,7 +546,7 @@ installation for sources section of this document.

Creating Debian or RPM packages

Create custom LTTV Debian packages

Create custom LTTV Debian packages

 Use : dpkg-buildpackage -rfakeroot
@@ -501,7 +554,7 @@ Use : dpkg-buildpackage -rfakeroot
 
 You should then have your LTTV .deb files created for your architecture.
 
-
Create custom LTTng packages
+Create custom LTTng packages
 
 For building LTTng Debian packages :
 get the build tree with patches applies as explained in section 2.
@@ -518,7 +571,50 @@ dpkg -i /usr/src/(image-name).deb
 

 Then, follow the section "Editing the system wide configuration" in section 2.
 
+

+
+Examples of LTTng use in the field
+
+A few examples of successful LTTng users :
+
+

+ Google are deploying LTTng on their servers. They want to use it to
+  monitor their production servers (with flight recorder mode tracing)
+  and to help them solve hard to reproduce problems. They have had
+  success with such tracing approach to fix "rare disk delay" issues and
+  VM-related issues presented in this article :
+
+   Linux Kernel
+Debugging on Google-sized clusters at Ottawa Linux
+    Symposium 2007
+
+
 IBM Research have had problems with Commercial Scale-out applications,
+  which are being an increasing trend to split large server workloads.
+  They used LTTng successfully to solve a distributed filesystem-related
+  issue. It's presented in the same paper above.
+
+
 Autodesk, in the development of their next-generation of Linux
+  audio/video edition applications, used LTTng extensively to solve
+  soft real-time issues they had. Also presented in the same paper.
 
+
 Wind River included LTTng in their Linux distribution so their
+  clients, already familiar to Wind River own tracing solution in
+  VxWorks, car have the same kind of feature they have relied on for a
+  long time.
 
+
 Montavista have integrated LTTng in their distribution for the same
+  reasons. It's used by Sony amongst others.
+
+
 SuSE are currently integrating LTTng in their next SLES distribution,
+  because their clients asking for solutions which supports a kernel
+  closer to real-time need such tools to debug their problems.
+
+
 A project between Ericsson, the Canadian Defense, NSERC and various
+  universities is just starting. It aims at monitoring and debugging
+  multi-core systems and provide automated and help user system behavior
+  analysis.
+
+
 Siemens have been using LTTng internally for quite some time now.
+

Linux Trace Toolkit Next Generation User Documentation

Linux Trace Toolkit Next Generation Manual

Table of Contents