WSUG: Update the Statistics chapter to match current Qt UI

Hide the Compare option, reorder the chapters to match the current Qt
order and move the Wireless menu to a new chapter.

Change-Id: I7f0eeb45f4894f66a9c91d62d7d43db775f469e5
Reviewed-on: https://code.wireshark.org/review/28761
Reviewed-by: Gerald Combs <gerald@wireshark.org>
This commit is contained in:
Moshe Kaplan 2018-07-18 22:17:45 -04:00 committed by Gerald Combs
parent 4cb8a90ef2
commit 381ea0973f
5 changed files with 101 additions and 50 deletions

View File

@ -21,6 +21,7 @@ include::wsug_src/WSUG_chapter_work.asciidoc[]
include::wsug_src/WSUG_chapter_advanced.asciidoc[]
include::wsug_src/WSUG_chapter_statistics.asciidoc[]
include::wsug_src/WSUG_chapter_telephony.asciidoc[]
include::wsug_src/WSUG_chapter_wireless.asciidoc[]
include::wsug_src/WSUG_chapter_customize.asciidoc[]
include::wsug_src/WSUG_chapter_mate.asciidoc[]
// Needs to be reworked

Binary file not shown.

After

Width:  |  Height:  |  Size: 32 KiB

View File

@ -17,7 +17,7 @@ These statistics range from general information about the loaded capture file
* General statistics:
- *Summary* about the capture file.
- *Capture File Properties* about the capture file.
- *Protocol Hierarchy* of the captured packets.
@ -42,11 +42,11 @@ be pretty hard to understand.
[[ChStatSummary]]
=== The “Summary” Window
=== The “Capture File Properties” Window
General statistics about the current capture file.
.The “Summary” window
.The “Capture File Properties” window
image::wsug_graphics/ws-stats-summary.png[{screenshot-attrs}]
* __File__: general information about the capture file.
@ -58,15 +58,15 @@ image::wsug_graphics/ws-stats-summary.png[{screenshot-attrs}]
available if the packet data was captured from the network and not loaded from
a file).
* __Display__: some display related information.
* __Interface__: information about the capture interface.
* __Traffic__: some statistics of the network traffic seen. If a display filter
is set, you will see values in the Captured column, and if any packages are
marked, you will see values in the Marked column. The values in the _Captured_
column will remain the same as before, while the values in the _Displayed_
column will reflect the values corresponding to the packets shown in the
display. The values in the _Marked_ column will reflect the values
corresponding to the marked packages.
* __Statistics__: some statistics of the network traffic seen. If a display
filter is set, you will see values in the Captured column, and if any
packages are marked, you will see values in the Marked column. The values
in the _Captured_ column will remain the same as before, while the values
in the _Displayed_ column will reflect the values corresponding to the
packets shown in the display. The values in the _Marked_ column will
reflect the values corresponding to the marked packages.
[[ChStatHierarchy]]
@ -381,6 +381,8 @@ Each row corresponds to a method of the interface selected (so the EPM interface
in version 3 has 7 methods). For each method the number of calls, and the
statistics of the SRT time is calculated.
////
// COMMENTED OUT, not yet implemented in QT UI
[[ChStatCompareCaptureFiles]]
=== Compare Two Capture Files
@ -426,6 +428,40 @@ The color filtering differentiate the two files from each other. A
If you click on an item in the error list its corresponding packet will be
selected in the main window.
====
////
[[ChStatHTTP]]
=== HTTP Statistics
[[ChStatHTTPPacketCounter]]
==== HTTP Packet Counter
Statistics for HTTP request types and response codes.
[[ChStatHTTPRequests]]
==== HTTP Requests
HTTP statistics based on the host and URI.
[[ChStatHTTPLoadDistribution]]
==== HTTP Load Distribution
HTTP request and response statistics based on the server address and host.
[[ChStatHTTPRequestSequences]]
==== HTTP Request Sequences
HTTP Request Sequences uses HTTP's Referer and Location headers to sequence a
capture's HTTP requests as a tree. This enables analysts to see how one HTTP
request leads to the next.
.The “HTTP Request Sequences” window
image::wsug_graphics/ws-stats-http-requestsequences.png[{screenshot-attrs}]
[[ChStatTCPStreamGraphs]]
@ -450,37 +486,6 @@ segment.
_Window Scaling_:: Window size and outstanding bytes.
[[ChStatWLANTraffic]]
=== WLAN Traffic Statistics
Statistics about captured WLAN traffic. This can be found under the
menu:Wireless[] menu and summarizes the wireless network traffic found
in the capture. Probe requests will be merged into an existing network
if the SSID matches.
.The “WLAN Traffic Statistics” window
image::wsug_graphics/ws-stats-wlan-traffic.png[{screenshot-attrs}]
Each row in the list shows the statistical values for exactly one wireless
network.
_Name resolution_ will be done if selected in the window and if it is active for
the MAC layer.
_Only show existing networks_ will exclude probe requests with a SSID not
matching any network from the list.
The btn:[Copy] button will copy the list values to the clipboard in CSV (Comma
Separated Values) format.
[TIP]
====
This window will be updated frequently, so it will be useful, even if you open
it before (or while) you are doing a live capture.
====
[[ChStatOtherProtocols]]
=== Other Protocol-specific Statistics Windows

