d/numam-dpdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

doc: add xstats commands in testpmd guide

Browse Source 
Update the testpmd user guide with instructions for retrieving extended
NIC statistics.

Signed-off-by: Maryam Tahhan <maryam.tahhan@intel.com>
Acked-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>
Acked-by: John McNamara <john.mcnamara@intel.com>
This commit is contained in:
Maryam Tahhan 2016-09-07 11:45:57 +01:00 committed by Thomas Monjalon
parent f7103a9108
commit 0e51eb8741
1 changed files with 10 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
doc/guides/testpmd_app_ug/testpmd_funcs.rst
View File

@ -35,7 +35,8 @@ Testpmd Runtime Functions
Where the testpmd application is started in interactive mode, (``-i|--interactive``),
it displays a prompt that can be used to start and stop forwarding,
configure the application, display statistics, set the Flow Director and other tasks::
configure the application, display statistics (including the extended NIC
statistics aka xstats) , set the Flow Director and other tasks::
testpmd>
@ -50,10 +51,10 @@ If you type a partial command and hit ``<TAB>`` you get a list of the available
testpmd> show port <TAB>
info [Mul-choice STRING]: show|clear port info|stats|fdir|stat_qmap|dcb_tc X
info [Mul-choice STRING]: show|clear port info|stats|fdir|stat_qmap|dcb_tc all
stats [Mul-choice STRING]: show|clear port info|stats|fdir|stat_qmap|dcb_tc X
stats [Mul-choice STRING]: show|clear port info|stats|fdir|stat_qmap|dcb_tc all
info [Mul-choice STRING]: show|clear port info|stats|xstats|fdir|stat_qmap|dcb_tc X
info [Mul-choice STRING]: show|clear port info|stats|xstats|fdir|stat_qmap|dcb_tc all
stats [Mul-choice STRING]: show|clear port info|stats|xstats|fdir|stat_qmap|dcb_tc X
stats [Mul-choice STRING]: show|clear port info|stats|xstats|fdir|stat_qmap|dcb_tc all
...
@ -130,7 +131,7 @@ show port
Display information for a given port or all ports::
testpmd> show port (info|stats|fdir|stat_qmap|dcb_tc) (port_id|all)
testpmd> show port (info|stats|xstats|fdir|stat_qmap|dcb_tc) (port_id|all)
The available information categories are:
@ -138,6 +139,8 @@ The available information categories are:
* ``stats``: RX/TX statistics.
* ``xstats``: RX/TX extended NIC statistics.
* ``fdir``: Flow Director information and statistics.
* ``stat_qmap``: Queue statistics mapping.
@ -205,7 +208,7 @@ clear port
Clear the port statistics for a given port or for all ports::
testpmd> clear port (info|stats|fdir|stat_qmap) (port_id|all)
testpmd> clear port (info|stats|xstats|fdir|stat_qmap) (port_id|all)
For example::