diff mbox series

[ovs-dev,v2,2/3] docs: Add documention for pmd-rxq-show secs parameter.

Message ID 20221130163525.1040133-2-ktraynor@redhat.com
State Superseded
Headers show
Series [ovs-dev,v2,1/3] dpif-netdev: Make pmd-rxq-show time configurable. | expand

Checks

Context Check Description
ovsrobot/apply-robot fail apply and check: fail

Commit Message

Kevin Traynor Nov. 30, 2022, 4:35 p.m. UTC 
Add description of new '-secs' parameter in docs. Also, add to NEWS as
it is a user facing change.

Signed-off-by: Kevin Traynor <ktraynor@redhat.com>
---
 Documentation/topics/dpdk/pmd.rst | 23 ++++++++++++++++++-----
 NEWS                              |  3 +++
 2 files changed, 21 insertions(+), 5 deletions(-)

Comments

0-day Robot Nov. 30, 2022, 4:38 p.m. UTC | #1 
Bleep bloop.  Greetings Kevin Traynor, I am a robot and I have tried out your patch.
Thanks for your contribution.

I encountered some error that I wasn't expecting.  See the details below.


git-am:
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
Patch failed at 0001 docs: Add documention for pmd-rxq-show secs parameter.
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".


Patch skipped due to previous failure.

Please check this out.  If you feel there has been an error, please email aconole@redhat.com

Thanks,
0-day Robot
diff mbox series

Patch

diff --git a/Documentation/topics/dpdk/pmd.rst b/Documentation/topics/dpdk/pmd.rst
index b259cc8b3..88457f366 100644
--- a/Documentation/topics/dpdk/pmd.rst
+++ b/Documentation/topics/dpdk/pmd.rst
@@ -102,10 +102,18 @@  core cycles for each Rx queue::
 .. note::
 
-   A history of one minute is recorded and shown for each Rx queue to allow for
-   traffic pattern spikes. Any changes in the Rx queue's PMD core cycles usage,
-   due to traffic pattern or reconfig changes, will take one minute to be fully
-   reflected in the stats.
+   By default a history of one minute is recorded and shown for each Rx queue
+   to allow for traffic pattern spikes. Any changes in the Rx queue's PMD core
+   cycles usage, due to traffic pattern or reconfig changes, will take one
+   minute to be fully reflected in the stats by default.
 
-   .. versionchanged:: 2.6.0
+PMD thread usage of an Rx queue can be displayed for a shorter period of time,
+from the last 5 seconds up to the default 60 seconds in 5 second steps.
+
+To see the port/Rx queue assignment and the last 5 secs of measured usage
+history of PMD core cycles for each Rx queue::
+
+    $ ovs-appctl dpif-netdev/pmd-rxq-show -secs 5
+
+.. versionchanged:: 2.6.0
 
       The ``pmd-rxq-show`` command was added in OVS 2.6.0.
@@ -116,4 +124,9 @@  core cycles for each Rx queue::
    cycles inherently consumed by the OVS PMD processing loop.
 
+.. versionchanged:: 3.1.0
+
+      The ``-secs`` parameter was added to the dpif-netdev/pmd-rxq-show
+      command.
+
 Rx queue to PMD assignment takes place whenever there are configuration changes
 or can be triggered by using::
diff --git a/NEWS b/NEWS
index ff77ee404..ab6834e24 100644
--- a/NEWS
+++ b/NEWS
@@ -24,4 +24,7 @@  Post-v3.0.0
        If a user wishes to benefit from these fixes it is recommended to use
        DPDK 21.11.2.
+   - Userspace datapath:
+     * Add '-secs' argument to appctl 'dpif-netdev/pmd-rxq-show' to show
+       the pmd usage of an Rx queue over a configurable time period.