osmith
/
wireshark
forked from osmocom/wireshark
1
0
Fork 0
Code Pull Requests Releases Wiki Activity

Docs: Update documentation for redesigned Traffic Tabs 

Update the documentation to document the change of features
that happen during the redesign of the UI as well as fix some
wordings in the data model.
This commit is contained in:
Roland Knall 2022-06-14 22:39:28 +02:00
parent 208cf56b75
commit 1272b62106
4 changed files with 24 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
docbook/wsug_graphics/ws-stats-conversations.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 235 KiB

After

Width:  |  Height:  |  Size: 472 KiB

BIN
docbook/wsug_graphics/ws-stats-endpoints.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 95 KiB

After

Width:  |  Height:  |  Size: 271 KiB

28
docbook/wsug_src/WSUG_chapter_statistics.adoc
View File

@ -201,7 +201,7 @@ addresses, packet counters, and byte counters the conversation window adds four
columns: the start time of the conversation (“Rel Start”) or (“Abs Start”),
the duration of the conversation in seconds, and the average bits (not bytes)
per second in each direction. A timeline graph is also drawn across the
“Rel Start” / “Abs Start” and “Duration” columns.
“Rel Start” / “Abs Start” and “Duration” columns. Additionally
.The “Conversations” window
image::wsug_graphics/ws-stats-conversations.png[{screenshot-attrs}]
@ -216,10 +216,19 @@ between relative (“Rel Start”) and absolute (“Abs Start”) times. Relativ
times match the “Seconds Since First Captured Packet” time display format in the
packet list and absolute start times match the “Time of Day” display format.
If a display filter had been applied before the dialog is opened, _Limit to
display filter_ will be set automatically. Additionally, after a display filter
had been applied, two columns ("Total Packets") and ("Percent Filtered") show
the number of unfiltered total packets and the percentage of packets in this filter
display.
The btn:[Copy] button will copy the list values to the clipboard in CSV
(Comma Separated Values) or YAML format. The btn:[Follow Stream...] button
will show the stream contents as described in <<ChAdvFollowStream>> dialog. The
btn:[Graph...] button will show a graph as described in <<ChStatIOGraphs>>.
(Comma Separated Values), YAML format or JSON format. The numbers are generally
exported without special formatting, but this can be enabled if needed.
The btn:[Follow Stream...] button will show the stream contents as described
in <<ChAdvFollowStream>> dialog. The btn:[Graph...] button will show a graph
as described in <<ChStatIOGraphs>>.
btn:[Conversation Types] lets you choose which traffic type tabs are shown.
See <<ChStatEndpoints>> for a list of endpoint types. The enabled types
@ -321,9 +330,16 @@ conversations matching the current display filter. Note that in this
example we have MaxMind DB configured which gives us extra geographic
columns. See <<ChMaxMindDbPaths>> for more information.
If a display filter had been applied before the dialog is opened, _Limit to
display filter_ will be set automatically. Additionally, after a display filter
had been applied, two columns ("Total Packets") and ("Percent Filtered") show
the number of unfiltered total packets and the percentage of packets in this filter
display.
The btn:[Copy] button will copy the list values to the clipboard in CSV
(Comma Separated Values) or YAML format. The btn:[Map] button will show the
endpoints mapped in your web browser.
(Comma Separated Values), YAML format or JSON format. The numbers are generally
exported without special formatting, but this can be enabled if needed.
The btn:[Map] button will show the endpoints mapped in your web browser.
btn:[Endpoint Types] lets you choose which traffic type tabs are shown. See
<<ChStatEndpoints>> above for a list of endpoint types. The enabled

4
ui/qt/models/atap_data_model.cpp
View File

@ -364,7 +364,7 @@ QVariant EndpointDataModel::headerData(int section, Qt::Orientation orientation,
case 12:
return tr("Total Packets"); break;
case 13:
return tr("Percent filtered"); break;
return tr("Percent Filtered"); break;
}
} else if (role == Qt::TextAlignmentRole) {
if (section == ENDP_COLUMN_ADDR)
@ -616,7 +616,7 @@ QVariant ConversationDataModel::headerData(int section, Qt::Orientation orientat
case 14:
return tr("Total Packets"); break;
case 15:
return tr("Percent filtered"); break;
return tr("Percent Filtered"); break;
}
} else if (role == Qt::TextAlignmentRole) {
if (column == CONV_COLUMN_SRC_ADDR || column == CONV_COLUMN_DST_ADDR)