View File

@ -552,27 +552,27 @@ All menu items will bring up a new window showing specific statistical informati
[options="header",cols="3,2,5"]
|===============
|Menu Item|Accelerator|Description
|menu:Summary[]|| Show information about the data captured, see <<ChStatSummary>>.
|menu:Capture File Properties[]|| Show information about the capture file, see <<ChStatSummary>>.
|menu:Protocol Hierarchy[]|| Display a hierarchical tree of protocol statistics, see <<ChStatHierarchy>>.
|menu:Conversations[]|| Display a list of conversations (traffic between two endpoints), see <<ChStatConversationsWindow>>.
|menu:Endpoints[]|| Display a list of endpoints (traffic to/from an address), see <<ChStatEndpointsWindow>>.
|menu:Packet Lengths...[]||See <<ChStatOtherProtocols>>
|menu:IO Graphs[]|| Display user specified graphs (e.g. the number of packets in the course of time), see <<ChStatIOGraphs>>.
|menu:Service Response Time[]|| Display the time between a request and the corresponding response, see <<ChStatSRT>>.
|menu:ONC-RPC Programs[]||See <<ChStatOtherProtocols>>
|menu:DHCP (BOOTP)[]||See <<ChStatOtherProtocols>>
|menu:ANCP[]||See <<ChStatOtherProtocols>>
|menu:Colledtd...[]||See <<ChStatOtherProtocols>>
|menu:Compare...[]||See <<ChStatOtherProtocols>>
//|menu:Compare...[]||See <<ChStatOtherProtocols>>
|menu:Flow Graph...[]||See <<ChStatOtherProtocols>>
|menu:HTTP[]||HTTP request/response statistics, see <<ChStatOtherProtocols>>
|menu:Sametime[]||See <<ChStatOtherProtocols>>
|menu:TCP Stream Graphs[]||See <<ChStatTCPStreamGraphs>>
|menu:UDP Multicast Streams[]||See <<ChStatOtherProtocols>>
|menu:IP Addresses...[]||See <<ChStatOtherProtocols>>
|menu:IP Destinations...[]||See <<ChStatOtherProtocols>>
|menu:IP Protocol Types...[]||See <<ChStatOtherProtocols>>
|menu:ONC-RPC Programs[]||See <<ChStatOtherProtocols>>
|menu:Sametime[]||See <<ChStatOtherProtocols>>
|menu:TCP Stream Graph[]||See <<ChStatTCPStreamGraphs>>
|menu:UDP Multicast Streams[]||See <<ChStatOtherProtocols>>
|menu:WLAN Traffic[]||See <<ChStatWLANTraffic>>
|menu:BOOTP-DHCP[]||See <<ChStatOtherProtocols>>
|===============

View File

@ -0,0 +1,45 @@
// WSUG Chapter Wireless
[[ChWireless]]
== Wireless
[[ChWirelessIntroduction]]
=== Introduction
The Wireless menu provides access to statistics related to wireless traffic.
[[ChWirelessWLANTraffic]]
=== WLAN Traffic
Statistics about captured WLAN traffic. This can be found under the
menu:Wireless[] menu and summarizes the wireless network traffic found
in the capture. Probe requests will be merged into an existing network
if the SSID matches.
.The “WLAN Traffic Statistics” window
image::wsug_graphics/ws-stats-wlan-traffic.png[{screenshot-attrs}]
Each row in the list shows the statistical values for exactly one wireless
network.
_Name resolution_ will be done if selected in the window and if it is active for
the MAC layer.
_Only show existing networks_ will exclude probe requests with a SSID not
matching any network from the list.
The btn:[Copy] button will copy the list values to the clipboard in CSV (Comma
Separated Values) format.
[TIP]
====
This window will be updated frequently, so it will be useful, even if you open
it before (or while) you are doing a live capture.
====
// End of WSUG Chapter Wireless