WSUG: Added placeholders for missing documentation

Change-Id: I93b118964b0296bd32627439f8ae3c13169b1d5e
Reviewed-on: https://code.wireshark.org/review/28772
Reviewed-by: Peter Wu <peter@lekensteyn.nl>
Petri-Dish: Peter Wu <peter@lekensteyn.nl>
Tested-by: Petri Dish Buildbot
Reviewed-by: Gerald Combs <gerald@wireshark.org>
This commit is contained in:
Moshe Kaplan 2018-07-19 17:24:16 -04:00 committed by Gerald Combs
parent d83ad81aba
commit c78b6cdcef
5 changed files with 301 additions and 80 deletions

View File

@ -84,3 +84,5 @@
:multiplication: ×
:cmd: ⌘
:missing: Not yet written. See https://wiki.wireshark.org/Development/SubmittingPatches

View File

@ -40,6 +40,13 @@ protocol. Unless you are familiar with that protocol, statistics about it will
be pretty hard to understand.
====
Wireshark has many other statistics windows that display detailed
information about specific protocols and might be described in a later
version of this document.
Some of these statistics are described at
{wireshark-wiki-url}Statistics.
[[ChStatSummary]]
=== The “Capture File Properties” Window
@ -68,6 +75,12 @@ image::wsug_graphics/ws-stats-summary.png[{screenshot-attrs}]
packets shown in the display. The values in the _Marked_ column will
reflect the values corresponding to the marked packages.
[[ChStatResolvedAddresses]]
=== Resolved Addresses
{missing}
[[ChStatHierarchy]]
=== The “Protocol Hierarchy” Window
@ -278,9 +291,16 @@ it before (or while) you are doing a live capture.
// Removed:
// [[ChStatEndpointListWindow]]
[[ChStatPacketLengths]]
=== Packet Lengths
{missing}
[[ChStatIOGraphs]]
=== The “IO Graphs” Window
=== The “I/O Graph” Window
User configurable graph of the captured network packets.
@ -430,6 +450,66 @@ selected in the main window.
====
////
[[ChStatDHCPBOOTP]]
=== DHCP (BOOTP) Statistics
{missing}
[[ChStatONCRPC]]
=== ONC-RPC Programs
{missing}
[[ChStat29West]]
=== 29West
{missing}
[[ChStatANCP]]
=== ANCP
{missing}
[[ChStatBACnet]]
=== BACnet
{missing}
[[ChStatCollectd]]
=== Collectd
{missing}
[[ChStatDNS]]
=== DNS
{missing}
[[ChStatFlowGraph]]
=== Flow Graph
{missing}
[[ChStatHARTIP]]
=== HART-IP
{missing}
[[ChStatHPFEEDS]]
=== HPFEEDS
{missing}
[[ChStatHTTP]]
=== HTTP Statistics
@ -463,6 +543,19 @@ request leads to the next.
.The “HTTP Request Sequences” window
image::wsug_graphics/ws-stats-http-requestsequences.png[{screenshot-attrs}]
[[ChStatHTTP2]]
=== HTTP2
{missing}
[[ChStatSametime]]
=== Sametime
{missing}
[[ChStatTCPStreamGraphs]]
=== TCP Stream Graphs
@ -486,15 +579,28 @@ segment.
_Window Scaling_:: Window size and outstanding bytes.
[[ChStatOtherProtocols]]
[[ChStatUDPMulticastGraphs]]
=== Other Protocol-specific Statistics Windows
=== UDP Multicast Graphs
Wireshark has many other statistics windows that display detailed
information about specific protocols and might be described in a later
version of this document.
{missing}
Some of these statistics are described at
{wireshark-wiki-url}Statistics.
[[ChStatF5]]
=== F5
{missing}
[[ChStatIPv4]]
=== IPv4 Statistics
{missing}
[[ChStatIPv6]]
=== IPv6 Statistics
{missing}
// End of WSUG Chapter Statistics

View File

