WSUG: Add a Packet Lengths dialog section.

Add a section for the Packet Lengths window. Use title case for the
column headers. Fix a button name and other issues elsewhere.

Change-Id: I339d56aa169158e0788acd02a897729205e9f50e
Reviewed-on: https://code.wireshark.org/review/35615
Reviewed-by: Gerald Combs <gerald@wireshark.org>
This commit is contained in:
Gerald Combs 2019-12-31 15:35:50 -08:00
parent 4778386e71
commit fac6a2179e
7 changed files with 48 additions and 9 deletions

View File

@ -192,6 +192,7 @@ set(WSUG_GRAPHICS
wsug_graphics/ws-stats-endpoints.png
wsug_graphics/ws-stats-hierarchy.png
wsug_graphics/ws-stats-iographs.png # GTK+
wsug_graphics/ws-stats-packet-lengths.png
wsug_graphics/ws-stats-srt-dcerpc-filter.png # GTK+
wsug_graphics/ws-stats-srt-dcerpc.png # GTK+
wsug_graphics/ws-stats-lte-mac-traffic.png

View File

@ -86,4 +86,4 @@
:multiplication: ×
:cmd: ⌘
:missing: Not yet written. See https://wiki.wireshark.org/Development/SubmittingPatches.
:missing: Not yet written. If you would like to fix this, see https://wiki.wireshark.org/Development/SubmittingPatches.

Binary file not shown.

After

Width:  |  Height:  |  Size: 91 KiB

View File

@ -326,7 +326,45 @@ it before (or while) you are doing a live capture.
=== Packet Lengths
{missing}
Shows the distribution of packet lengths and related information.
.The “Packet Lengths” window
image::wsug_graphics/ws-stats-packet-lengths.png[{medium-screenshot-attrs}]
Information is broken down by packet length ranges as shown above.
Packet Lengths::
The range of packet lengths.
Count::
The number of packets that fall into this range.
Average::
The arithmetic mean length of the packets in this range.
Min Val, Max Val::
The minimum and maximum lengths in this range.
Rate (ms)::
The average packets per millisecond for the packets in this range.
Percent::
The percentage of packets in this range, by count.
Burst Rate::
Packet bursts are detected by counting the number of packets in a given time interval and comparing that count to the intervals across a window of time.
Statistics for the interval with the maximum number of packets are shown.
By default, bursts are detected across 5 millisecond intervals and intervals are compared across 100 millisecond windows.
+
These calculations can be adjusted in the “Statistics” section of the <<ChCustPreferencesSection,Preferences Dialog>>.
Burst Start::
The start time, in seconds from the beginning of the capture, for the interval with the maximum number of packets.
You can show statistics for a portion of the capture by entering a display filter into the _Display filter_ entry and pressing btn:[Apply].
btn:[Copy] copies the statistics to the clipboard.
btn:[Save as...] lets you save the data as text, CSV, YAML, or XML.
[[ChStatIOGraphs]]

View File

@ -72,7 +72,7 @@ other GUI programs.
[TIP]
====
The layout of the main window can be customized by changing preference settings.
See <<ChCustPreferencesSection>> for details!
See <<ChCustPreferencesSection>> for details.
====
[[ChUseMainWindowNavSection]]
@ -905,7 +905,7 @@ addresses), the IP dissector will overwrite this by its own (such as the IP
addresses), the TCP dissector will overwrite the IP information, and so on.
There are a lot of different columns available. Which columns are displayed can
be selected by preference settings, see <<ChCustPreferencesSection>>.
be selected by preference settings. See <<ChCustPreferencesSection>>.
The default columns will show:

View File

@ -903,7 +903,7 @@ This will be greyed out if no filter is selected.
btn:[OK]::
Saves the filter settings and closes the dialog.
btn:[Close]::
btn:[Cancel]::
Closes the dialog without saving any changes.
[[ChWorkDefineFilterMacrosSection]]

View File

@ -1066,17 +1066,17 @@ stats_tree_get_column_name (gint col_index)
case COL_AVERAGE:
return "Average";
case COL_MIN:
return "Min val";
return "Min Val";
case COL_MAX:
return "Max val";
return "Max Val";
case COL_RATE:
return "Rate (ms)";
case COL_PERCENT:
return "Percent";
case COL_BURSTRATE:
return prefs.st_burst_showcount?"Burst count":"Burst rate";
return prefs.st_burst_showcount ? "Burst Count" : "Burst Rate";
case COL_BURSTTIME:
return "Burst start";
return "Burst Start";
default:
return "(Unknown)";
}