Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMatthew Khouzam2012-11-30 13:00:57 -0500
committerMatthew Khouzam2012-12-04 14:06:32 -0500
commit7bef6e249ecbd43a56e7b881318d3ffc5001bb88 (patch)
treeb3a9625220e1b53dd60d9f146adb33aa578420d4
parentfbc3bb66c41e59f8f4ffcd6b3625b4d742718ca4 (diff)
downloadorg.eclipse.linuxtools-7bef6e249ecbd43a56e7b881318d3ffc5001bb88.tar.gz
org.eclipse.linuxtools-7bef6e249ecbd43a56e7b881318d3ffc5001bb88.tar.xz
org.eclipse.linuxtools-7bef6e249ecbd43a56e7b881318d3ffc5001bb88.zip
Update Documentation to better reflect branch
* Describe time stamp formatting * Update descriptions of event views to editors * Update images to reflect better timestamps * Add description of events properties view * Update Description of statistics view * Recompress images Change-Id: Ia00b76353ed6fb9fa8f81c819d2ff39ad3b78608 Signed-off-by: Matthew Khouzam <matthew.khouzam@ericsson.com>
-rw-r--r--lttng/org.eclipse.linuxtools.lttng.help/doc/Installation.html4
-rw-r--r--lttng/org.eclipse.linuxtools.lttng.help/doc/LTTng-Kernel-Analysis.html20
-rw-r--r--lttng/org.eclipse.linuxtools.lttng.help/doc/LTTng.html42
-rw-r--r--lttng/org.eclipse.linuxtools.lttng.help/doc/Limitations.html12
-rw-r--r--lttng/org.eclipse.linuxtools.lttng.help/doc/Timestamp-formatting.html99
-rw-r--r--lttng/org.eclipse.linuxtools.lttng.help/doc/User-Guide-toc.xml5
-rw-r--r--lttng/org.eclipse.linuxtools.lttng.help/doc/User-Guide.mediawiki66
-rw-r--r--lttng/org.eclipse.linuxtools.lttng.help/doc/images/HistogramView.pngbin52773 -> 21213 bytes
-rw-r--r--lttng/org.eclipse.linuxtools.lttng.help/doc/images/LTTng2EnvironmentsView.pngbin0 -> 21412 bytes
-rw-r--r--lttng/org.eclipse.linuxtools.lttng.help/doc/images/LTTng2EventProperties.pngbin0 -> 20726 bytes
-rw-r--r--lttng/org.eclipse.linuxtools.lttng.help/doc/images/LTTng2EventsEditor.pngbin0 -> 112951 bytes
-rw-r--r--lttng/org.eclipse.linuxtools.lttng.help/doc/images/LTTng2StatisticsView.pngbin65762 -> 45391 bytes
-rw-r--r--lttng/org.eclipse.linuxtools.lttng.help/doc/images/LTTngKernelPerspective.pngbin155332 -> 226846 bytes
-rw-r--r--lttng/org.eclipse.linuxtools.lttng.help/doc/images/TmfTimestampFormatPage.pngbin0 -> 111880 bytes
-rw-r--r--lttng/org.eclipse.linuxtools.lttng.help/toc.xml6
15 files changed, 190 insertions, 64 deletions
diff --git a/lttng/org.eclipse.linuxtools.lttng.help/doc/Installation.html b/lttng/org.eclipse.linuxtools.lttng.help/doc/Installation.html
index dcbfe03c9c..48f623d749 100644
--- a/lttng/org.eclipse.linuxtools.lttng.help/doc/Installation.html
+++ b/lttng/org.eclipse.linuxtools.lttng.help/doc/Installation.html
@@ -47,10 +47,6 @@
<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
<a href="http://wiki.eclipse.org/Linux_Tools_Project/PluginInstallHelp#Installing_Updates_From_the_Linux_Tools_Update_Site">link</a>.
</p>
- <p>The legacy (
- <i>Classic</i> :-)) Eclipse LTTng (v0.x) is also available as an optional download. Refer to
- <a href="http://wiki.eclipse.org/index.php/Linux_Tools_Project/LTTng/User_Guide">here</a> for installation and verification instructions.
- </p>
<p>The LTTng plug-ins are structured as a stack of features/plug-ins as following:</p>
<ul>
<li>
diff --git a/lttng/org.eclipse.linuxtools.lttng.help/doc/LTTng-Kernel-Analysis.html b/lttng/org.eclipse.linuxtools.lttng.help/doc/LTTng-Kernel-Analysis.html
index ad935d2661..930e4cd52b 100644
--- a/lttng/org.eclipse.linuxtools.lttng.help/doc/LTTng-Kernel-Analysis.html
+++ b/lttng/org.eclipse.linuxtools.lttng.help/doc/LTTng-Kernel-Analysis.html
@@ -18,7 +18,7 @@
</td>
<td style="width: 60%" align="center"></td>
<td style="width: 20%" align="right">
- <a href="Limitations.html" title="Limitations">
+ <a href="Timestamp-formatting.html" title="Timestamp formatting">
<img alt="Next" border="0" src="images/next.gif"/>
</a>
</td>
@@ -26,7 +26,7 @@
<tr>
<td style="width: 20%" align="left" valign="top">LTTng</td>
<td style="width: 60%" align="center"></td>
- <td style="width: 20%" align="right" valign="top">Limitations</td>
+ <td style="width: 20%" align="right" valign="top">Timestamp formatting</td>
</tr>
</table><hr/>
<h1 id="LTTng_Kernel_Analysis">LTTng Kernel Analysis</h1>
@@ -132,7 +132,7 @@
</ul>
<p>When the current time indicator is changed (when clicking in the states flow), all the other views are
<b>synchronized</b>. For example, the
- <a href="LTTng-Kernel-Analysis.html#Events_View_2">Events View</a> will show the event matching the current time indicator. The reverse behaviour is also implemented: selecting an event within the Events View will update the Control Flow View current time indicator.
+ <a href="LTTng-Kernel-Analysis.html#LTTng_Kernel_Events_Editor">Events Editor</a> will show the event matching the current time indicator. The reverse behaviour is also implemented: selecting an event within the Events View will update the Control Flow View current time indicator.
</p>
<h4 id="Incomplete_regions">Incomplete regions</h4>
<p>You'll notice
@@ -220,7 +220,7 @@
</p>
<p>This view is also synchronized with the others :
<a href="LTTng.html#Histogram_View">histogram</a>,
- <a href="LTTng-Kernel-Analysis.html#Events_View_2">events view</a>,
+ <a href="LTTng-Kernel-Analysis.html#LTTng_Kernel_Events_Editor">Events editor</a>,
<a href="LTTng-Kernel-Analysis.html#Control_Flow_View">control flow view</a>, etc.
</p>
<h3 id="Navigation">Navigation</h3>
@@ -244,10 +244,10 @@
<a href="LTTng-Kernel-Analysis.html#Toolbar">Toolbar</a>
</b>.
</p>
- <h2 id="Events_View_2">Events View</h2>
- <p>The LTTng Kernel Events View
+ <h2 id="LTTng_Kernel_Events_Editor">LTTng Kernel Events Editor</h2>
+ <p>The LTTng Kernel Events editor
<b>is</b> the plain TMF
- <a href="LTTng.html#Events_View">Events Views</a> except that it provide its own specialized viewer to replace the standard one. In short, it has exactly the same behaviour but the layout is slightly different:
+ <a href="LTTng.html#Events_Editor">Events Editor</a>, except that it provides its own specialized viewer to replace the standard one. In short, it has exactly the same behaviour but the layout is slightly different:
</p>
<ul>
<li>
@@ -264,7 +264,7 @@
</li>
</ul>
<p>
- <img border="0" src="images/LTTngKernelEventsViewer.png"/>
+ <img border="0" src="images/LTTng2EventsEditor.png"/>
</p><hr/>
<table class="navigation" style="width: 100%;" border="0" summary="navigation">
<tr>
@@ -279,7 +279,7 @@
</a>
</td>
<td style="width: 20%" align="right">
- <a href="Limitations.html" title="Limitations">
+ <a href="Timestamp-formatting.html" title="Timestamp formatting">
<img alt="Next" border="0" src="images/next.gif"/>
</a>
</td>
@@ -287,7 +287,7 @@
<tr>
<td style="width: 20%" align="left" valign="top">LTTng</td>
<td style="width: 60%" align="center"></td>
- <td style="width: 20%" align="right" valign="top">Limitations</td>
+ <td style="width: 20%" align="right" valign="top">Timestamp formatting</td>
</tr>
</table>
</body>
diff --git a/lttng/org.eclipse.linuxtools.lttng.help/doc/LTTng.html b/lttng/org.eclipse.linuxtools.lttng.help/doc/LTTng.html
index bf2a730c4c..3c7cd03882 100644
--- a/lttng/org.eclipse.linuxtools.lttng.help/doc/LTTng.html
+++ b/lttng/org.eclipse.linuxtools.lttng.help/doc/LTTng.html
@@ -40,7 +40,7 @@
<a href="LTTng.html#Project_View">Project View</a>
</li>
<li>
- <a href="LTTng.html#Events_View">Events View</a>
+ <a href="LTTng.html#Events_Editor">Events Editor</a>
</li>
<li>
<a href="LTTng.html#Histogram_View">Histogram View</a>
@@ -226,7 +226,7 @@
<h3 id="Renaming_a_Trace_or_Experiment">Renaming a Trace or Experiment</h3>
<p>Traces and Experiment can be renamed from the
<b>Project Explorer</b> view. To rename a trace or experiment select the relevant trace and click the right mouse button. Then select
- <b>Rename...</b> from the context sensitive menu.
+ <b>Rename...</b> from the context sensitive menu. The trace or experiment needs to be closed in order to do this operation.
</p>
<p>
<img border="0" src="images/RenameTraceAction.png"/>
@@ -272,7 +272,7 @@
<h3 id="Deleting_a_Trace_or_Experiment">Deleting a Trace or Experiment</h3>
<p>To delete a trace or experiment select the relevant trace or experiment in the
<b>Project Explorer</b> view and click the right mouse button. Then select
- <b>Delete...</b> from the context sensitive menu.
+ <b>Delete...</b> from the context sensitive menu. The trace or experiment needs to be closed in order to do this operation.
</p>
<p>
<img border="0" src="images/DeleteExperimentAction.png"/>
@@ -290,10 +290,11 @@
</p>
<h3 id="Deleting_Supplementary_Files">Deleting Supplementary Files</h3>
<p>Supplementary files are by definition trace specific files that accompany a trace. These file could be temporary files, persistent indexes or any other persistent data files created by the LTTng integration in Eclipse during parsing a trace. For the LTTng 2.0 trace viewer a persistent state history of the Linux Kernel is created and is stored under the name
- <b>stateHistroy.ht</b>.
+ <b>stateHistory.ht</b>. The statistics for all traces are stored under
+ <b>statistics.ht</b>. Other state systems may appear in the same folder as more custom views are added.
</p>
<p>All supplementary file are hidden from the user and are handled internally by the TMF. However, there is a possibility to delete the supplementary files so that there are recreated when opening a trace.</p>
- <p>To delete all supplementary files from a single trace, select the relevant trace in the
+ <p>To delete all supplementary files from a single trace, first, make sure the trace is not opened, then select the relevant trace in the
<b>Project Explorer</b> view and click the right mouse button. Then select the
<b>Delete Supplementary Files...</b> menu item from the context-sensitive menu.
</p>
@@ -308,7 +309,7 @@
</p>
<p>To delete all supplementary files from all traces of a experiment, select the relevant experiment in the
<b>Project Explorer</b> view and click the right mouse button. In the context-sensitive menu select
- <b>Delete Supplementary Files...</b> menu item.
+ <b>Delete Supplementary Files...</b> menu item. The experiment and included traces need to be closed in order to do this operation.
</p>
<p>A new dialog box will open with a list of supplementary files. Note that the supplementary files are prefixed with the trace name to indicate the trace they belong to. Select the file(s) to delete from the list and press
<b>OK</b>.
@@ -330,9 +331,11 @@
<p>Traces can be also be imported to a project by dragging from another tracing project and dropping to the project's trace folder. The trace will be copied and the trace type will be set.</p>
<p>Any resource can be dragged and dropped from a non-tracing project, and any file or folder can be dragged from an external tool, into a tracing project's trace folder. The resource will be copied or imported as a new trace, however the trace type will be unknown and need to be set manually by the user.</p>
<p>It is also possible to drop a trace, resource, file or folder into an existing experiment. If the item does not already exist as a trace in the project's trace folder, it will first be copied or imported, then the trace will be added to the experiment.</p>
- <h2 id="Events_View">Events View</h2>
- <p>The Events view shows the basic trace data in chronological order in a tabular format.</p>
- <p>When opened, the Events view displays the events of the currently selected trace or experiment.</p>
+ <h2 id="Events_Editor">Events Editor</h2>
+ <p>The Events editor shows the basic trace data elements (events) in a tabular format. The editors can be dragged in the editor area so that several traces may be shown side by side. These traces are synchronized by timestamp.</p>
+ <p>
+ <img border="0" src="images/LTTng2EventsEditor.png"/>
+ </p>
<p>The header displays the current trace (or experiment) name. </p>
<p>Being part of the
<b>Tracing and Monitoring</b> Framework, the default table displays the following fields:
@@ -355,12 +358,13 @@
</li>
</ul>
<p>The first row of the table is the header row a.k.a. the Search and Filter row.</p>
- <p>
- <img border="0" src="images/DefaultEventsView.png"/>
- </p>
<p>The highlighted event is the
- <i>current event</i> and is synchronized with the other views. If you select another event, the other views will be synchronized accordingly.
+ <i>current event</i> and is synchronized with the other views. If you select another event, the other views will be updated accordingly. The properties view will display a more detailed view of the selected event.
+ </p>
+ <p>
+ <img border="0" src="images/LTTng2EventProperties.png"/>
</p>
+ <p>The Events editor can be closed, disposing a trace. When this is done, all the views displaying the information will be updated with the trace data of the next event editor tab. If all the editor tabs are closed, then the views will display their empty states.</p>
<h3 id="Searching_and_Filtering">Searching and Filtering</h3>
<p>Searching and filtering of events in the table can be performed by entering matching conditions in one or multiple columns in the header row (the first row below the column header).</p>
<p>To toggle between searching and filtering, click on the 'search' (
@@ -463,14 +467,16 @@
</li>
</ul>
<h2 id="Statistics_View">Statistics View</h2>
- <p>The Statistics View displays the various event counters that are collected when analyzing a trace. The data is organized per trace. To open the Statistics View, select Windows -&gt; Show View -&gt; Other... -&gt; Tracing -&gt; Statistics. A new view will open with the name Statistics. This view shows 2 columns:
- <i>Level</i> and
- <i>Number of Events</i>. After parsing a trace the view will display the number of events per event type. The cells where the number of events are printed also contain a colored bar that indicates the percentage of the event count in relation to the total number of events. The statistics is collected for the whole trace. This view is part of the
+ <p>The Statistics View displays the various event counters that are collected when analyzing a trace. The data is organized per trace. To open the Statistics View, select Windows -&gt; Show View -&gt; Other... -&gt; Tracing -&gt; Statistics. A new view will open with the name Statistics. This view shows 3 columns:
+ <i>Level</i>
+ <i>Events total</i> and
+ <i>Events in selected time range</i>. After parsing a trace the view will display the number of events per event type in the second column and in the third, the currently selected time range's event type distribution is shown. The cells where the number of events are printed also contain a colored bar that indicates the percentage of the event count in relation to the total number of events. The statistics is collected for the whole trace. This view is part of the
<b>Tracing and Monitoring Framework (TMF)</b> and is generic. It will work for any trace type extensions. For the LTTng 2.0 integration the Statistics view will display statistics as shown below.:
</p>
<p>
<img border="0" src="images/LTTng2StatisticsView.png"/>
</p>
+ <p>By default, the statistics use a state system, therefore will load very quickly once the state system is written to the disk as a supplementary file.</p>
<h2 id="Colors_View">Colors View</h2>
<p>
<img border="0" src="images/ColorsView.png"/>
@@ -557,7 +563,7 @@
<p>A new feature of CTF traces is their ability to store user defined data that is not to be placed in an event. It is generally data that is per-trace specific, such as the tracer version and the trace domain. It will be populated when a trace is loaded if the trace has environment variables.
<br/>
- <img border="0" src="images/environment_variables.png"/>
+ <img border="0" src="images/LTTng2EnvironmentsView.png"/>
<br/>
The above picture shows a trace loaded that was collevcted with the
<b>lttng-modules</b> version
@@ -1049,7 +1055,7 @@
<p>To delete a remote host connection, select the host in the Control View and press the
<b>Delete</b> button. Alternatively, press the right mouse button. A context-sensitive menu will show. Select the
<b>Delete</b> button. For that command to be active the connection state has to be
- <b>DISCONNECTED</b>.
+ <b>DISCONNECTED</b> and the trace has to be closed.
</p>
<p>
<img border="0" src="images/LTTng2ControlViewDelete.png"/>
diff --git a/lttng/org.eclipse.linuxtools.lttng.help/doc/Limitations.html b/lttng/org.eclipse.linuxtools.lttng.help/doc/Limitations.html
index 07515eef74..f39d56802c 100644
--- a/lttng/org.eclipse.linuxtools.lttng.help/doc/Limitations.html
+++ b/lttng/org.eclipse.linuxtools.lttng.help/doc/Limitations.html
@@ -12,7 +12,7 @@
</tr>
<tr>
<td style="width: 20%" align="left">
- <a href="LTTng-Kernel-Analysis.html" title="LTTng Kernel Analysis">
+ <a href="Timestamp-formatting.html" title="Timestamp formatting">
<img alt="Previous" border="0" src="images/prev.gif"/>
</a>
</td>
@@ -24,17 +24,19 @@
</td>
</tr>
<tr>
- <td style="width: 20%" align="left" valign="top">LTTng Kernel Analysis</td>
+ <td style="width: 20%" align="left" valign="top">Timestamp formatting</td>
<td style="width: 60%" align="center"></td>
<td style="width: 20%" align="right" valign="top">How to use LTTng to diagnose problems</td>
</tr>
</table><hr/>
<h1 id="Limitations">Limitations</h1>
- <p>TBD</p><hr/>
+ <ul>
+ <li>When parsing text traces, the timestamps are assumed to be in the local time zone. This means that when combining it to CTF binary traces, there could be offsets by a few hours depending on where the traces were taken and where they were read.</li>
+ </ul><hr/>
<table class="navigation" style="width: 100%;" border="0" summary="navigation">
<tr>
<td style="width: 20%" align="left">
- <a href="LTTng-Kernel-Analysis.html" title="LTTng Kernel Analysis">
+ <a href="Timestamp-formatting.html" title="Timestamp formatting">
<img alt="Previous" border="0" src="images/prev.gif"/>
</a>
</td>
@@ -50,7 +52,7 @@
</td>
</tr>
<tr>
- <td style="width: 20%" align="left" valign="top">LTTng Kernel Analysis</td>
+ <td style="width: 20%" align="left" valign="top">Timestamp formatting</td>
<td style="width: 60%" align="center"></td>
<td style="width: 20%" align="right" valign="top">How to use LTTng to diagnose problems</td>
</tr>
diff --git a/lttng/org.eclipse.linuxtools.lttng.help/doc/Timestamp-formatting.html b/lttng/org.eclipse.linuxtools.lttng.help/doc/Timestamp-formatting.html
new file mode 100644
index 0000000000..18bcac827d
--- /dev/null
+++ b/lttng/org.eclipse.linuxtools.lttng.help/doc/Timestamp-formatting.html
@@ -0,0 +1,99 @@
+<?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">
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
+ <title>LTTng Plug-in User Guide - Timestamp formatting</title>
+ <link type="text/css" rel="stylesheet" href="book.css"/>
+ </head>
+ <body>
+ <table class="navigation" style="width: 100%;" border="0" summary="navigation">
+ <tr>
+ <th style="width: 100%" align="center" colspan="3">Timestamp formatting</th>
+ </tr>
+ <tr>
+ <td style="width: 20%" align="left">
+ <a href="LTTng-Kernel-Analysis.html" title="LTTng Kernel Analysis">
+ <img alt="Previous" border="0" src="images/prev.gif"/>
+ </a>
+ </td>
+ <td style="width: 60%" align="center"></td>
+ <td style="width: 20%" align="right">
+ <a href="Limitations.html" title="Limitations">
+ <img alt="Next" border="0" src="images/next.gif"/>
+ </a>
+ </td>
+ </tr>
+ <tr>
+ <td style="width: 20%" align="left" valign="top">LTTng Kernel Analysis</td>
+ <td style="width: 60%" align="center"></td>
+ <td style="width: 20%" align="right" valign="top">Limitations</td>
+ </tr>
+ </table><hr/>
+ <h1 id="Timestamp_formatting">Timestamp formatting</h1>
+ <p>Most views that show timestamps are displayed in the same time format. The unified timestamp format can be changed in the Preferences page. To get to that page, click on
+ <b>Window</b> -&gt;
+ <b>Preferences</b> -&gt;
+ <b>Tracing</b> -&gt;
+ <b>Time Format</b>. Then a window will show the time format preferences.
+ </p>
+ <p>
+ <img border="0" src="images/TmfTimestampFormatPage.png"/>
+ </p>
+ <p>The preference page has several subsections:</p>
+ <ul>
+ <li>
+ <b>Current Format</b> a format string generated by the page
+ </li>
+ <li>
+ <b>Sample Display</b> an example of a timestamp formatted with the
+ <b>Current Format</b> string.
+ </li>
+ <li>
+ <b>Data and Time format</b> how to format the date (days/months/years) and the time (hours/minutes/seconds)
+ </li>
+ <li>
+ <b>Sub-second format</b> how much precision is shown for the sub-second units
+ </li>
+ <li>
+ <b>Date delimiter</b> the character used to delimit the date units such as months and years
+ </li>
+ <li>
+ <b>Time delimiter</b> the character to separate super-second time units such as seconds and minutes
+ </li>
+ <li>
+ <b>Sub-Second Delimiter</b> the character to separate the sub-second groups such as milliseconds and nanoseconds
+ </li>
+ <li>
+ <b>Restore Defaults</b> restores the system settings
+ </li>
+ <li>
+ <b>Apply</b> apply changes
+ </li>
+ </ul>
+ <p>This will update all the displayed timestamps.</p><hr/>
+ <table class="navigation" style="width: 100%;" border="0" summary="navigation">
+ <tr>
+ <td style="width: 20%" align="left">
+ <a href="LTTng-Kernel-Analysis.html" title="LTTng Kernel Analysis">
+ <img alt="Previous" border="0" src="images/prev.gif"/>
+ </a>
+ </td>
+ <td style="width: 60%" align="center">
+ <a href="User-Guide.html" title="LTTng Plug-in User Guide">
+ <img alt="LTTng Plug-in User Guide" border="0" src="images/home.gif"/>
+ </a>
+ </td>
+ <td style="width: 20%" align="right">
+ <a href="Limitations.html" title="Limitations">
+ <img alt="Next" border="0" src="images/next.gif"/>
+ </a>
+ </td>
+ </tr>
+ <tr>
+ <td style="width: 20%" align="left" valign="top">LTTng Kernel Analysis</td>
+ <td style="width: 60%" align="center"></td>
+ <td style="width: 20%" align="right" valign="top">Limitations</td>
+ </tr>
+ </table>
+ </body>
+</html> \ No newline at end of file
diff --git a/lttng/org.eclipse.linuxtools.lttng.help/doc/User-Guide-toc.xml b/lttng/org.eclipse.linuxtools.lttng.help/doc/User-Guide-toc.xml
index f2795149f6..e37c0ef3ff 100644
--- a/lttng/org.eclipse.linuxtools.lttng.help/doc/User-Guide-toc.xml
+++ b/lttng/org.eclipse.linuxtools.lttng.help/doc/User-Guide-toc.xml
@@ -27,7 +27,7 @@
<topic href="doc/LTTng.html#Opening_a_Trace_or_Experiment" label="Opening a Trace or Experiment"></topic>
<topic href="doc/LTTng.html#Drag_and_Drop" label="Drag and Drop"></topic>
</topic>
- <topic href="doc/LTTng.html#Events_View" label="Events View">
+ <topic href="doc/LTTng.html#Events_Editor" label="Events Editor">
<topic href="doc/LTTng.html#Searching_and_Filtering" label="Searching and Filtering">
<topic href="doc/LTTng.html#Searching" label="Searching"></topic>
<topic href="doc/LTTng.html#Filtering" label="Filtering"></topic>
@@ -95,8 +95,9 @@
<topic href="doc/LTTng-Kernel-Analysis.html#Incomplete_regions_2" label="Incomplete regions"></topic>
<topic href="doc/LTTng-Kernel-Analysis.html#Toolbar_2" label="Toolbar"></topic>
</topic>
- <topic href="doc/LTTng-Kernel-Analysis.html#Events_View_2" label="Events View"></topic>
+ <topic href="doc/LTTng-Kernel-Analysis.html#LTTng_Kernel_Events_Editor" label="LTTng Kernel Events Editor"></topic>
</topic>
+ <topic href="doc/Timestamp-formatting.html" label="Timestamp formatting"></topic>
<topic href="doc/Limitations.html" label="Limitations"></topic>
<topic href="doc/How-to-use-LTTng-to-diagnose-problems.html" label="How to use LTTng to diagnose problems">
<topic href="doc/How-to-use-LTTng-to-diagnose-problems.html#Random_stutters" label="Random stutters"></topic>
diff --git a/lttng/org.eclipse.linuxtools.lttng.help/doc/User-Guide.mediawiki b/lttng/org.eclipse.linuxtools.lttng.help/doc/User-Guide.mediawiki
index 733433aa3b..e16bc09ac5 100644
--- a/lttng/org.eclipse.linuxtools.lttng.help/doc/User-Guide.mediawiki
+++ b/lttng/org.eclipse.linuxtools.lttng.help/doc/User-Guide.mediawiki
@@ -76,8 +76,6 @@ For other distributions, older Ubuntu distributions, or the latest, bleeding edg
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 [http://wiki.eclipse.org/Linux_Tools_Project/PluginInstallHelp#Installing_Updates_From_the_Linux_Tools_Update_Site link].
-The legacy (''Classic'' :-)) Eclipse LTTng (v0.x) is also available as an optional download. Refer to [http://wiki.eclipse.org/index.php/Linux_Tools_Project/LTTng/User_Guide here] for installation and verification instructions.
-
The LTTng plug-ins are structured as a stack of features/plug-ins as following:
* '''CTF''' - A CTF parser that can also be used as a standalone component
@@ -137,7 +135,7 @@ To download sample LTTng traces, go to [http://lttng.org/download]. At the botto
The '''Tracing''' perspective is part of the '''Tracing and Monitoring Framework (TMF)''' and groups the following views:
* [[#Project_View | Project View]]
-* [[#Events_View | Events View]]
+* [[#Events_Editor | Events Editor]]
* [[#Histogram_View | Histogram View]]
* [[#Statistics_View | Statistics View]]
@@ -251,7 +249,7 @@ After that the selected trace(s) are removed from the experiment. Note that the
=== Renaming a Trace or Experiment ===
-Traces and Experiment can be renamed from the '''Project Explorer''' view. To rename a trace or experiment select the relevant trace and click the right mouse button. Then select '''Rename...''' from the context sensitive menu.
+Traces and Experiment can be renamed from the '''Project Explorer''' view. To rename a trace or experiment select the relevant trace and click the right mouse button. Then select '''Rename...''' from the context sensitive menu. The trace or experiment needs to be closed in order to do this operation.
[[Image:images/RenameTraceAction.png]]
@@ -283,7 +281,7 @@ Note that the directory for all supplementary files will be copied, too. (see al
=== Deleting a Trace or Experiment ===
-To delete a trace or experiment select the relevant trace or experiment in the '''Project Explorer''' view and click the right mouse button. Then select '''Delete...''' from the context sensitive menu.
+To delete a trace or experiment select the relevant trace or experiment in the '''Project Explorer''' view and click the right mouse button. Then select '''Delete...''' from the context sensitive menu. The trace or experiment needs to be closed in order to do this operation.
[[Image:images/DeleteExperimentAction.png]]
@@ -297,11 +295,11 @@ Note that the directory for all supplementary files will be deleted, too. (see a
=== Deleting Supplementary Files ===
-Supplementary files are by definition trace specific files that accompany a trace. These file could be temporary files, persistent indexes or any other persistent data files created by the LTTng integration in Eclipse during parsing a trace. For the LTTng 2.0 trace viewer a persistent state history of the Linux Kernel is created and is stored under the name '''stateHistroy.ht'''.
+Supplementary files are by definition trace specific files that accompany a trace. These file could be temporary files, persistent indexes or any other persistent data files created by the LTTng integration in Eclipse during parsing a trace. For the LTTng 2.0 trace viewer a persistent state history of the Linux Kernel is created and is stored under the name '''stateHistory.ht'''. The statistics for all traces are stored under '''statistics.ht'''. Other state systems may appear in the same folder as more custom views are added.
All supplementary file are hidden from the user and are handled internally by the TMF. However, there is a possibility to delete the supplementary files so that there are recreated when opening a trace.
-To delete all supplementary files from a single trace, select the relevant trace in the '''Project Explorer''' view and click the right mouse button. Then select the '''Delete Supplementary Files...''' menu item from the context-sensitive menu.
+To delete all supplementary files from a single trace, first, make sure the trace is not opened, then select the relevant trace in the '''Project Explorer''' view and click the right mouse button. Then select the '''Delete Supplementary Files...''' menu item from the context-sensitive menu.
[[Image:images/DeleteSupplementaryFilesAction.png]]
@@ -309,7 +307,7 @@ A new dialog box will open with a list of supplementary files. Select the file(s
[[Image:images/DeleteSupplementaryFilesDialog.png]]
-To delete all supplementary files from all traces of a experiment, select the relevant experiment in the '''Project Explorer''' view and click the right mouse button. In the context-sensitive menu select '''Delete Supplementary Files...''' menu item.
+To delete all supplementary files from all traces of a experiment, select the relevant experiment in the '''Project Explorer''' view and click the right mouse button. In the context-sensitive menu select '''Delete Supplementary Files...''' menu item. The experiment and included traces need to be closed in order to do this operation.
A new dialog box will open with a list of supplementary files. Note that the supplementary files are prefixed with the trace name to indicate the trace they belong to. Select the file(s) to delete from the list and press '''OK'''.
@@ -331,11 +329,11 @@ Any resource can be dragged and dropped from a non-tracing project, and any file
It is also possible to drop a trace, resource, file or folder into an existing experiment. If the item does not already exist as a trace in the project's trace folder, it will first be copied or imported, then the trace will be added to the experiment.
-== Events View ==
+== Events Editor ==
-The Events view shows the basic trace data in chronological order in a tabular format.
+The Events editor shows the basic trace data elements (events) in a tabular format. The editors can be dragged in the editor area so that several traces may be shown side by side. These traces are synchronized by timestamp.
-When opened, the Events view displays the events of the currently selected trace or experiment.
+[[Image:images/LTTng2EventsEditor.png]]
The header displays the current trace (or experiment) name.
@@ -349,9 +347,11 @@ Being part of the '''Tracing and Monitoring''' Framework, the default table disp
The first row of the table is the header row a.k.a. the Search and Filter row.
-[[Image:images/DefaultEventsView.png]]
+The highlighted event is the ''current event'' and is synchronized with the other views. If you select another event, the other views will be updated accordingly. The properties view will display a more detailed view of the selected event.
+
+[[Image:images/LTTng2EventProperties.png]]
-The highlighted event is the ''current event'' and is synchronized with the other views. If you select another event, the other views will be synchronized accordingly.
+The Events editor can be closed, disposing a trace. When this is done, all the views displaying the information will be updated with the trace data of the next event editor tab. If all the editor tabs are closed, then the views will display their empty states.
=== Searching and Filtering ===
@@ -442,10 +442,12 @@ In each histogram, the following keys are handled:
== Statistics View ==
-The Statistics View displays the various event counters that are collected when analyzing a trace. The data is organized per trace. To open the Statistics View, select Windows -> Show View -> Other... -> Tracing -> Statistics. A new view will open with the name Statistics. This view shows 2 columns: ''Level'' and ''Number of Events''. After parsing a trace the view will display the number of events per event type. The cells where the number of events are printed also contain a colored bar that indicates the percentage of the event count in relation to the total number of events. The statistics is collected for the whole trace. This view is part of the '''Tracing and Monitoring Framework (TMF)''' and is generic. It will work for any trace type extensions. For the LTTng 2.0 integration the Statistics view will display statistics as shown below.:
+The Statistics View displays the various event counters that are collected when analyzing a trace. The data is organized per trace. To open the Statistics View, select Windows -> Show View -> Other... -> Tracing -> Statistics. A new view will open with the name Statistics. This view shows 3 columns: ''Level'' ''Events total'' and ''Events in selected time range''. After parsing a trace the view will display the number of events per event type in the second column and in the third, the currently selected time range's event type distribution is shown. The cells where the number of events are printed also contain a colored bar that indicates the percentage of the event count in relation to the total number of events. The statistics is collected for the whole trace. This view is part of the '''Tracing and Monitoring Framework (TMF)''' and is generic. It will work for any trace type extensions. For the LTTng 2.0 integration the Statistics view will display statistics as shown below.:
[[Image:images/LTTng2StatisticsView.png]]
+By default, the statistics use a state system, therefore will load very quickly once the state system is written to the disk as a supplementary file.
+
== Colors View ==
[[Image:images/ColorsView.png]]
@@ -506,7 +508,7 @@ The Time Chart only supports traces that are opened in an editor. The use of an
== Environment Variables View ==
A new feature of CTF traces is their ability to store user defined data that is not to be placed in an event. It is generally data that is per-trace specific, such as the tracer version and the trace domain. It will be populated when a trace is loaded if the trace has environment variables. <br>
-[[Image:images/environment_variables.png]]<br>
+[[Image:images/LTTng2EnvironmentsView.png]]<br>
The above picture shows a trace loaded that was collevcted with the '''lttng-modules''' version '''2'''.'''0'''.'''0''' tracer. It is a '''kernel''' trace of the '''3.2.0-18-generic''' '''linux''' kernel.
== Custom Parser ==
@@ -765,7 +767,7 @@ To connect to a remote host, select the host in the Control View and press the '
==== Deleting to a Remote Host Connection ====
-To delete a remote host connection, select the host in the Control View and press the '''Delete''' button. Alternatively, press the right mouse button. A context-sensitive menu will show. Select the '''Delete''' button. For that command to be active the connection state has to be '''DISCONNECTED'''.
+To delete a remote host connection, select the host in the Control View and press the '''Delete''' button. Alternatively, press the right mouse button. A context-sensitive menu will show. Select the '''Delete''' button. For that command to be active the connection state has to be '''DISCONNECTED''' and the trace has to be closed.
[[Image:images/LTTng2ControlViewDelete.png]]
@@ -1191,7 +1193,7 @@ The states flow is usable with the mouse. The following actions are set:
* '''drag the time ruler horizontally with the right button''': [[#Zoom region|zoom region]]
* '''double-click the time ruler''': reset zoom
-When the current time indicator is changed (when clicking in the states flow), all the other views are '''synchronized'''. For example, the [[#Events_View_2|Events View]] will show the event matching the current time indicator. The reverse behaviour is also implemented: selecting an event within the Events View will update the Control Flow View current time indicator.
+When the current time indicator is changed (when clicking in the states flow), all the other views are '''synchronized'''. For example, the [[#LTTng_Kernel_Events_Editor|Events Editor]] will show the event matching the current time indicator. The reverse behaviour is also implemented: selecting an event within the Events View will update the Control Flow View current time indicator.
==== Incomplete regions ====
@@ -1259,7 +1261,7 @@ Then, by selecting '''Next Event''', it will show the next state transition and
[[Image:images/RV_infobox2.png|Shows the next state of the IRQ]]
-This view is also synchronized with the others : [[#Histogram_View | histogram]], [[#Events_View_2 | events view]], [[#Control_Flow_View | control flow view]], etc.
+This view is also synchronized with the others : [[#Histogram_View | histogram]], [[#LTTng_Kernel_Events_Editor | Events editor]], [[#Control_Flow_View | control flow view]], etc.
=== Navigation ===
@@ -1273,9 +1275,9 @@ See Control Flow View's '''[[#Incomplete_regions|Incomplete regions]]'''.
See Control Flow View's '''[[#Toolbar|Toolbar]]'''.
-== Events View ==
+== LTTng Kernel Events Editor ==
-The LTTng Kernel Events View '''is''' the plain TMF [[#Events_View | Events Views]] except that it provide its own specialized viewer to replace the standard one. In short, it has exactly the same behaviour but the layout is slightly different:
+The LTTng Kernel Events editor '''is''' the plain TMF [[#Events_Editor | Events Editor]], except that it provides its own specialized viewer to replace the standard one. In short, it has exactly the same behaviour but the layout is slightly different:
* '''Timestamp''': the event timestamp
* '''Channel''': the event channel (data collector)
@@ -1283,11 +1285,31 @@ The LTTng Kernel Events View '''is''' the plain TMF [[#Events_View | Events View
* '''Content''': the raw event content
-[[Image:images/LTTngKernelEventsViewer.png]]
+[[Image:images/LTTng2EventsEditor.png]]
+
+= Timestamp formatting =
+
+Most views that show timestamps are displayed in the same time format. The unified timestamp format can be changed in the Preferences page. To get to that page, click on '''Window''' -> '''Preferences''' -> '''Tracing''' -> '''Time Format'''. Then a window will show the time format preferences.
+
+[[Image:images/TmfTimestampFormatPage.png]]
+
+The preference page has several subsections:
+
+* '''Current Format''' a format string generated by the page
+* '''Sample Display''' an example of a timestamp formatted with the '''Current Format''' string.
+* '''Data and Time format''' how to format the date (days/months/years) and the time (hours/minutes/seconds)
+* '''Sub-second format''' how much precision is shown for the sub-second units
+* '''Date delimiter''' the character used to delimit the date units such as months and years
+* '''Time delimiter''' the character to separate super-second time units such as seconds and minutes
+* '''Sub-Second Delimiter''' the character to separate the sub-second groups such as milliseconds and nanoseconds
+* '''Restore Defaults''' restores the system settings
+* '''Apply''' apply changes
+
+This will update all the displayed timestamps.
= Limitations =
-TBD
+* When parsing text traces, the timestamps are assumed to be in the local time zone. This means that when combining it to CTF binary traces, there could be offsets by a few hours depending on where the traces were taken and where they were read.
= How to use LTTng to diagnose problems =
diff --git a/lttng/org.eclipse.linuxtools.lttng.help/doc/images/HistogramView.png b/lttng/org.eclipse.linuxtools.lttng.help/doc/images/HistogramView.png
index 2bd2ef1955..99410856dc 100644
--- a/lttng/org.eclipse.linuxtools.lttng.help/doc/images/HistogramView.png
+++ b/lttng/org.eclipse.linuxtools.lttng.help/doc/images/HistogramView.png
Binary files differ
diff --git a/lttng/org.eclipse.linuxtools.lttng.help/doc/images/LTTng2EnvironmentsView.png b/lttng/org.eclipse.linuxtools.lttng.help/doc/images/LTTng2EnvironmentsView.png
new file mode 100644
index 0000000000..b303d274d5
--- /dev/null
+++ b/lttng/org.eclipse.linuxtools.lttng.help/doc/images/LTTng2EnvironmentsView.png
Binary files differ
diff --git a/lttng/org.eclipse.linuxtools.lttng.help/doc/images/LTTng2EventProperties.png b/lttng/org.eclipse.linuxtools.lttng.help/doc/images/LTTng2EventProperties.png
new file mode 100644
index 0000000000..b5c8e2947b
--- /dev/null
+++ b/lttng/org.eclipse.linuxtools.lttng.help/doc/images/LTTng2EventProperties.png
Binary files differ
diff --git a/lttng/org.eclipse.linuxtools.lttng.help/doc/images/LTTng2EventsEditor.png b/lttng/org.eclipse.linuxtools.lttng.help/doc/images/LTTng2EventsEditor.png
new file mode 100644
index 0000000000..e0d662da4f
--- /dev/null
+++ b/lttng/org.eclipse.linuxtools.lttng.help/doc/images/LTTng2EventsEditor.png
Binary files differ
diff --git a/lttng/org.eclipse.linuxtools.lttng.help/doc/images/LTTng2StatisticsView.png b/lttng/org.eclipse.linuxtools.lttng.help/doc/images/LTTng2StatisticsView.png
index 561da067b3..c910cade4e 100644
--- a/lttng/org.eclipse.linuxtools.lttng.help/doc/images/LTTng2StatisticsView.png
+++ b/lttng/org.eclipse.linuxtools.lttng.help/doc/images/LTTng2StatisticsView.png
Binary files differ
diff --git a/lttng/org.eclipse.linuxtools.lttng.help/doc/images/LTTngKernelPerspective.png b/lttng/org.eclipse.linuxtools.lttng.help/doc/images/LTTngKernelPerspective.png
index e7b363f22c..f41eb2c2a1 100644
--- a/lttng/org.eclipse.linuxtools.lttng.help/doc/images/LTTngKernelPerspective.png
+++ b/lttng/org.eclipse.linuxtools.lttng.help/doc/images/LTTngKernelPerspective.png
Binary files differ
diff --git a/lttng/org.eclipse.linuxtools.lttng.help/doc/images/TmfTimestampFormatPage.png b/lttng/org.eclipse.linuxtools.lttng.help/doc/images/TmfTimestampFormatPage.png
new file mode 100644
index 0000000000..151901a704
--- /dev/null
+++ b/lttng/org.eclipse.linuxtools.lttng.help/doc/images/TmfTimestampFormatPage.png
Binary files differ
diff --git a/lttng/org.eclipse.linuxtools.lttng.help/toc.xml b/lttng/org.eclipse.linuxtools.lttng.help/toc.xml
index 15f6302a79..32a50b82ab 100644
--- a/lttng/org.eclipse.linuxtools.lttng.help/toc.xml
+++ b/lttng/org.eclipse.linuxtools.lttng.help/toc.xml
@@ -28,7 +28,7 @@
<topic href="Linux_Tools_Project/LTTng2/User_Guide/LTTng.html#Opening_a_Trace_or_Experiment" label="Opening a Trace or Experiment"></topic>
<topic href="Linux_Tools_Project/LTTng2/User_Guide/LTTng.html#Drag_and_Drop" label="Drag and Drop"></topic>
</topic>
- <topic href="Linux_Tools_Project/LTTng2/User_Guide/LTTng.html#Events_View" label="Events View">
+ <topic href="Linux_Tools_Project/LTTng2/User_Guide/LTTng.html#Events_Editor" label="Events Editor">
<topic href="Linux_Tools_Project/LTTng2/User_Guide/LTTng.html#Searching_and_Filtering" label="Searching and Filtering">
<topic href="Linux_Tools_Project/LTTng2/User_Guide/LTTng.html#Searching" label="Searching"></topic>
<topic href="Linux_Tools_Project/LTTng2/User_Guide/LTTng.html#Filtering" label="Filtering"></topic>
@@ -96,7 +96,7 @@
<topic href="Linux_Tools_Project/LTTng2/User_Guide/LTTng-Kernel-Analysis.html#Incomplete_regions_2" label="Incomplete regions"></topic>
<topic href="Linux_Tools_Project/LTTng2/User_Guide/LTTng-Kernel-Analysis.html#Toolbar_2" label="Toolbar"></topic>
</topic>
- <topic href="Linux_Tools_Project/LTTng2/User_Guide/LTTng-Kernel-Analysis.html#Events_View_2" label="Events View"></topic>
+ <topic href="Linux_Tools_Project/LTTng2/User_Guide/LTTng-Kernel-Analysis.html#Events_Editor_2" label="Events Editor"></topic>
</topic>
<topic href="Linux_Tools_Project/LTTng2/User_Guide/Limitations.html" label="Limitations"></topic>
<topic href="Linux_Tools_Project/LTTng2/User_Guide/How-to-use-LTTng-to-diagnose-problems.html" label="How to use LTTng to diagnose problems">
@@ -106,4 +106,4 @@
<topic href="Linux_Tools_Project/LTTng2/User_Guide/References.html" label="References"></topic>
<topic href="Linux_Tools_Project/LTTng2/User_Guide/Updating-This-Document.html" label="Updating This Document"></topic>
</topic>
-</toc> \ No newline at end of file
+</toc>

Back to the top