@ -15,6 +15,106 @@ These statistics range from specific signaling protocols, to analysis of
signaling and media flows. If encoded in a compatible encoding the media flow
can even be played.
The protocol specific statistics windows display detailed information of
specific protocols and might be described in a later version of this document.
Some of these statistics are described at the
{wireshark-wiki-url}Statistics pages.
[[ChTelVoipCalls]]
=== VoIP Calls
The VoIP Calls window shows a list of all detected VoIP calls in the captured
traffic. It finds calls by their signaling.
More details can be found on the {wireshark-wiki-url}VoIP_calls page.
[[ChTelANSI]]
=== ANSI
{missing}
[[ChTelGSM]]
=== GSM
{missing}
[[ChTelIAX2Analysis]]
=== IAX2 Stream Analysis
The “IAX2 Stream Analysis” dialog shows statistics for the forward and reverse
streams of a selected IAX2 call along with a graph.
[[ChTelISUPMessages]]
=== ISUP Messages
{missing}
[[ChTelLTE]]
=== LTE
[[ChTelLTEMACTraffic]]
==== LTE MAC Traffic Statistics
Statistics of the captured LTE MAC traffic. This window will summarize the LTE
MAC traffic found in the capture.
.The “LTE MAC Traffic Statistics” window
image::wsug_graphics/ws-stats-lte-mac-traffic.png[{screenshot-attrs}]
The top pane shows statistics for common channels. Each row in the middle pane
shows statistical highlights for exactly one UE/C-RNTI. In the lower pane, you
can see the for the currently selected UE/C-RNTI the traffic broken down by
individual channel.
[[ChTelLTERLCGraph]]
==== LTE RLC Graph
{missing}
[[ChTelLTERLCTraffic]]
==== LTE RLC Traffic Statistics
Statistics of the captured LTE RLC traffic. This window will summarize the LTE
RLC traffic found in the capture.
.The “LTE RLC Traffic Statistics” window
image::wsug_graphics/ws-stats-lte-rlc-traffic.png[{screenshot-attrs}]
At the top, the check-box allows this window to include RLC PDUs found within
MAC PDUs or not. This will affect both the PDUs counted as well as the display
filters generated (see below).
The upper list shows summaries of each active UE. Each row in the lower list
shows statistical highlights for individual channels within the selected UE.
The lower part of the windows allows display filters to be generated and set for
the selected channel. Note that in the case of Acknowledged Mode channels, if a
single direction is chosen, the generated filter will show data in that
direction and control PDUs in the opposite direction.
[[ChTelMTP3]]
=== MTP3
{missing}
[[ChTelOsmux]]
=== Osmux
{missing}
[[ChTelRTPAnalysis]]
=== RTP Analysis
@ -36,22 +136,6 @@ The RTP Stream Analysis window further provides the option to save the RTP
payload (as raw data or, if in a PCM encoding, in an Audio file). Other options
a to export and plot various statistics on the RTP streams.
[[ChTelIAX2Analysis]]
=== IAX2 Analysis
The “IAX2 Analysis” dialog shows statistics for the forward and reverse
streams of a selected IAX2 call along with a graph.
[[ChTelVoipCalls]]
=== VoIP Calls
The VoIP Calls window shows a list of all detected VoIP calls in the captured
traffic. It finds calls by their signaling.
More details can be found on the {wireshark-wiki-url}VoIP_calls page.
[[ChTelRtpPlayer]]
The RTP Player window lets you play back RTP audio data. In order to use
@ -61,51 +145,53 @@ used by each RTP stream.
More details can be found on the
{wireshark-wiki-url}VoIP_calls page.
[[ChTelLTEMACTraffic]]
[[ChTelRTSP]]
=== LTE MAC Traffic Statistics
=== RTSP
Statistics of the captured LTE MAC traffic. This window will summarize the LTE
MAC traffic found in the capture.
{missing}
.The “LTE MAC Traffic Statistics” window
image::wsug_graphics/ws-stats-lte-mac-traffic.png[{screenshot-attrs}]
[[ChTelSCTP]]
The top pane shows statistics for common channels. Each row in the middle pane
shows statistical highlights for exactly one UE/C-RNTI. In the lower pane, you
can see the for the currently selected UE/C-RNTI the traffic broken down by
individual channel.
=== SCTP
[[ChTelLTERLCTraffic]]
{missing}
=== LTE RLC Traffic Statistics
[[ChTelSMPPOperations]]
Statistics of the captured LTE RLC traffic. This window will summarize the LTE
RLC traffic found in the capture.
=== SMPP Operations
.The “LTE RLC Traffic Statistics” window
image::wsug_graphics/ws-stats-lte-rlc-traffic.png[{screenshot-attrs}]
{missing}
At the top, the check-box allows this window to include RLC PDUs found within
MAC PDUs or not. This will affect both the PDUs counted as well as the display
filters generated (see below).
[[ChTelUCPMessages]]
The upper list shows summaries of each active UE. Each row in the lower list
shows statistical highlights for individual channels within the selected UE.
=== UCP Messages
The lower part of the windows allows display filters to be generated and set for
the selected channel. Note that in the case of Acknowledged Mode channels, if a
single direction is chosen, the generated filter will show data in that
direction and control PDUs in the opposite direction.
{missing}
[[ChTelXXX]]
[[ChTelH225]]
=== The protocol specific statistics windows
=== H.225
The protocol specific statistics windows display detailed information of
specific protocols and might be described in a later version of this document.
{missing}
[[ChTelSIPFlows]]
=== SIP Flows
{missing}
[[ChTelSIPStatistics]]
=== SIP Statistics
{missing}
[[ChTelWAPWSPPacketCounter]]
=== WAP-WSP Packet Counter
{missing}
Some of these statistics are described at the
{wireshark-wiki-url}Statistics pages.
// End of WSUG Chapter Telephony

