documentation: Add documentation for Latency views
authorMatthew Khouzam <matthew.khouzam@ericsson.com>
Mon, 18 Jan 2016 22:49:31 +0000 (17:49 -0500)
committerMatthew Khouzam <matthew.khouzam@ericsson.com>
Fri, 22 Jan 2016 15:43:24 +0000 (10:43 -0500)
Change-Id: If3c4366e4e2f0c8aa876833ae85467a98e71ca3a
Signed-off-by: Matthew Khouzam <matthew.khouzam@ericsson.com>
Reviewed-on: https://git.eclipse.org/r/64610
Reviewed-by: Hudson CI
Reviewed-by: Patrick Tasse <patrick.tasse@gmail.com>
Tested-by: Patrick Tasse <patrick.tasse@gmail.com>
doc/org.eclipse.tracecompass.doc.user/doc/User-Guide.mediawiki
doc/org.eclipse.tracecompass.doc.user/doc/images/LatenciesDensity.png [new file with mode: 0644]
doc/org.eclipse.tracecompass.doc.user/doc/images/LatenciesScatter.png [new file with mode: 0644]
doc/org.eclipse.tracecompass.doc.user/doc/images/LatenciesStatistics.png [new file with mode: 0644]
doc/org.eclipse.tracecompass.doc.user/doc/images/LatenciesTable.png [new file with mode: 0644]

index a24b55d3fc769896f66fadf95721e15741334dcf..9e845ea4ebf26556fd197a24914630fb32449d86 100644 (file)
@@ -2586,6 +2586,34 @@ The following screenshot shows the result of the preceding example on a LTTng Ke
 
 [[Image:images/XML_xy_chart.png| XML XY chart]]
 
+= Latency Analyses =
+
+Trace Compass offers a feature called Latency analysis. This allows an analysis to return intervals and these intervals will be displayed in four different views. An example analysis is provided with kernel system call latencies being provided. The available views are: 
+
+* System Call Latencies 
+A '''table''' of the raw latencies. This view is useful to inspect individual latencies.
+
+ [[Image:images/LatenciesTable.png| Latency Table example - System Call Latencies]]
+
+
+* System Call Latency vs Time
+A time aligned '''scatter chart''' of the latencies with respect to the current window range. This view is useful to see the overall form of the latencies as they arrive. 
+
+[[Image:images/LatenciesScatter.png| Latency Scatter Chart example - System Call Latency vs Time]]
+
+
+* System Call Latency Statistics
+A view of the total '''statistics''' of the latencies. These show the ''minimum'', ''maximum'', ''average'' and ''standard deviation'' of the latencies when applicable. This tool is useful for finding the outliers on a per-category basis. 
+
+[[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.
+
+[[Image:images/LatenciesDensity.png| Latency Densities example - System Call Density]]
+
+
 = Limitations =
 
 * 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.
diff --git a/doc/org.eclipse.tracecompass.doc.user/doc/images/LatenciesDensity.png b/doc/org.eclipse.tracecompass.doc.user/doc/images/LatenciesDensity.png
new file mode 100644 (file)
index 0000000..4c7615d
Binary files /dev/null and b/doc/org.eclipse.tracecompass.doc.user/doc/images/LatenciesDensity.png differ
diff --git a/doc/org.eclipse.tracecompass.doc.user/doc/images/LatenciesScatter.png b/doc/org.eclipse.tracecompass.doc.user/doc/images/LatenciesScatter.png
new file mode 100644 (file)
index 0000000..df1ec0d
Binary files /dev/null and b/doc/org.eclipse.tracecompass.doc.user/doc/images/LatenciesScatter.png differ
diff --git a/doc/org.eclipse.tracecompass.doc.user/doc/images/LatenciesStatistics.png b/doc/org.eclipse.tracecompass.doc.user/doc/images/LatenciesStatistics.png
new file mode 100644 (file)
index 0000000..969434f
Binary files /dev/null and b/doc/org.eclipse.tracecompass.doc.user/doc/images/LatenciesStatistics.png differ
diff --git a/doc/org.eclipse.tracecompass.doc.user/doc/images/LatenciesTable.png b/doc/org.eclipse.tracecompass.doc.user/doc/images/LatenciesTable.png
new file mode 100644 (file)
index 0000000..38610f0
Binary files /dev/null and b/doc/org.eclipse.tracecompass.doc.user/doc/images/LatenciesTable.png differ
This page took 0.030587 seconds and 5 git commands to generate.