common: Add documentation to the view KernelMemoryUsage
authorJulien Daoust <julien_daoust@hotmail.com>
Wed, 16 Mar 2016 19:15:15 +0000 (15:15 -0400)
committerGenevieve Bastien <gbastien+lttng@versatic.net>
Fri, 1 Apr 2016 21:53:27 +0000 (17:53 -0400)
I add the description and the functionalities of the new
kernel Memory Usage view.

Change-Id: I457372fd1d99c262ca35d768f83e2d53b130c4cb
Signed-off-by: Julien Daoust <julien_daoust@hotmail.com>
Reviewed-on: https://git.eclipse.org/r/69335
Reviewed-by: Genevieve Bastien <gbastien+lttng@versatic.net>
Tested-by: Genevieve Bastien <gbastien+lttng@versatic.net>
Reviewed-by: Matthew Khouzam <matthew.khouzam@ericsson.com>
Reviewed-by: Hudson CI
doc/org.eclipse.tracecompass.doc.user/doc/User-Guide.mediawiki
doc/org.eclipse.tracecompass.doc.user/doc/images/kernelMemoryUsage/KernelMemoryUsageChart.png [new file with mode: 0644]
doc/org.eclipse.tracecompass.doc.user/doc/images/kernelMemoryUsage/KernelMemoryUsageView.png [new file with mode: 0644]
doc/org.eclipse.tracecompass.doc.user/doc/images/kernelMemoryUsage/OpenKernelMemoryUsageView.png [new file with mode: 0644]

index 83b02e3bb0297b7f427b4b69d1453fc8fb9f0424..4f71c0f03c30e3e758d35efa375caf18a293798d 100644 (file)
@@ -1961,6 +1961,7 @@ The view is divided into the following important sections: '''Process Informatio
 
 
 === Process Information ===
+
 The Process Information is displayed on the left side of the view and shows all threads that were executing on all available CPUs in the current time range. For each process, it shows in different columns the thread ID (TID), process name (Process), the average (%) execution time and the actual execution time (Time) during the current time range. It shows all threads that were executing on the CPUs in the current time range.
 
 
@@ -2000,6 +2001,54 @@ The CPU Usage View '''toolbar''', located at the top right of the view, has shor
 
 [[Image:images/LTTng_CpuUsageViewToolTip.png]]
 
+
+== Kernel Memory Usage ==
+
+The Kernel Memory Usage and view is specific to kernel traces. To open the view, double-click on the '''Kernel Memory Usage Analysis''' tree element under the '''Kernel''' tree element of the Project Explorer.
+
+[[Image:images/kernelMemoryUsage/OpenKernelMemoryUsageView.png]]
+
+Now, the Kernel memory usage view will show:
+
+[[Image:images/kernelMemoryUsage/KernelMemoryUsageView.png]]
+
+Where:
+
+* '''TID''': The ID of the thread this event belongs to
+* '''Process''': The process of the TID that belongs to it
+
+The view is divided into the following important sections: '''Process Information''' and the '''Relative Kernel Memory Usage'''. The time axis is aligned with other views that support automatic time axis alignment (see [[#Automatic Time Axis Alignment | Automatic Time Axis Alignment]]).
+
+
+=== Process Information ===
+
+The Process Information is displayed on the left side of the view and shows all threads that were executing on all available CPUs in the current time range. For each process, it shows in different columns the thread ID (TID) and the process name (Process).
+
+
+=== Relative Kernel Memory Chart ===
+
+The Relative Kernel Memory Chart on the right side of the view, plots the relative amount of memory that was allocated and deallocated during that period of time.
+
+
+==== Using the mouse ====
+
+The Relative Kernel Memory chart is usable with the mouse. The following actions are set:
+
+* '''left-click''': select a time or time range begin time
+* '''left-drag horizontally''': select a time range or change the time range begin or end time
+* '''middle-drag''': pan left or right
+* '''right-drag horizontally''': zoom region
+* '''mouse wheel up/down''': zoom in or out
+
+
+==== Tooltips ====
+
+Hover the cursor over a line of the chart and a tooltip will pop up with the following information:
+* '''time''': current time of mouse position
+* '''Total''': The total CPU usage
+
+[[Image:images/kernelMemoryUsage/KernelMemoryUsageChart.png]]
+
 == 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:
diff --git a/doc/org.eclipse.tracecompass.doc.user/doc/images/kernelMemoryUsage/KernelMemoryUsageChart.png b/doc/org.eclipse.tracecompass.doc.user/doc/images/kernelMemoryUsage/KernelMemoryUsageChart.png
new file mode 100644 (file)
index 0000000..690843d
Binary files /dev/null and b/doc/org.eclipse.tracecompass.doc.user/doc/images/kernelMemoryUsage/KernelMemoryUsageChart.png differ
diff --git a/doc/org.eclipse.tracecompass.doc.user/doc/images/kernelMemoryUsage/KernelMemoryUsageView.png b/doc/org.eclipse.tracecompass.doc.user/doc/images/kernelMemoryUsage/KernelMemoryUsageView.png
new file mode 100644 (file)
index 0000000..be7467f
Binary files /dev/null and b/doc/org.eclipse.tracecompass.doc.user/doc/images/kernelMemoryUsage/KernelMemoryUsageView.png differ
diff --git a/doc/org.eclipse.tracecompass.doc.user/doc/images/kernelMemoryUsage/OpenKernelMemoryUsageView.png b/doc/org.eclipse.tracecompass.doc.user/doc/images/kernelMemoryUsage/OpenKernelMemoryUsageView.png
new file mode 100644 (file)
index 0000000..59b04bf
Binary files /dev/null and b/doc/org.eclipse.tracecompass.doc.user/doc/images/kernelMemoryUsage/OpenKernelMemoryUsageView.png differ
This page took 0.02842 seconds and 5 git commands to generate.