View File

@ -553,25 +553,32 @@ All menu items will bring up a new window showing specific statistical informati
|===============
|Menu Item|Accelerator|Description
|menu:Capture File Properties[]|| Show information about the capture file, see <<ChStatSummary>>.
|menu:Resolved Addresses[]||See <<ChStatResolvedAddresses>>
|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:Packet Lengths[]||See <<ChStatPacketLengths>>
|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:DHCP (BOOTP)[]||See <<ChStatDHCPBOOTP>>
|menu:ONC-RPC Programs[]||See <<ChStatONCRPC>>
|menu:29West[]||See <<ChStat29West>>
|menu:ANCP[]||See <<ChStatANCP>>
|menu:BACnet[]||See <<ChStatBACnet>>
|menu:Collectd[]||See <<ChStatCollectd>>
|menu:DNS[]||See <<ChStatDNS>>
//|menu:Compare...[]||See <<ChStatOtherProtocols>>
|menu:Flow Graph...[]||See <<ChStatOtherProtocols>>
|menu:HTTP[]||HTTP request/response statistics, see <<ChStatOtherProtocols>>
|menu:Sametime[]||See <<ChStatOtherProtocols>>
|menu:Flow Graph[]||See <<ChStatFlowGraph>>
|menu:HART-IP[]||See <<ChStatHARTIP>>
|menu:HPFEEDS[]||See <<ChStatHPFEEDS>>
|menu:HTTP[]||HTTP request/response statistics, see <<ChStatHTTP>>
|menu:HTTP2[]||See <<ChStatHTTP2>>
|menu:Sametime[]||See <<ChStatSametime>>
|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:UDP Multicast Streams[]||See <<ChStatUDPMulticastGraphs>>
|menu:F5[]||See <<ChStatF5>>
|menu:IPv4 Statistics[]||See <<ChStatIPv4>>
|menu:IPv6 Statistics[]||See <<ChStatIPv6>>
|===============
@ -593,20 +600,23 @@ All menu items will bring up a new window showing specific telephony related sta
[options="header",cols="3,2,5"]
|===============
|Menu Item|Accelerator|Description
|menu:IAX2[]||See <<ChTelXXX>>
|menu:SMPP Operations...[]||See <<ChTelXXX>>
|menu:SCTP[]||See <<ChTelXXX>>
|menu:ANSI[]||See <<ChTelXXX>>
|menu:GSM[]||See <<ChTelXXX>>
|menu:H.225...[]||See <<ChTelXXX>>
|menu:ISUP Messages...[]||See <<ChTelXXX>>
|menu:LTE[]||See <<ChTelLTEMACTraffic>>
|menu:MTP3[]||See <<ChTelXXX>>
|menu:RTP[]||See <<ChTelRTPAnalysis>>
|menu:SIP...[]||See <<ChTelXXX>>
|menu:UCP Messages...[]||See <<ChTelXXX>>
|menu:VoIP Calls...[]||See <<ChTelVoipCalls>>
|menu:WAP-WSP...[]||See <<ChTelXXX>>
|menu:[ANSI]||See <<ChTelANSI>>
|menu:[GSM]||See <<ChTelGSM>>
|menu:[IAX2 Stream Analysis]||See <<ChTelIAX2Analysis>>
|menu:[ISUP Messages]||See <<ChTelISUPMessages>>
|menu:[LTE]||See <<ChTelLTE>>
|menu:[MTP3]||See <<ChTelMTP3>>
|menu:[Osmux]||See <<ChTelOsmux>>
|menu:[RTP]||See <<ChTelRTPAnalysis>>
|menu:[RTSP]||See <<ChTelRTSP>>
|menu:[SCTP]||See <<ChTelSCTP>>
|menu:[SMPP Operations]||See <<ChTelSMPPOperations>>
|menu:[UCP Messages]||See <<ChTelUCPMessages>>
|menu:[H.225]||See <<ChTelH225>>
|menu:[SIP Flows]||See <<ChTelSIPFlows>>
|menu:[SIP Statistics]||See <<ChTelSIPStatistics>>
|menu:[WAP-WSP Packet Counter]||See <<ChTelWAPWSPPacketCounter>>
|===============

View File

@ -10,6 +10,23 @@
The Wireless menu provides access to statistics related to wireless traffic.
[[ChWirelessBluetoothATTServerAttributes]]
=== Bluetooth ATT Server Attributes
{missing}
[[ChWirelessBluetoothDevices]]
=== Bluetooth Devices
{missing}
[[ChWirelessBluetoothHCISummary]]
=== Bluetooth HCI Summary
{missing}
[[ChWirelessWLANTraffic]]