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:
parent
208cf56b75
commit
1272b62106
Binary file not shown.
Before Width: | Height: | Size: 235 KiB After Width: | Height: | Size: 472 KiB |
Binary file not shown.
Before Width: | Height: | Size: 95 KiB After Width: | Height: | Size: 271 KiB |
|
@ -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”),
|
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)
|
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
|
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
|
.The “Conversations” window
|
||||||
image::wsug_graphics/ws-stats-conversations.png[{screenshot-attrs}]
|
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
|
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.
|
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
|
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
|
(Comma Separated Values), YAML format or JSON format. The numbers are generally
|
||||||
will show the stream contents as described in <<ChAdvFollowStream>> dialog. The
|
exported without special formatting, but this can be enabled if needed.
|
||||||
btn:[Graph...] button will show a graph as described in <<ChStatIOGraphs>>.
|
|
||||||
|
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.
|
btn:[Conversation Types] lets you choose which traffic type tabs are shown.
|
||||||
See <<ChStatEndpoints>> for a list of endpoint types. The enabled types
|
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
|
example we have MaxMind DB configured which gives us extra geographic
|
||||||
columns. See <<ChMaxMindDbPaths>> for more information.
|
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
|
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
|
(Comma Separated Values), YAML format or JSON format. The numbers are generally
|
||||||
endpoints mapped in your web browser.
|
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
|
btn:[Endpoint Types] lets you choose which traffic type tabs are shown. See
|
||||||
<<ChStatEndpoints>> above for a list of endpoint types. The enabled
|
<<ChStatEndpoints>> above for a list of endpoint types. The enabled
|
||||||
|
|
|
@ -364,7 +364,7 @@ QVariant EndpointDataModel::headerData(int section, Qt::Orientation orientation,
|
||||||
case 12:
|
case 12:
|
||||||
return tr("Total Packets"); break;
|
return tr("Total Packets"); break;
|
||||||
case 13:
|
case 13:
|
||||||
return tr("Percent filtered"); break;
|
return tr("Percent Filtered"); break;
|
||||||
}
|
}
|
||||||
} else if (role == Qt::TextAlignmentRole) {
|
} else if (role == Qt::TextAlignmentRole) {
|
||||||
if (section == ENDP_COLUMN_ADDR)
|
if (section == ENDP_COLUMN_ADDR)
|
||||||
|
@ -616,7 +616,7 @@ QVariant ConversationDataModel::headerData(int section, Qt::Orientation orientat
|
||||||
case 14:
|
case 14:
|
||||||
return tr("Total Packets"); break;
|
return tr("Total Packets"); break;
|
||||||
case 15:
|
case 15:
|
||||||
return tr("Percent filtered"); break;
|
return tr("Percent Filtered"); break;
|
||||||
}
|
}
|
||||||
} else if (role == Qt::TextAlignmentRole) {
|
} else if (role == Qt::TextAlignmentRole) {
|
||||||
if (column == CONV_COLUMN_SRC_ADDR || column == CONV_COLUMN_DST_ADDR)
|
if (column == CONV_COLUMN_SRC_ADDR || column == CONV_COLUMN_DST_ADDR)
|
||||||
|
|
Loading…
Reference in New Issue