diff mbox series

[ovs-dev,3/5] Documentation: Update PMD thread statistics.

Message ID 20211216124105.333749-4-ktraynor@redhat.com
State Superseded
Headers show
Series PMD docs and ALB status | expand

Checks

Context Check Description
ovsrobot/apply-robot success apply and check: success
ovsrobot/github-robot-_Build_and_Test success github build: passed

Commit Message

Kevin Traynor Dec. 16, 2021, 12:41 p.m. UTC
'pmd-perf-show' gives some extra information and has nicer
formatting than 'pmd-stats-show'.

Let the user know they can use that as well to get PMD stats.

Signed-off-by: Kevin Traynor <ktraynor@redhat.com>
---
 Documentation/topics/dpdk/pmd.rst | 9 +++++++++
 1 file changed, 9 insertions(+)

Comments

Pai G, Sunil Dec. 16, 2021, 2:12 p.m. UTC | #1
Hi Kevin, 

One comment below.

> diff --git a/Documentation/topics/dpdk/pmd.rst
> b/Documentation/topics/dpdk/pmd.rst
> index 16b8b7b03..5beb2ea97 100644
> --- a/Documentation/topics/dpdk/pmd.rst
> +++ b/Documentation/topics/dpdk/pmd.rst
> @@ -60,8 +60,17 @@ To show current stats::
>      $ ovs-appctl dpif-netdev/pmd-stats-show
> 
> +or::
> +
> +    $ ovs-appctl dpif-netdev/pmd-perf-show
> +

Was surprised to see this command wasn't mentioned in the documentation till now.
Just a thought, may be we should also mention about
ovs-vsctl set Open_vSwitch . other_config:pmd-perf-metrics=true     ?

Thanks and regards,
Sunil
Kevin Traynor Dec. 17, 2021, 1:52 p.m. UTC | #2
On 16/12/2021 14:12, Pai G, Sunil wrote:
> Hi Kevin,
> 
> One comment below.
> 
>> diff --git a/Documentation/topics/dpdk/pmd.rst
>> b/Documentation/topics/dpdk/pmd.rst
>> index 16b8b7b03..5beb2ea97 100644
>> --- a/Documentation/topics/dpdk/pmd.rst
>> +++ b/Documentation/topics/dpdk/pmd.rst
>> @@ -60,8 +60,17 @@ To show current stats::
>>       $ ovs-appctl dpif-netdev/pmd-stats-show
>>
>> +or::
>> +
>> +    $ ovs-appctl dpif-netdev/pmd-perf-show
>> +
> 
> Was surprised to see this command wasn't mentioned in the documentation till now.
> Just a thought, may be we should also mention about
> ovs-vsctl set Open_vSwitch . other_config:pmd-perf-metrics=true     ?
> 

It is described in the man pages, but it seems reasonable to put a one 
liner here also, as it's relevant to PMD and the user might not be aware 
it exists.

> Thanks and regards,
> Sunil
>
diff mbox series

Patch

diff --git a/Documentation/topics/dpdk/pmd.rst b/Documentation/topics/dpdk/pmd.rst
index 16b8b7b03..5beb2ea97 100644
--- a/Documentation/topics/dpdk/pmd.rst
+++ b/Documentation/topics/dpdk/pmd.rst
@@ -60,8 +60,17 @@  To show current stats::
     $ ovs-appctl dpif-netdev/pmd-stats-show
 
+or::
+
+    $ ovs-appctl dpif-netdev/pmd-perf-show
+
 To clear previous stats::
 
     $ ovs-appctl dpif-netdev/pmd-stats-clear
 
+.. note::
+
+    PMD stats are cumulative so they should be cleared in order to see how the
+    PMDs are being used with current traffic.
+
 Port/Rx Queue Assignment to PMD Threads
 ---------------------------------------