doc: add and update documentation for latency views

This includes function density view, syscall views and latency views

Change-Id: Ie9207501e0c04681ef6be01cf29839362aaea35a
Signed-off-by: Bernd Hufmann <Bernd.Hufmann@ericsson.com>
Reviewed-on: https://git.eclipse.org/r/80326
Reviewed-by: Matthew Khouzam <matthew.khouzam@ericsson.com>
Tested-by: Matthew Khouzam <matthew.khouzam@ericsson.com>
Reviewed-by: Hudson CI

diff --git a/doc/org.eclipse.tracecompass.doc.dev/doc/images/zoomout_nav.gif b/doc/org.eclipse.tracecompass.doc.dev/doc/images/zoomout_nav.gif
new file mode 100644 (file)
index 0000000..1f87400
Binary files /dev/null and b/doc/org.eclipse.tracecompass.doc.dev/doc/images/zoomout_nav.gif differ

diff --git a/doc/org.eclipse.tracecompass.doc.user/doc/User-Guide.mediawiki b/doc/org.eclipse.tracecompass.doc.user/doc/User-Guide.mediawiki
index 6b0176dae13440d28832649e135c4620e19084f0..7eef7a54869046d71cff0baa3e63b94427e64c28 100644 (file)
--- a/doc/org.eclipse.tracecompass.doc.user/doc/User-Guide.mediawiki
+++ b/doc/org.eclipse.tracecompass.doc.user/doc/User-Guide.mediawiki
@@ -70,7 +70,7 @@ Also, the LTTng plug-ins supports the following User Space traces views:
 
 * ''Memory Usage'' - to visualize the memory usage per thread with respect to time in the traces
 * ''Call Stack'' - to visualize the call stack's evolution over time
-* ''Function Density'' - to visualize function calls displayed by duration
+* ''Function Duration Density'' - to visualize function calls displayed by duration
 * ''Flame Graph'' - to visualize why the CPU is busy
 
 Finally, the LTTng plug-ins supports the following Control views:
@@ -2357,6 +2357,10 @@ A time aligned XY chart of the read and write speed for the different disks on t
 
  [[Image:images/io/diskIoActivity.png| Disk I/O Activity Example]]
 
+== System Call Latency Analysis ==
+
+The '''System Call Latency Analysis''' measures the system call latency between system call entry and exit per type of system call. The durations are visualized using the '''Latency''' views. For more information about the '''Latency''' views see chapter [[#Latency_Analyses | Latency Analyses]].
+
 == LTTng Kernel Events Editor ==
 
 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:
@@ -2551,6 +2555,13 @@ The following keyboard shortcuts are available:
 
 See Call Stack View's '''[[#Call Stack View | Importing a binary or function name mapping file (for LTTng-UST <2.8 traces) ]]'''.
 
+== Function Duration Density ==
+The '''Function Duration Density''' view shows the function duration of function displayed by duration for the current active time window range. This is useful to find global outliers.
+
+[[Image:images/FunctionDensityView.png|Function Duration Density View]]
+
+Using the right mouse button to drag horizontally it will update the table and graph to show only the density for the selected durations. Durations outside the selection range will be filtered out. Using the toolbar button [[Image:images/zoomout_nav.gif]] the zoom range will be reset.
+
 == Memory Usage ==
 
 The Memory Usage view allows the user to visualize the active memory usage per thread over time, if the application and trace provide this information.
@@ -3539,12 +3550,13 @@ Right-clicking on an entry of the table and select '''Go to maximum''' allows to
 
 [[Image:images/LatenciesStatistics.png| Latency Statistics example - System Call Latency Statistics]]
 
-
 * System Call Density
-A '''density''' view, analyzing the current time range. This is useful to find global outliers.
+A '''density''' view, analyzing the current time range. This is useful to find global outliers. Selecting a duration in the table it will synchronize other views to this time range.
 
 [[Image:images/LatenciesDensity.png| Latency Densities example - System Call Density]]
 
+Using the right mouse button to drag horizontally it will update the table and graph to show only the density for the selected durations. Durations outside the selection range will be filtered out. Using the toolbar button [[Image:images/zoomout_nav.gif]] the zoom range will be reset. 
+
 = Virtual Machine Analysis =
 
 Virtual environments are usually composed of host machines, who each run an hypervisor program on which one or many guests can be run. Tracing a guest machine alone can often yield some strange results as from its point of view, it has full use of the resources, but in reality, most resources are shared with the host and other guests.

diff --git a/doc/org.eclipse.tracecompass.doc.user/doc/images/FunctionDensityView.png b/doc/org.eclipse.tracecompass.doc.user/doc/images/FunctionDensityView.png
new file mode 100644 (file)
index 0000000..f4fc25e
Binary files /dev/null and b/doc/org.eclipse.tracecompass.doc.user/doc/images/FunctionDensityView.png differ