org.eclipse.linuxtools.lttng.help/doc/Installation.html

   1 <?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml">
   3         <head>
   4                 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
   5                 <title>LTTng Plug-in User Guide - Installation</title>
   6                 <link type="text/css" rel="stylesheet" href="book.css"/>
   7         </head>
   8         <body>
   9                 <table class="navigation" style="width: 100%;" border="0" summary="navigation">
  10                         <tr>
  11                                 <th style="width: 100%" align="center" colspan="3">Installation</th>
  12                         </tr>
  13                         <tr>
  14                                 <td style="width: 20%" align="left">
  15                                         <a href="User-Guide.html" title="Overview">
  16                                                 <img alt="Previous" border="0" src="images/prev.gif"/>
  17                                         </a>
  18                                 </td>
  19                                 <td style="width: 60%" align="center"></td>
  20                                 <td style="width: 20%" align="right">
  21                                         <a href="LTTng.html" title="LTTng">
  22                                                 <img alt="Next" border="0" src="images/next.gif"/>
  23                                         </a>
  24                                 </td>
  25                         </tr>
  26                         <tr>
  27                                 <td style="width: 20%" align="left" valign="top">Overview</td>
  28                                 <td style="width: 60%" align="center"></td>
  29                                 <td style="width: 20%" align="right" valign="top">LTTng</td>
  30                         </tr>
  31                 </table><hr/>
  32                 <h1 id="Installation">Installation</h1>
  33                 <p>This section describes the installation of the LTTng tracer and the LTTng Eclipse plug-ins as well as their dependencies.</p>
  34                 <h2 id="LTTng_Tracer">LTTng Tracer</h2>
  35                 <p>While the Eclipse plug-ins can run on the standard Eclipse platforms (Linux, Mac, Windows), the LTTng tracer and its accompanying tools run on Linux.</p>
  36                 <p>The tracer and tools have been available for download in Ubuntu since 12.04. They can easily be installed with the following command:</p>
  37                 <pre>
  38   &gt; sudo apt-get install lttng-tools
  39 </pre>
  40                 <p>For other distributions, older Ubuntu distributions, or the latest, bleeding edge LTTng tracer, please refer to the
  41                         <a href="http://lttng.org/download">LTTng website</a> for installation information.
  42                 </p>
  43                 <p>
  44                         <b>Note</b>: The LTTng tracer (and accompanying tools) is required only if you want to create your own traces (the usual case). If you intend to simply analyze existing traces then it is not necessary to install the tracer.
  45                 </p>
  46                 <h2 id="LTTng_Eclipse_Plug-ins">LTTng Eclipse Plug-ins</h2>
  47                 <p>The easiest way to install the LTTng plug-ins for Eclipse is through the Software Updates and Add-ons menu. For information on how to use this menu, refer to this
  48                         <a href="http://wiki.eclipse.org/Linux_Tools_Project/PluginInstallHelp#Installing_Updates_From_the_Linux_Tools_Update_Site">link</a>.
  49                 </p>
  50                 <p>The LTTng plug-ins are structured as a stack of features/plug-ins as following:</p>
  51                 <ul>
  52                         <li>
  53                                 <b>CTF</b> - A CTF parser that can also be used as a standalone component
  54                                 <ul>
  55                                         <li>
  56                                                 <i>Feature</i>: org.eclipse.linuxtools.ctf
  57                                         </li>
  58                                         <li>
  59                                                 <i>Plug-ins</i>: org.eclipse.linuxtools.ctf.core, org.eclipse.linuxtools.ctf.parser
  60                                         </li>
  61                                 </ul>
  62                         </li>
  63                 </ul>
  64                 <ul>
  65                         <li>
  66                                 <b>TMF</b> -
  67                                 <i>Tracing and Monitoring Framework</i> a framework for generic trace processing
  68                                 <ul>
  69                                         <li>
  70                                                 <i>Feature</i>: org.eclipse.linuxtools.tmf
  71                                         </li>
  72                                         <li>
  73                                                 <i>Plug-ins</i>: org.eclipse.linuxtools.tmf.core, org.eclipse.linuxtools.tmf.ui
  74                                         </li>
  75                                 </ul>
  76                         </li>
  77                 </ul>
  78                 <ul>
  79                         <li>
  80                                 <b>LTTng</b> - The wrapper for the LTTng tracer control. Can be used for kernel or application tracing.
  81                                 <ul>
  82                                         <li>
  83                                                 <i>Feature</i>: org.eclipse.linuxtools.lttng2
  84                                         </li>
  85                                         <li>
  86                                                 <i>Plug-ins</i>: org.eclipse.linuxtools.lttng2.core, org.eclipse.linuxtools.lttng2.ui
  87                                         </li>
  88                                 </ul>
  89                         </li>
  90                 </ul>
  91                 <ul>
  92                         <li>
  93                                 <b>LTTng Kernel</b> - Analysis components specific to Linux kernel traces
  94                                 <ul>
  95                                         <li>
  96                                                 <i>Feature</i>: org.eclipse.linuxtools.lttng2.kernel
  97                                         </li>
  98                                         <li>
  99                                                 <i>Plug-ins</i>: org.eclipse.linuxtools.lttng2.kernel.core, org.eclipse.linuxtools.lttng2.kernel.ui
 100                                         </li>
 101                                 </ul>
 102                         </li>
 103                 </ul>
 104                 <h2 id="LTTng_Eclipse_Dependencies">LTTng Eclipse Dependencies</h2>
 105                 <p>The Eclipse LTTng controls the LTTng tracer through an
 106                         <i>ssh</i> connection even if the tracer is running locally (the 'degenerate' case).
 107                 </p>
 108                 <p>Therefore, the target system (where the tracer runs) needs to run an
 109                         <i>ssh</i> server as well as
 110                         <i>sftp</i> server (for file transfer) to which you have permission to connect.
 111                 </p>
 112                 <p>On the host side (where Eclipse is running), you also need to have Eclipse RSE (Remote System Explorer) installed to handle the SSH connection and transport. The RSE can be installed the standard way (
 113                         <i>Help</i> &gt;
 114                         <i>Install New Software...</i> &gt;
 115                         <i>General Purpose Tools</i> &gt;
 116                         <i>Remote System Explorer End-User Runtime</i>).
 117                 </p>
 118                 <h2 id="Installation_Verification">Installation Verification</h2>
 119                 <p>Here are the quick steps to verify that your installation is functional:</p>
 120                 <ul>
 121                         <li>Start Eclipse</li>
 122                         <li>Open the LTTng perspective</li>
 123                         <li>Create a Tracing project
 124                                 <ul>
 125                                         <li>Right-click in the Project view and select "New Project"</li>
 126                                         <li>Enter the name of your project (e.g. "MyLTTngProject")</li>
 127                                         <li>The project will be created. It will contain 2 empty folders: "Traces" and "Experiments"</li>
 128                                 </ul>
 129                         </li>
 130                         <li>Import a sample trace
 131                                 <ul>
 132                                         <li>Right-click on the newly created project "Traces" folder and select "Import..."</li>
 133                                         <li>Navigate to the sample LTTng trace that you want to visualize</li>
 134                                         <li>Select that trace (check box), select the trace type (e.g. CTF: Kernel Trace), and press "Finish"</li>
 135                                         <li>The newly imported trace should appear under the Traces folder</li>
 136                                 </ul>
 137                         </li>
 138                         <li>Visualize the trace
 139                                 <ul>
 140                                         <li>Expand the Traces folder</li>
 141                                         <li>Double-click on the trace</li>
 142                                         <li>The trace should load and the views be populated</li>
 143                                 </ul>
 144                         </li>
 145                 </ul>
 146                 <p>If an error message is displayed, you might want to double-check that the trace type is correctly set (right-click on the trace and "Select Trace Type...").</p>
 147                 <p>Refer to
 148                         <a href="LTTng.html#Tracing_Perspective">Tracing Perspective</a> for detailed description of the views and their usage.
 149                 </p>
 150                 <p>To download sample LTTng traces, go to
 151                         <a href="http://lttng.org/download">http://lttng.org/download</a>. At the bottom of the page there is a link to some sample LTTng 2.0 kernel traces.
 152                 </p><hr/>
 153                 <table class="navigation" style="width: 100%;" border="0" summary="navigation">
 154                         <tr>
 155                                 <td style="width: 20%" align="left">
 156                                         <a href="User-Guide.html" title="Overview">
 157                                                 <img alt="Previous" border="0" src="images/prev.gif"/>
 158                                         </a>
 159                                 </td>
 160                                 <td style="width: 60%" align="center">
 161                                         <a href="User-Guide.html" title="LTTng Plug-in User Guide">
 162                                                 <img alt="LTTng Plug-in User Guide" border="0" src="images/home.gif"/>
 163                                         </a>
 164                                 </td>
 165                                 <td style="width: 20%" align="right">
 166                                         <a href="LTTng.html" title="LTTng">
 167                                                 <img alt="Next" border="0" src="images/next.gif"/>
 168                                         </a>
 169                                 </td>
 170                         </tr>
 171                         <tr>
 172                                 <td style="width: 20%" align="left" valign="top">Overview</td>
 173                                 <td style="width: 60%" align="center"></td>
 174                                 <td style="width: 20%" align="right" valign="top">LTTng</td>
 175                         </tr>
 176                 </table>
 177         </body>
 178 </html>