Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBernd Hufmann2014-05-28 14:46:53 -0400
committerBernd Hufmann2014-05-29 17:32:51 -0400
commitbd949490a82fc68f43caff9504e4150483dba2d6 (patch)
treefb83b21abc8a5079d589e63d1b08fde6d26fd216
parent0d8ba5a29e4a80cd005e33003c9d37a24fee3c43 (diff)
downloadorg.eclipse.linuxtools-bd949490a82fc68f43caff9504e4150483dba2d6.tar.gz
org.eclipse.linuxtools-bd949490a82fc68f43caff9504e4150483dba2d6.tar.xz
org.eclipse.linuxtools-bd949490a82fc68f43caff9504e4150483dba2d6.zip
lttng-guide: Update LTTng Kernel Analysis section
Update existing sections (e.g. Control Flow view) and add new section for CPU Usage analysis and view. Change-Id: Iee748e2c9837a101760a9b5531a9c0800273378a Signed-off-by: Bernd Hufmann <Bernd.Hufmann@ericsson.com> Reviewed-on: https://git.eclipse.org/r/27492 Reviewed-by: Marc-Andre Laperle <marc-andre.laperle@ericsson.com> Tested-by: Marc-Andre Laperle <marc-andre.laperle@ericsson.com> Tested-by: Hudson CI
-rw-r--r--lttng/org.eclipse.linuxtools.lttng.help/doc/User-Guide.mediawiki53
-rw-r--r--lttng/org.eclipse.linuxtools.lttng.help/doc/images/Cfv_show_view.pngbin28960 -> 17625 bytes
-rw-r--r--lttng/org.eclipse.linuxtools.lttng.help/doc/images/Cfv_zoom_region.pngbin4975 -> 4238 bytes
-rw-r--r--lttng/org.eclipse.linuxtools.lttng.help/doc/images/LTTng_CpuUsageView.pngbin0 -> 126265 bytes
-rw-r--r--lttng/org.eclipse.linuxtools.lttng.help/doc/images/LTTng_CpuUsageViewToolTip.pngbin0 -> 49413 bytes
-rw-r--r--lttng/org.eclipse.linuxtools.lttng.help/doc/images/LTTng_OpenCpuUsageView.pngbin0 -> 16171 bytes
6 files changed, 51 insertions, 2 deletions
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 c783d0676e..125d3c6b15 100644
--- a/lttng/org.eclipse.linuxtools.lttng.help/doc/User-Guide.mediawiki
+++ b/lttng/org.eclipse.linuxtools.lttng.help/doc/User-Guide.mediawiki
@@ -1486,6 +1486,7 @@ The '''LTTng Kernel''' perspective is built upon the [[#Tracing_Perspective | Tr
* [[#Control_Flow_View | Control Flow View]] - to visualize processes state transitions
* [[#Resources_View | Resources View]] - to visualize system resources state transitions
+* [[#LTTng_Tracer_Control | LTTng Tracer Control]] - to configure LTTng tracing sessions remotely
[[Image:images/LTTngKernelPerspective.png]]
@@ -1498,10 +1499,12 @@ The perspective can be opened from the Eclipse Open Perspective dialog ('''Windo
== Control Flow View ==
-The '''''Control Flow''''' view is a LTTng-specific view that shows per-process events graphically. To enable it, select ''Control Flow'' under ''LTTng'' within the ''Show View'' window ('''Window''' -> '''Show View''' -> '''Other...'''):
+The '''''Control Flow''''' view is a LTTng-specific view that shows per-process events graphically. The LTTng Kernel analysis is executed the first time a LTTng Kernel is opened. After opening the trace, the element '''Control Flow''' is added under the '''LTTng Kernel Analysis''' tree element in the Project Explorer. To open the view, double-click the '''Control Flow''' tree element.
[[Image:images/Cfv_show_view.png]]
+Alternatively, select ''Control Flow'' under ''LTTng'' within the ''Show View'' window ('''Window''' -> '''Show View''' -> '''Other...'''):
+
You should get something like this:
[[Image:images/Cfv_global.png]]
@@ -1647,7 +1650,9 @@ The Control Flow View '''toolbar''', located at the top right of the view, has s
== Resources View ==
-This view is specific to kernel trace. To open it, go in '''Window''' -> '''Show View''' -> '''Other...''' and select '''LTTng/Resources''' in the list.
+This view is specific to LTTng kernel traces. The LTTng Kernel analysis is executed the first time a LTTng Kernel is opened. After opening the trace, the element '''Resources''' is added under the '''LTTng Kernel Analysis''' tree element of the Project Explorer. To open the view, double-click the '''Resources''' tree element.
+
+Alternatively, go in '''Window''' -> '''Show View''' -> '''Other...''' and select '''LTTng/Resources''' in the list.
[[Image:images/Rv_example.png| Example of resources view with all trace points and syscalls enabled]]
@@ -1716,6 +1721,50 @@ The Resources View '''toolbar''', located at the top right of the view, has shor
| Zooms out on the selection by 50%
|}
+== LTTng CPU Usage View ==
+
+The CPU Usage analysis and view is specific to LTTng Kernel traces. The CPU usage is derived from a kernel trace as long as the '''sched_switch''' event was enabled during the collection of the trace. This analysis is executed the first time that the CPU Usage view is opened after opening the trace. To open the view, double-click on the '''CPU Usage''' tree element under the '''LTTng Kernel Analysis''' tree element of the Project Explorer.
+
+[[Image:images/LTTng_OpenCpuUsageView.png]]
+
+Now, the CPU Usage view will show:
+
+[[Image:images/LTTng_CpuUsageView.png]]
+
+The view is divided into the following important sections: '''Process Information''' and the '''CPU Usage Chart'''.
+
+
+=== 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.
+
+
+=== CPU Usage Chart ===
+
+The CPU Usage Chart on the right side of the view, plots the total time spent on all CPUs of all processes and the time of the selected process.
+
+
+==== Using the mouse ====
+
+The CPU Usage chart is usable with the mouse. The following actions are set:
+
+* '''left-click''': select a time or time range begin time
+* '''Shift-left-click''': select a time range end 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/LTTng_CpuUsageViewToolTip.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/lttng/org.eclipse.linuxtools.lttng.help/doc/images/Cfv_show_view.png b/lttng/org.eclipse.linuxtools.lttng.help/doc/images/Cfv_show_view.png
index d0fb74dd92..1ddb600a33 100644
--- a/lttng/org.eclipse.linuxtools.lttng.help/doc/images/Cfv_show_view.png
+++ b/lttng/org.eclipse.linuxtools.lttng.help/doc/images/Cfv_show_view.png
Binary files differ
diff --git a/lttng/org.eclipse.linuxtools.lttng.help/doc/images/Cfv_zoom_region.png b/lttng/org.eclipse.linuxtools.lttng.help/doc/images/Cfv_zoom_region.png
index ae64febdf7..f02bfdf347 100644
--- a/lttng/org.eclipse.linuxtools.lttng.help/doc/images/Cfv_zoom_region.png
+++ b/lttng/org.eclipse.linuxtools.lttng.help/doc/images/Cfv_zoom_region.png
Binary files differ
diff --git a/lttng/org.eclipse.linuxtools.lttng.help/doc/images/LTTng_CpuUsageView.png b/lttng/org.eclipse.linuxtools.lttng.help/doc/images/LTTng_CpuUsageView.png
new file mode 100644
index 0000000000..747ab8e255
--- /dev/null
+++ b/lttng/org.eclipse.linuxtools.lttng.help/doc/images/LTTng_CpuUsageView.png
Binary files differ
diff --git a/lttng/org.eclipse.linuxtools.lttng.help/doc/images/LTTng_CpuUsageViewToolTip.png b/lttng/org.eclipse.linuxtools.lttng.help/doc/images/LTTng_CpuUsageViewToolTip.png
new file mode 100644
index 0000000000..b09e7c002d
--- /dev/null
+++ b/lttng/org.eclipse.linuxtools.lttng.help/doc/images/LTTng_CpuUsageViewToolTip.png
Binary files differ
diff --git a/lttng/org.eclipse.linuxtools.lttng.help/doc/images/LTTng_OpenCpuUsageView.png b/lttng/org.eclipse.linuxtools.lttng.help/doc/images/LTTng_OpenCpuUsageView.png
new file mode 100644
index 0000000000..f111f6050e
--- /dev/null
+++ b/lttng/org.eclipse.linuxtools.lttng.help/doc/images/LTTng_OpenCpuUsageView.png
Binary files differ

Back to the top